Skip to content

Commit

Permalink
docs: correct STACKIT IDs
Browse files Browse the repository at this point in the history 
We got OpenStack and STACKIT IDs mixed up in our documentation previously. The OpenStack project ID is required in the `clouds.yaml` file, while the STACKIT project ID is required in the Constellation config. This fixes the warning for the OpenStack project ID in `clouds.yaml`, and adds an additional warning for the STACKIT project ID in the configuration section.
  • Loading branch information
@msanft
msanft committed Dec 12, 2024
1 parent 37e21b2 commit bcc284b
Show file tree
Hide file tree
Showing 6 changed files with 22 additions and 4 deletions.
6 changes: 6 additions & 0 deletions docs/docs/getting-started/first-steps.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,12 @@ If you encounter any problem with the following steps, make sure to use the [lat
* `stackitProjectID`: STACKIT project id (can be found after login on the [STACKIT portal](https://portal.stackit.cloud))
:::caution
`stackitProjectID` 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 `constellation-conf.yaml` file. It's of the format `XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX`.
:::
</TabItem>
</Tabs>
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/getting-started/install.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -408,7 +408,7 @@ You need to authenticate with the infrastructure API (OpenStack) and create a se
auth_url: https://keystone.api.iaas.eu01.stackit.cloud/v3
username: REPLACE_WITH_UAT_USERNAME
password: REPLACE_WITH_UAT_PASSWORD
project_id: REPLACE_WITH_STACKIT_PROJECT_ID
project_id: REPLACE_WITH_OPENSTACK_PROJECT_ID
project_name: REPLACE_WITH_STACKIT_PROJECT_NAME
user_domain_name: portal_mvp
project_domain_name: portal_mvp
Expand All @@ -418,7 +418,7 @@ You need to authenticate with the infrastructure API (OpenStack) and create a se
:::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.
`project_id` refers to the ID of your OpenStack project. The STACKIT portal also shows the STACKIT ID that's associated with your project in some places. Make sure you insert the OpenStack project ID in the `clouds.yaml` file.

:::

Expand Down
6 changes: 6 additions & 0 deletions docs/versioned_docs/version-2.19/getting-started/first-steps.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,12 @@ If you encounter any problem with the following steps, make sure to use the [lat
* `stackitProjectID`: STACKIT project id (can be found after login on the [STACKIT portal](https://portal.stackit.cloud))
:::caution
`stackitProjectID` 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 `constellation-conf.yaml` file. It's of the format `XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX`.
:::
</TabItem>
</Tabs>
Expand Down
2 changes: 1 addition & 1 deletion docs/versioned_docs/version-2.19/getting-started/install.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -418,7 +418,7 @@ You need to authenticate with the infrastructure API (OpenStack) and create a se
:::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".
`project_id` refers to the ID of your OpenStack project. The STACKIT portal also shows the STACKIT ID that's associated with your project in some places. Make sure you insert the OpenStack project ID in the `clouds.yaml` file.

:::

Expand Down
6 changes: 6 additions & 0 deletions docs/versioned_docs/version-2.20/getting-started/first-steps.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,12 @@ If you encounter any problem with the following steps, make sure to use the [lat
* `stackitProjectID`: STACKIT project id (can be found after login on the [STACKIT portal](https://portal.stackit.cloud))
:::caution
`stackitProjectID` 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 `constellation-conf.yaml` file. It's of the format `XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX`.
:::
</TabItem>
</Tabs>
Expand Down
2 changes: 1 addition & 1 deletion docs/versioned_docs/version-2.20/getting-started/install.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -418,7 +418,7 @@ You need to authenticate with the infrastructure API (OpenStack) and create a se
:::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.
`project_id` refers to the ID of your OpenStack project. The STACKIT portal also shows the STACKIT ID that's associated with your project in some places. Make sure you insert the OpenStack project ID in the `clouds.yaml` file.

:::

Expand Down

0 comments on commit bcc284b

Please sign in to comment.