From 1495a7f6ddfe8e490259aa565216d886c7262840 Mon Sep 17 00:00:00 2001 From: Moritz Sanft <58110325+msanft@users.noreply.github.com> Date: Thu, 12 Dec 2024 09:45:24 +0100 Subject: [PATCH] docs: correct STACKIT IDs (#3545) 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. --- docs/docs/getting-started/first-steps.md | 6 ++++++ docs/docs/getting-started/install.md | 4 ++-- .../version-2.19/getting-started/first-steps.md | 6 ++++++ docs/versioned_docs/version-2.19/getting-started/install.md | 2 +- .../version-2.20/getting-started/first-steps.md | 6 ++++++ docs/versioned_docs/version-2.20/getting-started/install.md | 2 +- 6 files changed, 22 insertions(+), 4 deletions(-) diff --git a/docs/docs/getting-started/first-steps.md b/docs/docs/getting-started/first-steps.md index 128ac28498..b197f659dd 100644 --- a/docs/docs/getting-started/first-steps.md +++ b/docs/docs/getting-started/first-steps.md @@ -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`. + + ::: + diff --git a/docs/docs/getting-started/install.md b/docs/docs/getting-started/install.md index fa481d9b89..f7b36770ae 100644 --- a/docs/docs/getting-started/install.md +++ b/docs/docs/getting-started/install.md @@ -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 @@ -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. ::: diff --git a/docs/versioned_docs/version-2.19/getting-started/first-steps.md b/docs/versioned_docs/version-2.19/getting-started/first-steps.md index 128ac28498..b197f659dd 100644 --- a/docs/versioned_docs/version-2.19/getting-started/first-steps.md +++ b/docs/versioned_docs/version-2.19/getting-started/first-steps.md @@ -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`. + + ::: + diff --git a/docs/versioned_docs/version-2.19/getting-started/install.md b/docs/versioned_docs/version-2.19/getting-started/install.md index bc0a8c9599..29be1e7f6b 100644 --- a/docs/versioned_docs/version-2.19/getting-started/install.md +++ b/docs/versioned_docs/version-2.19/getting-started/install.md @@ -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. ::: diff --git a/docs/versioned_docs/version-2.20/getting-started/first-steps.md b/docs/versioned_docs/version-2.20/getting-started/first-steps.md index 128ac28498..b197f659dd 100644 --- a/docs/versioned_docs/version-2.20/getting-started/first-steps.md +++ b/docs/versioned_docs/version-2.20/getting-started/first-steps.md @@ -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`. + + ::: + diff --git a/docs/versioned_docs/version-2.20/getting-started/install.md b/docs/versioned_docs/version-2.20/getting-started/install.md index fa481d9b89..29be1e7f6b 100644 --- a/docs/versioned_docs/version-2.20/getting-started/install.md +++ b/docs/versioned_docs/version-2.20/getting-started/install.md @@ -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. :::