diff --git a/docs/guides/deploy-guide/index.md b/docs/guides/deploy-guide/index.md index bd44f98faa..8ca1f18369 100644 --- a/docs/guides/deploy-guide/index.md +++ b/docs/guides/deploy-guide/index.md @@ -5,34 +5,14 @@ sidebar_position: 10 # Deploy Guide -💡 The Deploy Guide describe how to provision, bootstrap and deploy nodes and services. +OSISM is deployed in a series of successive steps. The steps are documented in the Deploy Guide. -A classification is made for services. For example, all infrastructure services -such as RabbitMQ or MariaDB are covered in the [infrastructure section](./services/infrastructure) -of the [services chapter](./services). +The prerequisite for the deployment of a cluster is a configuration repository. +What a configuration repository is and how it is created is described in the +[Configuration Guide](../configuration-guide/configuration-repository#creating-a-new-configuration-repository). -The guide always assume that a node is already initially accessible via SSH and only -needs to be bootstrapped and integrated into the environment. Deploying bare-metal nodes -with an operating system is documented in the [provisioning chapter](./provisioning). - -The manager node is handled in a [separate chapter](./manager) because it must be handled -differently when building a new environment. - -Before deploying services to nodes, they must all be bootstrapped. This is covered -in the [bootstrap chapter](./bootstrap). - -In the examples, the pull of images (if supported by a role) is always run first. While -this is optional, it is recommended to speed up the execution of the deploy action in -the second step. This significantly reduces the times required for the restart from a -service. - -## Getting started - -OSISM is deployed in a series of successive phases. The phases are documented in this guide. - -1. [Creation of a configuration repository](../configuration-guide/configuration-repository#creating-a-new-configuration-repository) -2. [Preparation of the seed node](./seed) -3. [Preparation of the manager node](./manager) -4. [Provisioning of the bare-metal nodes](./provisioning) -5. [Bootstrap of the bare-metal nodes](./bootstrap) -6. [Deployment of the services](./services) +* Step 1: [Preparation of the seed node](./seed) +* Step 2: [Preparation of the manager node](./manager) +* Step 3: [Provisioning of the bare-metal nodes](./provisioning) +* Step 4: [Bootstrap of the bare-metal nodes](./bootstrap) +* Step 5: [Deployment of the services](./services) diff --git a/docs/guides/deploy-guide/manager.md b/docs/guides/deploy-guide/manager.md index b034e9d693..60548ad146 100644 --- a/docs/guides/deploy-guide/manager.md +++ b/docs/guides/deploy-guide/manager.md @@ -1,13 +1,11 @@ --- sidebar_label: Manager -sidebar_position: 30 +sidebar_position: 20 --- # Manager -## Provision the operating system of the manager - -The Manager Node serves as the central administration instance for managing the cloud environment. +The Manager node serves as the central administration instance for managing the cloud environment. With the help of Ansible and other OSISM-specific [components](../concept-guide/index.md), the entire life cycle of the system is coordinated from here (installation, customization, upgrades, etc.). @@ -26,7 +24,7 @@ Requirements for the manager node: - No manual adjustments or installations should have been made on the system apart from the basic installation - The system has to be accessible from the [seed node](./seed.md) via SSH -## Install the manager +## Deploy the manager service Change into the `environments/manager` directory of the configuration repository on the seed node. The deployment of the seed node itself is documented in the diff --git a/docs/guides/deploy-guide/provisioning.md b/docs/guides/deploy-guide/provisioning.md index 01c972b2df..9a32424543 100644 --- a/docs/guides/deploy-guide/provisioning.md +++ b/docs/guides/deploy-guide/provisioning.md @@ -1,6 +1,6 @@ --- sidebar_label: Provisioning -sidebar_position: 10 +sidebar_position: 30 --- # Provisioning of bare-metal nodes diff --git a/docs/guides/deploy-guide/seed.md b/docs/guides/deploy-guide/seed.md index 702c898c8f..ac226e6868 100644 --- a/docs/guides/deploy-guide/seed.md +++ b/docs/guides/deploy-guide/seed.md @@ -1,10 +1,18 @@ --- sidebar_label: Seed -sidebar_position: 20 +sidebar_position: 10 --- # Seed +:::info + +The prerequisite for the deployment of a cluster is a configuration repository. +What a configuration repository is and how it is created is described in the +[Configuration Guide](../configuration-guide/configuration-repository#creating-a-new-configuration-repository). + +::: + The seed node is used once for the initial bootstrap of the manager node. The seed node can also be used to initially create and prepare the configuration repository. The seed node is not the manager node itself. It is sufficient to use the local workstation. It doesn't have