Skip to content

Commit

Permalink
docs: stackit improve clouds.yaml description (#3470)
Browse files Browse the repository at this point in the history
  • Loading branch information
m1ghtym0 authored Nov 7, 2024
1 parent 273ec73 commit 887b9c5
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 2 deletions.
12 changes: 11 additions & 1 deletion docs/docs/getting-started/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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)
Expand Down
12 changes: 11 additions & 1 deletion docs/versioned_docs/version-2.19/getting-started/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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)
Expand Down

0 comments on commit 887b9c5

Please sign in to comment.