From 97e09bd27e82a384e1383849a7f68b69c896a533 Mon Sep 17 00:00:00 2001 From: Kevin McDermott Date: Mon, 24 Jul 2023 17:56:48 +0100 Subject: [PATCH 1/2] Fix whitespace issue in script for creating config. This updates the static-kubeconfig.sh script to generate valid YAML. --- .../managing-clusters-without-capi.mdx | 87 +++++++++---------- 1 file changed, 43 insertions(+), 44 deletions(-) diff --git a/website/docs/cluster-management/managing-clusters-without-capi.mdx b/website/docs/cluster-management/managing-clusters-without-capi.mdx index 2b872fbf46..fe606c7f15 100644 --- a/website/docs/cluster-management/managing-clusters-without-capi.mdx +++ b/website/docs/cluster-management/managing-clusters-without-capi.mdx @@ -106,50 +106,49 @@ Here's how to create a kubeconfig secret.
Expand to see script ```bash title="static-kubeconfig.sh" - #!/bin/bash - - if [[ -z "$CLUSTER_NAME" ]]; then - echo "Ensure CLUSTER_NAME has been set" - exit 1 - fi - - if [[ -z "$CA_CERTIFICATE" ]]; then - echo "Ensure CA_CERTIFICATE has been set to the path of the CA certificate" - exit 1 - fi - - if [[ -z "$ENDPOINT" ]]; then - echo "Ensure ENDPOINT has been set" - exit 1 - fi - - if [[ -z "$TOKEN" ]]; then - echo "Ensure TOKEN has been set" - exit 1 - fi - - export CLUSTER_CA_CERTIFICATE=$(cat "$CA_CERTIFICATE" | base64) - - envsubst < From 0b78d13dcbbfdb2f5da268793ab05fdf28f01c38 Mon Sep 17 00:00:00 2001 From: Kevin McDermott Date: Tue, 25 Jul 2023 09:08:35 +0100 Subject: [PATCH 2/2] Fix up the kubeconfig script to not generate invalid YAML. --- .../managing-clusters-without-capi.mdx | 86 +++++++++--------- .../managing-existing-clusters.mdx | 89 +++++++++--------- .../managing-existing-clusters.mdx | 89 +++++++++--------- .../managing-existing-clusters.mdx | 87 +++++++++--------- .../managing-existing-clusters.mdx | 87 +++++++++--------- .../managing-existing-clusters.mdx | 87 +++++++++--------- .../managing-existing-clusters.mdx | 87 +++++++++--------- .../managing-existing-clusters.mdx | 87 +++++++++--------- .../managing-existing-clusters.mdx | 87 +++++++++--------- .../managing-existing-clusters.mdx | 87 +++++++++--------- .../managing-existing-clusters.mdx | 87 +++++++++--------- .../managing-existing-clusters.mdx | 87 +++++++++--------- .../managing-existing-clusters.mdx | 90 +++++++++---------- .../managing-clusters-without-capi.mdx | 87 +++++++++--------- .../managing-clusters-without-capi.mdx | 87 +++++++++--------- 15 files changed, 648 insertions(+), 663 deletions(-) diff --git a/website/docs/cluster-management/managing-clusters-without-capi.mdx b/website/docs/cluster-management/managing-clusters-without-capi.mdx index fe606c7f15..aa174b8069 100644 --- a/website/docs/cluster-management/managing-clusters-without-capi.mdx +++ b/website/docs/cluster-management/managing-clusters-without-capi.mdx @@ -106,49 +106,49 @@ Here's how to create a kubeconfig secret.
Expand to see script ```bash title="static-kubeconfig.sh" -#!/bin/bash - -if [[ -z "$CLUSTER_NAME" ]]; then - echo "Ensure CLUSTER_NAME has been set" - exit 1 -fi - -if [[ -z "$CA_CERTIFICATE" ]]; then - echo "Ensure CA_CERTIFICATE has been set to the path of the CA certificate" - exit 1 -fi - -if [[ -z "$ENDPOINT" ]]; then - echo "Ensure ENDPOINT has been set" - exit 1 -fi - -if [[ -z "$TOKEN" ]]; then - echo "Ensure TOKEN has been set" - exit 1 -fi - -export CLUSTER_CA_CERTIFICATE=$(cat "$CA_CERTIFICATE" | base64) - -envsubst < diff --git a/website/versioned_docs/version-0.16.0/cluster-management/managing-existing-clusters.mdx b/website/versioned_docs/version-0.16.0/cluster-management/managing-existing-clusters.mdx index 6499409b2a..de5e3ba181 100644 --- a/website/versioned_docs/version-0.16.0/cluster-management/managing-existing-clusters.mdx +++ b/website/versioned_docs/version-0.16.0/cluster-management/managing-existing-clusters.mdx @@ -100,51 +100,50 @@ TOKEN=$(kubectl get secret demo-01-token-gqz7p -o jsonpath={.data.token} | base6 We'll use a helper script to generate the kubeconfig, save this into `static-kubeconfig.sh`: -```bash title="static-kubeconfig.sh" -#!/bin/bash - -if [[ -z "$CLUSTER_NAME" ]]; then - echo "Ensure CLUSTER_NAME has been set" - exit 1 -fi - -if [[ -z "$CA_CERTIFICATE" ]]; then - echo "Ensure CA_CERTIFICATE has been set to the path of the CA certificate" - exit 1 -fi - -if [[ -z "$ENDPOINT" ]]; then - echo "Ensure ENDPOINT has been set" - exit 1 -fi - -if [[ -z "$TOKEN" ]]; then - echo "Ensure TOKEN has been set" - exit 1 -fi - -export CLUSTER_CA_CERTIFICATE=$(cat "$CA_CERTIFICATE" | base64) - -envsubst <Details->Endpoint->”Show cluster certificate”. You will need to copy the contents of the certificate into the `ca.crt` file used below. diff --git a/website/versioned_docs/version-0.17.0/cluster-management/managing-existing-clusters.mdx b/website/versioned_docs/version-0.17.0/cluster-management/managing-existing-clusters.mdx index 695293152a..a13087cd6c 100644 --- a/website/versioned_docs/version-0.17.0/cluster-management/managing-existing-clusters.mdx +++ b/website/versioned_docs/version-0.17.0/cluster-management/managing-existing-clusters.mdx @@ -100,51 +100,50 @@ TOKEN=$(kubectl get secret demo-01-token-gqz7p -o jsonpath={.data.token} | base6 We'll use a helper script to generate the kubeconfig, save this into `static-kubeconfig.sh`: -```bash title="static-kubeconfig.sh" -#!/bin/bash - -if [[ -z "$CLUSTER_NAME" ]]; then - echo "Ensure CLUSTER_NAME has been set" - exit 1 -fi - -if [[ -z "$CA_CERTIFICATE" ]]; then - echo "Ensure CA_CERTIFICATE has been set to the path of the CA certificate" - exit 1 -fi - -if [[ -z "$ENDPOINT" ]]; then - echo "Ensure ENDPOINT has been set" - exit 1 -fi - -if [[ -z "$TOKEN" ]]; then - echo "Ensure TOKEN has been set" - exit 1 -fi - -export CLUSTER_CA_CERTIFICATE=$(cat "$CA_CERTIFICATE" | base64) - -envsubst <Details->Endpoint->”Show cluster certificate”. You will need to copy the contents of the certificate into the `ca.crt` file used below. diff --git a/website/versioned_docs/version-0.18.0/cluster-management/managing-existing-clusters.mdx b/website/versioned_docs/version-0.18.0/cluster-management/managing-existing-clusters.mdx index b40849670c..82edf6ba19 100644 --- a/website/versioned_docs/version-0.18.0/cluster-management/managing-existing-clusters.mdx +++ b/website/versioned_docs/version-0.18.0/cluster-management/managing-existing-clusters.mdx @@ -108,50 +108,49 @@ kubectl create secret generic demo-01-kubeconfig \
Expand to see script ```bash title="static-kubeconfig.sh" - #!/bin/bash - - if [[ -z "$CLUSTER_NAME" ]]; then - echo "Ensure CLUSTER_NAME has been set" - exit 1 - fi - - if [[ -z "$CA_CERTIFICATE" ]]; then - echo "Ensure CA_CERTIFICATE has been set to the path of the CA certificate" - exit 1 - fi - - if [[ -z "$ENDPOINT" ]]; then - echo "Ensure ENDPOINT has been set" - exit 1 - fi - - if [[ -z "$TOKEN" ]]; then - echo "Ensure TOKEN has been set" - exit 1 - fi - - export CLUSTER_CA_CERTIFICATE=$(cat "$CA_CERTIFICATE" | base64) - - envsubst < diff --git a/website/versioned_docs/version-0.19.0/cluster-management/managing-existing-clusters.mdx b/website/versioned_docs/version-0.19.0/cluster-management/managing-existing-clusters.mdx index b40849670c..82edf6ba19 100644 --- a/website/versioned_docs/version-0.19.0/cluster-management/managing-existing-clusters.mdx +++ b/website/versioned_docs/version-0.19.0/cluster-management/managing-existing-clusters.mdx @@ -108,50 +108,49 @@ kubectl create secret generic demo-01-kubeconfig \
Expand to see script ```bash title="static-kubeconfig.sh" - #!/bin/bash - - if [[ -z "$CLUSTER_NAME" ]]; then - echo "Ensure CLUSTER_NAME has been set" - exit 1 - fi - - if [[ -z "$CA_CERTIFICATE" ]]; then - echo "Ensure CA_CERTIFICATE has been set to the path of the CA certificate" - exit 1 - fi - - if [[ -z "$ENDPOINT" ]]; then - echo "Ensure ENDPOINT has been set" - exit 1 - fi - - if [[ -z "$TOKEN" ]]; then - echo "Ensure TOKEN has been set" - exit 1 - fi - - export CLUSTER_CA_CERTIFICATE=$(cat "$CA_CERTIFICATE" | base64) - - envsubst < diff --git a/website/versioned_docs/version-0.20.0/cluster-management/managing-existing-clusters.mdx b/website/versioned_docs/version-0.20.0/cluster-management/managing-existing-clusters.mdx index b40849670c..82edf6ba19 100644 --- a/website/versioned_docs/version-0.20.0/cluster-management/managing-existing-clusters.mdx +++ b/website/versioned_docs/version-0.20.0/cluster-management/managing-existing-clusters.mdx @@ -108,50 +108,49 @@ kubectl create secret generic demo-01-kubeconfig \
Expand to see script ```bash title="static-kubeconfig.sh" - #!/bin/bash - - if [[ -z "$CLUSTER_NAME" ]]; then - echo "Ensure CLUSTER_NAME has been set" - exit 1 - fi - - if [[ -z "$CA_CERTIFICATE" ]]; then - echo "Ensure CA_CERTIFICATE has been set to the path of the CA certificate" - exit 1 - fi - - if [[ -z "$ENDPOINT" ]]; then - echo "Ensure ENDPOINT has been set" - exit 1 - fi - - if [[ -z "$TOKEN" ]]; then - echo "Ensure TOKEN has been set" - exit 1 - fi - - export CLUSTER_CA_CERTIFICATE=$(cat "$CA_CERTIFICATE" | base64) - - envsubst < diff --git a/website/versioned_docs/version-0.21.1/cluster-management/managing-existing-clusters.mdx b/website/versioned_docs/version-0.21.1/cluster-management/managing-existing-clusters.mdx index b40849670c..82edf6ba19 100644 --- a/website/versioned_docs/version-0.21.1/cluster-management/managing-existing-clusters.mdx +++ b/website/versioned_docs/version-0.21.1/cluster-management/managing-existing-clusters.mdx @@ -108,50 +108,49 @@ kubectl create secret generic demo-01-kubeconfig \
Expand to see script ```bash title="static-kubeconfig.sh" - #!/bin/bash - - if [[ -z "$CLUSTER_NAME" ]]; then - echo "Ensure CLUSTER_NAME has been set" - exit 1 - fi - - if [[ -z "$CA_CERTIFICATE" ]]; then - echo "Ensure CA_CERTIFICATE has been set to the path of the CA certificate" - exit 1 - fi - - if [[ -z "$ENDPOINT" ]]; then - echo "Ensure ENDPOINT has been set" - exit 1 - fi - - if [[ -z "$TOKEN" ]]; then - echo "Ensure TOKEN has been set" - exit 1 - fi - - export CLUSTER_CA_CERTIFICATE=$(cat "$CA_CERTIFICATE" | base64) - - envsubst < diff --git a/website/versioned_docs/version-0.21.2/cluster-management/managing-existing-clusters.mdx b/website/versioned_docs/version-0.21.2/cluster-management/managing-existing-clusters.mdx index b40849670c..82edf6ba19 100644 --- a/website/versioned_docs/version-0.21.2/cluster-management/managing-existing-clusters.mdx +++ b/website/versioned_docs/version-0.21.2/cluster-management/managing-existing-clusters.mdx @@ -108,50 +108,49 @@ kubectl create secret generic demo-01-kubeconfig \
Expand to see script ```bash title="static-kubeconfig.sh" - #!/bin/bash - - if [[ -z "$CLUSTER_NAME" ]]; then - echo "Ensure CLUSTER_NAME has been set" - exit 1 - fi - - if [[ -z "$CA_CERTIFICATE" ]]; then - echo "Ensure CA_CERTIFICATE has been set to the path of the CA certificate" - exit 1 - fi - - if [[ -z "$ENDPOINT" ]]; then - echo "Ensure ENDPOINT has been set" - exit 1 - fi - - if [[ -z "$TOKEN" ]]; then - echo "Ensure TOKEN has been set" - exit 1 - fi - - export CLUSTER_CA_CERTIFICATE=$(cat "$CA_CERTIFICATE" | base64) - - envsubst < diff --git a/website/versioned_docs/version-0.22.0/cluster-management/managing-existing-clusters.mdx b/website/versioned_docs/version-0.22.0/cluster-management/managing-existing-clusters.mdx index b40849670c..82edf6ba19 100644 --- a/website/versioned_docs/version-0.22.0/cluster-management/managing-existing-clusters.mdx +++ b/website/versioned_docs/version-0.22.0/cluster-management/managing-existing-clusters.mdx @@ -108,50 +108,49 @@ kubectl create secret generic demo-01-kubeconfig \
Expand to see script ```bash title="static-kubeconfig.sh" - #!/bin/bash - - if [[ -z "$CLUSTER_NAME" ]]; then - echo "Ensure CLUSTER_NAME has been set" - exit 1 - fi - - if [[ -z "$CA_CERTIFICATE" ]]; then - echo "Ensure CA_CERTIFICATE has been set to the path of the CA certificate" - exit 1 - fi - - if [[ -z "$ENDPOINT" ]]; then - echo "Ensure ENDPOINT has been set" - exit 1 - fi - - if [[ -z "$TOKEN" ]]; then - echo "Ensure TOKEN has been set" - exit 1 - fi - - export CLUSTER_CA_CERTIFICATE=$(cat "$CA_CERTIFICATE" | base64) - - envsubst < diff --git a/website/versioned_docs/version-0.23.0/cluster-management/managing-existing-clusters.mdx b/website/versioned_docs/version-0.23.0/cluster-management/managing-existing-clusters.mdx index b40849670c..82edf6ba19 100644 --- a/website/versioned_docs/version-0.23.0/cluster-management/managing-existing-clusters.mdx +++ b/website/versioned_docs/version-0.23.0/cluster-management/managing-existing-clusters.mdx @@ -108,50 +108,49 @@ kubectl create secret generic demo-01-kubeconfig \
Expand to see script ```bash title="static-kubeconfig.sh" - #!/bin/bash - - if [[ -z "$CLUSTER_NAME" ]]; then - echo "Ensure CLUSTER_NAME has been set" - exit 1 - fi - - if [[ -z "$CA_CERTIFICATE" ]]; then - echo "Ensure CA_CERTIFICATE has been set to the path of the CA certificate" - exit 1 - fi - - if [[ -z "$ENDPOINT" ]]; then - echo "Ensure ENDPOINT has been set" - exit 1 - fi - - if [[ -z "$TOKEN" ]]; then - echo "Ensure TOKEN has been set" - exit 1 - fi - - export CLUSTER_CA_CERTIFICATE=$(cat "$CA_CERTIFICATE" | base64) - - envsubst < diff --git a/website/versioned_docs/version-0.24.0/cluster-management/managing-existing-clusters.mdx b/website/versioned_docs/version-0.24.0/cluster-management/managing-existing-clusters.mdx index b40849670c..82edf6ba19 100644 --- a/website/versioned_docs/version-0.24.0/cluster-management/managing-existing-clusters.mdx +++ b/website/versioned_docs/version-0.24.0/cluster-management/managing-existing-clusters.mdx @@ -108,50 +108,49 @@ kubectl create secret generic demo-01-kubeconfig \
Expand to see script ```bash title="static-kubeconfig.sh" - #!/bin/bash - - if [[ -z "$CLUSTER_NAME" ]]; then - echo "Ensure CLUSTER_NAME has been set" - exit 1 - fi - - if [[ -z "$CA_CERTIFICATE" ]]; then - echo "Ensure CA_CERTIFICATE has been set to the path of the CA certificate" - exit 1 - fi - - if [[ -z "$ENDPOINT" ]]; then - echo "Ensure ENDPOINT has been set" - exit 1 - fi - - if [[ -z "$TOKEN" ]]; then - echo "Ensure TOKEN has been set" - exit 1 - fi - - export CLUSTER_CA_CERTIFICATE=$(cat "$CA_CERTIFICATE" | base64) - - envsubst < diff --git a/website/versioned_docs/version-0.25.0/cluster-management/managing-existing-clusters.mdx b/website/versioned_docs/version-0.25.0/cluster-management/managing-existing-clusters.mdx index b40849670c..82edf6ba19 100644 --- a/website/versioned_docs/version-0.25.0/cluster-management/managing-existing-clusters.mdx +++ b/website/versioned_docs/version-0.25.0/cluster-management/managing-existing-clusters.mdx @@ -108,50 +108,49 @@ kubectl create secret generic demo-01-kubeconfig \
Expand to see script ```bash title="static-kubeconfig.sh" - #!/bin/bash - - if [[ -z "$CLUSTER_NAME" ]]; then - echo "Ensure CLUSTER_NAME has been set" - exit 1 - fi - - if [[ -z "$CA_CERTIFICATE" ]]; then - echo "Ensure CA_CERTIFICATE has been set to the path of the CA certificate" - exit 1 - fi - - if [[ -z "$ENDPOINT" ]]; then - echo "Ensure ENDPOINT has been set" - exit 1 - fi - - if [[ -z "$TOKEN" ]]; then - echo "Ensure TOKEN has been set" - exit 1 - fi - - export CLUSTER_CA_CERTIFICATE=$(cat "$CA_CERTIFICATE" | base64) - - envsubst < diff --git a/website/versioned_docs/version-0.26.0/cluster-management/managing-existing-clusters.mdx b/website/versioned_docs/version-0.26.0/cluster-management/managing-existing-clusters.mdx index b40849670c..1848abbd1f 100644 --- a/website/versioned_docs/version-0.26.0/cluster-management/managing-existing-clusters.mdx +++ b/website/versioned_docs/version-0.26.0/cluster-management/managing-existing-clusters.mdx @@ -108,52 +108,50 @@ kubectl create secret generic demo-01-kubeconfig \
Expand to see script ```bash title="static-kubeconfig.sh" - #!/bin/bash - - if [[ -z "$CLUSTER_NAME" ]]; then - echo "Ensure CLUSTER_NAME has been set" - exit 1 - fi - - if [[ -z "$CA_CERTIFICATE" ]]; then - echo "Ensure CA_CERTIFICATE has been set to the path of the CA certificate" - exit 1 - fi - - if [[ -z "$ENDPOINT" ]]; then - echo "Ensure ENDPOINT has been set" - exit 1 - fi - - if [[ -z "$TOKEN" ]]; then - echo "Ensure TOKEN has been set" - exit 1 - fi - - export CLUSTER_CA_CERTIFICATE=$(cat "$CA_CERTIFICATE" | base64) - - envsubst < For the next step, the cluster certificate (CA) is needed. How you get hold of the certificate depends on the cluster. For GKE you can view it on the GCP Console: Cluster->Details->Endpoint->”Show cluster certificate”. You will need to copy the contents of the certificate into the `ca.crt` file used below. diff --git a/website/versioned_docs/version-0.27.0/cluster-management/managing-clusters-without-capi.mdx b/website/versioned_docs/version-0.27.0/cluster-management/managing-clusters-without-capi.mdx index 2b872fbf46..aa174b8069 100644 --- a/website/versioned_docs/version-0.27.0/cluster-management/managing-clusters-without-capi.mdx +++ b/website/versioned_docs/version-0.27.0/cluster-management/managing-clusters-without-capi.mdx @@ -106,50 +106,49 @@ Here's how to create a kubeconfig secret.
Expand to see script ```bash title="static-kubeconfig.sh" - #!/bin/bash - - if [[ -z "$CLUSTER_NAME" ]]; then - echo "Ensure CLUSTER_NAME has been set" - exit 1 - fi - - if [[ -z "$CA_CERTIFICATE" ]]; then - echo "Ensure CA_CERTIFICATE has been set to the path of the CA certificate" - exit 1 - fi - - if [[ -z "$ENDPOINT" ]]; then - echo "Ensure ENDPOINT has been set" - exit 1 - fi - - if [[ -z "$TOKEN" ]]; then - echo "Ensure TOKEN has been set" - exit 1 - fi - - export CLUSTER_CA_CERTIFICATE=$(cat "$CA_CERTIFICATE" | base64) - - envsubst < diff --git a/website/versioned_docs/version-0.28.0/cluster-management/managing-clusters-without-capi.mdx b/website/versioned_docs/version-0.28.0/cluster-management/managing-clusters-without-capi.mdx index 2b872fbf46..aa174b8069 100644 --- a/website/versioned_docs/version-0.28.0/cluster-management/managing-clusters-without-capi.mdx +++ b/website/versioned_docs/version-0.28.0/cluster-management/managing-clusters-without-capi.mdx @@ -106,50 +106,49 @@ Here's how to create a kubeconfig secret.
Expand to see script ```bash title="static-kubeconfig.sh" - #!/bin/bash - - if [[ -z "$CLUSTER_NAME" ]]; then - echo "Ensure CLUSTER_NAME has been set" - exit 1 - fi - - if [[ -z "$CA_CERTIFICATE" ]]; then - echo "Ensure CA_CERTIFICATE has been set to the path of the CA certificate" - exit 1 - fi - - if [[ -z "$ENDPOINT" ]]; then - echo "Ensure ENDPOINT has been set" - exit 1 - fi - - if [[ -z "$TOKEN" ]]; then - echo "Ensure TOKEN has been set" - exit 1 - fi - - export CLUSTER_CA_CERTIFICATE=$(cat "$CA_CERTIFICATE" | base64) - - envsubst <