Skip to content

Commit

Permalink
Merge branch 'main' into octavia-ci-rico-test
Browse files Browse the repository at this point in the history
  • Loading branch information
ricolin authored Feb 1, 2024
2 parents cde8420 + ef722de commit 385f269
Showing 1 changed file with 59 additions and 0 deletions.
59 changes: 59 additions & 0 deletions docs/deploy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# Deployment Guide

## Building inventory

In order to deploy Atmosphere, you will need to build a directory structure
that will contain all the configuration files and secrets required to deploy
the platform.

The recommended layout is as follows:

```text
cloud-config
├── inventory
│ ├── group_vars
│ │ ├── all
│ │ │ ├── ceph.yml
│ │ │ ├── cluster_issuer.yml
│ │ │ ├── endpoints.yml
│ │ │ ├── keepalived.yml
│ │ │ ├── kube-prometheus-stack.yml
│ │ │ ├── kubernetes.yml
│ │ │ ├── neutron.yml
│ │ │ └── secrets.sops.yml
│ │ ├── cephs
│ │ │ └── osds.yml
│ └── hosts.ini
├── playbooks
│ └── site.yml
└── requirements.yml
```

### `hosts.ini` file

The `hosts.ini` file is the Ansible inventory file that will be used to deploy
the platform. It is recommended to use the following layout:

```ini
[controllers]
ctl1.cloud.atmosphere.dev
ctl2.cloud.atmosphere.dev
ctl3.cloud.atmosphere.dev

[computes]
kvm1.cloud.atmosphere.dev
kvm2.cloud.atmosphere.dev
kvm3.cloud.atmosphere.dev

[cephs]
ceph1.cloud.atmosphere.dev
ceph2.cloud.atmosphere.dev
ceph3.cloud.atmosphere.dev
```

!!! warning

The hostnames listed in the inventory file must be a FQDN that resolves to
the IP address of the host. If they do not, you will have failures such
as agents failing to start, live migration failures and other transient
and hard to diagnose issues.

0 comments on commit 385f269

Please sign in to comment.