Skip to content

Latest commit

 

History

History
 
 

guided-tour

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.

  • For building reusable components you require the OCM 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.

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. If you have problems with the presentation of the Guided Tour, jump to the original github repository.

A Hello World Example

1. Hello World Example

Basics

2. Upgrading the Hello World Example

3. Manifest Deployer Example

4. Multiple Deployments in One Installation

Recovering from Errors

5. Handling an Immediate Error

6. Handling a Timeout Error

7. Handling a Delete Error

You can find a list of error messages and corresponding solutions here.

Blueprints and Components

8. An Installation with an Externally Stored Blueprint

9. Helm Chart Resources in the Component Descriptor

10. Echo Server Example

Imports and Exports

11. Import Parameters

12. Import Data Mappings

13. Export Parameters

Templating

14. Templating: Accessing Component Descriptors

Target Maps

15. Target Maps: Multiple Deploy Items

16. Target Maps: Target Map References

17. Target Maps: Multiple Subinstallations

18. Target Maps: Target Map on Subinstallation Level

19. Target Maps: Other Target Map Examples

Optimization

20. Optimization Hints