Skip to content

Commit 887b9c5

Browse files
authored
docs: stackit improve clouds.yaml description (#3470)
1 parent 273ec73 commit 887b9c5

File tree

2 files changed

+22
-2
lines changed

2 files changed

+22
-2
lines changed

docs/docs/getting-started/install.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -395,7 +395,11 @@ Use one of the following options on a trusted machine:
395395
You need to authenticate with the infrastructure API (OpenStack) and create a service account (STACKIT API).
396396
397397
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
398-
2. Create a configuration file under `~/.config/openstack/clouds.yaml` (`%AppData%\openstack\clouds.yaml` on Windows) with the credentials from the User Access Token
398+
2. Create a configuration file with the credentials from the User Access Token under:
399+
* Linux: `~/.config/openstack/clouds.yaml`
400+
* macOS: `/Users/<user>/Library/Application Support/openstack/clouds.yaml` or `/etc/openstack/clouds.yaml`
401+
* Windows: `%AppData%\openstack\clouds.yaml`
402+
399403
400404
```yaml
401405
clouds:
@@ -412,6 +416,12 @@ You need to authenticate with the infrastructure API (OpenStack) and create a se
412416
identity_api_version: 3
413417
```
414418
419+
:::caution
420+
421+
`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.
422+
423+
:::
424+
415425
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
416426
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)
417427
5. Create a configuration file under `~/.stackit/credentials.json` (`%USERPROFILE%\.stackit\credentials.json` on Windows)

docs/versioned_docs/version-2.19/getting-started/install.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -395,7 +395,11 @@ Use one of the following options on a trusted machine:
395395
You need to authenticate with the infrastructure API (OpenStack) and create a service account (STACKIT API).
396396
397397
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
398-
2. Create a configuration file under `~/.config/openstack/clouds.yaml` (`%AppData%\openstack\clouds.yaml` on Windows) with the credentials from the User Access Token
398+
2. Create a configuration file with the credentials from the User Access Token under:
399+
* Linux: `~/.config/openstack/clouds.yaml`
400+
* macOS: `/Users/<user>/Library/Application Support/openstack/clouds.yaml` or `/etc/openstack/clouds.yaml`
401+
* Windows: `%AppData%\openstack\clouds.yaml`
402+
399403
400404
```yaml
401405
clouds:
@@ -412,6 +416,12 @@ You need to authenticate with the infrastructure API (OpenStack) and create a se
412416
identity_api_version: 3
413417
```
414418
419+
:::caution
420+
421+
`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".
422+
423+
:::
424+
415425
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
416426
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)
417427
5. Create a configuration file under `~/.stackit/credentials.json` (`%USERPROFILE%\.stackit\credentials.json` on Windows)

0 commit comments

Comments
 (0)