Git-Mirrors/constellation
1
0
Fork 0
mirror of https://github.com/edgelesssys/constellation.git synced 2025-02-14 14:01:57 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs: stackit improve clouds.yaml description (#3470)

Browse Source
This commit is contained in:
Moritz Eckert 2024-11-07 09:30:41 +01:00 committed by GitHub
parent 273ec733fb
commit 887b9c5fae
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 22 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/docs/getting-started/install.md
View File

@ -395,7 +395,11 @@ Use one of the following options on a trusted machine:
You need to authenticate with the infrastructure API (OpenStack) and create a service account (STACKIT API).
1. [Follow the STACKIT documentation](https://docs.stackit.cloud/stackit/en/step-1-generating-of-user-access-token-11763726.html) for obtaining a User Access Token (UAT) to use the infrastructure API
2. Create a configuration file under `~/.config/openstack/clouds.yaml` (`%AppData%\openstack\clouds.yaml` on Windows) with the credentials from the User Access Token
2. Create a configuration file with the credentials from the User Access Token under:
* Linux: `~/.config/openstack/clouds.yaml`
* macOS: `/Users/<user>/Library/Application Support/openstack/clouds.yaml` or `/etc/openstack/clouds.yaml`
* Windows: `%AppData%\openstack\clouds.yaml`
```yaml
clouds:
@ -412,6 +416,12 @@ You need to authenticate with the infrastructure API (OpenStack) and create a se
identity_api_version: 3
```
:::caution
`project_id` refers to the ID of your STACKIT project. The STACKIT portal also shows the OpenStack ID that's associated with your project in some places. Make sure you insert the STACKIT project ID in the `clouds.yaml` file. It's of the format XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX.
:::
3. [Follow the STACKIT documentation](https://docs.stackit.cloud/stackit/en/getting-started-in-service-accounts-134415831.html) for creating a service account and an access token
4. Assign the `editor` role to the service account by [following the documentation](https://docs.stackit.cloud/stackit/en/getting-started-in-service-accounts-134415831.html)
5. Create a configuration file under `~/.stackit/credentials.json` (`%USERPROFILE%\.stackit\credentials.json` on Windows)

12
docs/versioned_docs/version-2.19/getting-started/install.md
View File

@ -395,7 +395,11 @@ Use one of the following options on a trusted machine:
You need to authenticate with the infrastructure API (OpenStack) and create a service account (STACKIT API).
1. [Follow the STACKIT documentation](https://docs.stackit.cloud/stackit/en/step-1-generating-of-user-access-token-11763726.html) for obtaining a User Access Token (UAT) to use the infrastructure API
2. Create a configuration file under `~/.config/openstack/clouds.yaml` (`%AppData%\openstack\clouds.yaml` on Windows) with the credentials from the User Access Token
2. Create a configuration file with the credentials from the User Access Token under:
* Linux: `~/.config/openstack/clouds.yaml`
* macOS: `/Users/<user>/Library/Application Support/openstack/clouds.yaml` or `/etc/openstack/clouds.yaml`
* Windows: `%AppData%\openstack\clouds.yaml`
```yaml
clouds:
@ -412,6 +416,12 @@ You need to authenticate with the infrastructure API (OpenStack) and create a se
identity_api_version: 3
```
:::caution
`project_id` refers to the ID of your STACKIT project. The STACKIT portal also shows the OpenStack ID that's associated with your project in some places. Make sure you insert the STACKIT project ID in the `clouds.yaml` file. It's of the format "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX".
:::
3. [Follow the STACKIT documentation](https://docs.stackit.cloud/stackit/en/getting-started-in-service-accounts-134415831.html) for creating a service account and an access token
4. Assign the `editor` role to the service account by [following the documentation](https://docs.stackit.cloud/stackit/en/getting-started-in-service-accounts-134415831.html)
5. Create a configuration file under `~/.stackit/credentials.json` (`%USERPROFILE%\.stackit\credentials.json` on Windows)