From 28c581c27a72df59b350f0b400a69b20a576427f Mon Sep 17 00:00:00 2001 From: Satyam Bhardwaj Date: Thu, 9 Jan 2025 11:12:19 +0530 Subject: [PATCH] link OpenStack related docs in NAV - add other related links in OpenStack sections Signed-off-by: Satyam Bhardwaj --- docs/credential/main.md | 3 ++- docs/quick-start/installation.md | 1 + docs/quick-start/openstack.md | 7 ++++--- mkdocs.yml | 3 +++ 4 files changed, 10 insertions(+), 4 deletions(-) diff --git a/docs/credential/main.md b/docs/credential/main.md index b46123a..a7187e5 100644 --- a/docs/credential/main.md +++ b/docs/credential/main.md @@ -124,4 +124,5 @@ For OpenStack, CAPO relies on a clouds.yaml file. In Project 2A, you provide this file in a Kubernetes Secret that references OpenStack credentials (ideally application credentials for enhanced security). During reconciliation, HMC automatically generates the cloud-config required by OpenStack’s cloud-controller-manager. - + +For more details, refer to the [kcm OpenStack Credential Propagation doc](https://github.com/k0rdent/kcm/blob/main/docs/dev.md#openstack). diff --git a/docs/quick-start/installation.md b/docs/quick-start/installation.md index 3c82631..14a9808 100644 --- a/docs/quick-start/installation.md +++ b/docs/quick-start/installation.md @@ -148,3 +148,4 @@ Jump to any of the following Infrastructure Providers for specific instructions: - [AWS Quick Start](aws.md) - [Azure Quick Start](azure.md) - [vSphere Quick Start](vsphere.md) +- [OpenStack Quick Start](openstack.md) diff --git a/docs/quick-start/openstack.md b/docs/quick-start/openstack.md index 3c307e1..62b5309 100644 --- a/docs/quick-start/openstack.md +++ b/docs/quick-start/openstack.md @@ -123,9 +123,10 @@ spec: authURL: ``` -> Notes -> spec.template references the OpenStack-specific blueprint (e.g., openstack-standalone-cp-0-0-1). -> Adjust flavor, image name, and authURL to match your OpenStack environment. +> [!NOTE] +> 1. spec.template references the OpenStack-specific blueprint (e.g., openstack-standalone-cp-0-0-1). +> 2. Adjust flavor, image name, and authURL to match your OpenStack environment. +> 3. For more information about the config options, see the [OpenStack Template Parameters](../clustertemplates/openstack/template-parameters.md). Apply the YAML to your management cluster: diff --git a/mkdocs.yml b/mkdocs.yml index 95fec3c..c4ea8cf 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -74,6 +74,7 @@ nav: - AWS: quick-start/aws.md - Azure: quick-start/azure.md - vSphere: quick-start/vsphere.md + - OpenStack: quick-start/openstack.md - Usage: - Installation Guide: usage/installation.md - Air-gapped Installation Guide: usage/airgap.md @@ -93,6 +94,8 @@ nav: - vSphere: - Template Parameters: clustertemplates/vsphere/template-parameters.md - Hosted Control Plane: clustertemplates/vsphere/hosted-control-plane.md + - OpenStack: + - Template Parameters: clustertemplates/openstack/template-parameters.md - Credentials: - Overview: credential/main.md - Distribution: credential/distribution.md