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 in Common Issues.

Blueprints and Components

8. Blueprint and Helm Chart Resources in a Component Version

Imports and Exports

9. Import Parameters

10. Import Data Mappings

11. Export Parameters

Subinstallations

12. Data flow between Subinstallations

13. Reuse of Components

14. Subinstallation Templates

Templating

15. Templating: Accessing Component Descriptors

Target Maps

16. Target Maps: Multiple Deploy Items

17. Target Maps: Target Map References

18. Target Maps: Multiple Subinstallations

19. Target Maps: Target Map on Subinstallation Level

20. Target Maps: Other Target Map Examples

Kustomize

21. Introduction to Kustomize Examples

22. Deploying the PodInfo Application with Landscaper and Flux

23. Deploying the PodInfo Application with Landscaper and Flux - controlled by Landscaper

24. Dataflow Example

Optimization

25. Optimization Hints