Skip to content

Commit

Permalink
Improve the manager deploy guide a little bit (#396)
Browse files Browse the repository at this point in the history
Signed-off-by: Christian Berendt <[email protected]>
  • Loading branch information
berendt authored Mar 26, 2024
1 parent 547d7b4 commit 02ced76
Showing 1 changed file with 19 additions and 15 deletions.
34 changes: 19 additions & 15 deletions docs/guides/deploy-guide/manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,34 +8,35 @@ sidebar_position: 30
## Provision the operating system of the manager

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.).
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.).

Requirements for the manager node:

- The system should have the following hardware features
- at least 64 GB RAM
- at least 256 GB hard disk space
- the system should be initially and permanently accessible independently of the cloud environment itself from the seed node
- the system should have direct access to the network areas of the individual server systems in the cloud environment
- the system should be initially and permanently accessible independently of the cloud environment
itself from the seed node
- the system should have direct access to the network areas of the individual server systems in the
cloud environment
- An Ubuntu version matching the OSISM version should be [provisioned](./provisioning.md) on the system
(typically the latest Ubuntu LTS version, a system based on one of the [OSISM node images](https://github.com/osism/node-image)
would be ideal)
- No manual adjustments or installations should have been made on the system apart from the basic installation
- The system should be accessible from the [seed node](./seed.md) via SSH
- The system has to be accessible from the [seed node](./seed.md) via SSH

## Install the manager

Change into the `configuration/environments/manager` directory of the configuration repository.
on the seed node.

The deployment of the seed node is documented in the [Deploy Guide for the seed node](../deploy-guide/seed).
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
[Deploy Guide for the seed node](../deploy-guide/seed).

```
cd configuration/environments/manager
cd environments/manager
```

### Create operator user
### Step 1: Create operator user

The operator user is created on each node. It is used as a service account for OSISM. All
containers run with this user. Ansible also uses this user to access the nodes. Commands
Expand Down Expand Up @@ -109,7 +110,7 @@ ssh-add -D
ssh -o IdentitiesOnly=yes -i id_rsa.operator dragon@testbed-manager
```

### Apply the network configuration
### Step 2: Apply the network configuration

Most of the parameters required for Ansible (`ANSIBLE_BECOME_ASK_PASS`, `ANSIBLE_ASK_PASS`, `ANSIBLE_USER`, ...)
in the previous step are no longer necessary. If Ansible Vault is used, however, `ANSIBLE_ASK_VAULT_PASS`
Expand All @@ -133,7 +134,7 @@ is functional and reboot safe. Since network services are not restarted automati
network configuration are not effective without a manual apply of the network configuration or reboot of the
nodes.

### Bootstrap
### Step 3: Bootstrap the manager node

Most of the parameters required for Ansible (`ANSIBLE_BECOME_ASK_PASS`, `ANSIBLE_ASK_PASS`, `ANSIBLE_USER`, ...)
in the previous step are no longer necessary.
Expand All @@ -155,7 +156,7 @@ This is recommended.
./run.sh reboot
```

### Deploy
### Step 4: Deploy the manager service

1. Transfer the configuration repository.

Expand All @@ -181,7 +182,10 @@ This is recommended.
./run.sh manager
```

Finally, the Ansible Vault password is made known on the manager node.
### Step 5: Set vault password on the manager service

Finally, the Ansible Vault password is made known on the manager node. Before that, log in to the manager node
with the `dragon` user.

```
osism set vault password
Expand Down

0 comments on commit 02ced76

Please sign in to comment.