Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation for octavia #642

Merged
merged 1 commit into from
Jul 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/guides/configuration-guide/configuration-repository.md
Original file line number Diff line number Diff line change
Expand Up @@ -503,7 +503,8 @@ targets that can be used to view encrypted files and to edit encrypted files.
This opens a pager, e.g. less, and you can search with `/` for specific files, keys and passwords.

```
make ansible_vault_show
make ansible_vault_show FILE=all
make ansible_vault_show FILE=environments/secrets.yml
```

* Change or add secrets in an encrypted file with the editor set in ` $EDITOR`.
Expand Down
87 changes: 56 additions & 31 deletions docs/guides/deploy-guide/services/openstack.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,49 +80,74 @@ Not all of the services listed there are supported by OSISM.
osism apply octavia
```

9.1. Manage amphora image
10. Optional: Manage amphora image

This step is only necessary if the Amphora Driver is used. If OVN is used as the driver,
this step is not necessary.

We provide regularly updated images for Octavia in
[osism/openstack-octavia/amphora-image](https://github.com/osism/openstack-octavia-amphora-image).
The OSISM CLI can be used to upload the correct image depending on the OpenStack release
used.

```
osism manage image octavia
```
* Configure API Endpoint

For the command to be usable, a cloud profile for octavia must currently be added in the
clouds.yml file of the OpenStack environment. The `auth_url` is changed accordingly.

```yaml title="environments/openstack/clouds.yml"
clouds:
[...]
octavia:
auth:
username: octavia
project_name: service
auth_url: https://api.testbed.osism.xyz:5000/v3
project_domain_name: default
user_domain_name: default
cacert: /etc/ssl/certs/ca-certificates.crt
identity_api_version: 3
```

* Configure the secret

The secret is added to the secure.yml file. The password is set in the parameter
`octavia_keystone_password` in the file `environments/kolla/secrets.yml`.
```
make ansible_vault_edit FILE=/opt/configuration/environments/openstack/secure.yml
git add -f /opt/configuration/environments/openstack/secure.yml
```

For the command to be usable, a cloud profile for octavia must currently be added in the
clouds.yml file of the OpenStack environment. The `auth_url` is changed accordingly.
Get the secret with
```
make ansible_vault_show FILE=environments/kolla/secrets.yml |grep octavia_keystone_password
```

```yaml title="environments/openstack/clouds.yml"
clouds:
[...]
octavia:
auth:
username: octavia
project_name: service
auth_url: https://api.testbed.osism.xyz:5000/v3
project_domain_name: default
user_domain_name: default
cacert: /etc/ssl/certs/ca-certificates.crt
identity_api_version: 3
```
Create new secret file with
```
make ansible_vault_edit FILE=environments/openstack/secure.yml
```

The secret is added to the secure.yml file. The password is set in the parameter
`octavia_keystone_password` in the file `environments/kolla/secrets.yml`.
```yaml title="environments/openstack/secure.yml"
---
clouds:
[...]
octavia:
auth:
password: VALUE_OF_octavia_keystone_password
```

```yaml title="environments/openstack/secure.yml"
clouds:
[...]
octavia:
auth:
password: VALUE_OF_octavia_keystone_password
```
Add secrets to git
```
git add -f environments/openstack/secure.yml
git commit -m "Add octavia secret" -a -s
```

* Upload the correct and current image depending on the current Openstack release:

```
osism manage image octavia
```

10. Horizon
11. Horizon

```
osism apply -a pull horizon
Expand Down
Loading