Name		Name	Last commit message	Last commit date
parent directory ..
basics		basics
blueprints		blueprints
error-handling		error-handling
hello-world		hello-world
import-export		import-export
target-maps		target-maps
targets		targets
templating/components		templating/components
.docnames		.docnames
README.md		README.md

README.md

title	sidebar_position
Prerequisites	1

Guided Tour

Prerequisites and Basic Definitions

For all examples, you need a running Landscaper instance.
A convenient tool we will often use in the following examples is the Landscaper CLI.
During the following exercises, you might need to change files, provided with the examples. For this, you should simply clone this repository and do the required changes on your local files. You could also fork the repo and work on your fork.
In all examples, 3 Kubernetes clusters are involved:
- the Landscaper Host Cluster, on which the Landscaper runs
- the target cluster, on which the deployments will be done
- the Landscaper Resource Cluster, on which the various custom resources are stored. These custom resources are watched by the Landscaper, and define which deployments should happen on which target cluster.
It is possible that some or all of these clusters coincide, e.g. in the most simplistic approach, you have only one cluster. Such a "one-cluster-setup" is the easiest way to start working with the Landscaper.

NOTE: The Landscaper now also supports OCM (Open Component Model) Component Descriptors Version 3, additionally to Version 2.
Since we try our best to avoid disruptions, this functionality is currently behind a feature switch. For detailed information on how to enable this for your own landscaper instance, set the corresponding flag in the configuration to true, as shown here. If you just want to follow along the tour, you should have the switch enabled!

How to follow the Tour

The Guided Tour consists of several chapters, some of which build on each other. In order to get the most out of it, you should be following the Guided Tour in this sequence. Another important point is, that this documentation is not optimal with respect to getting an overview about the used example resources in the Guided Tour. Therefore, it might be better to read it in the original github repository.