Merge branch 'master' into workspace-refactor

spectrocloud · Dec 13, 2024 · 3c88d50 · 3c88d50
2 parents 780579b + f018e54
commit 3c88d50
Show file tree

Hide file tree

Showing 66 changed files with 1,110 additions and 479 deletions.
diff --git a/.github/workflows/packs-data.yaml b/.github/workflows/packs-data.yaml
@@ -5,6 +5,7 @@ on:
     # Runs at 5 minutes past the hour, every 6 hours.
     - cron: "5 */6 * * *"
   workflow_dispatch:
+
 env:
   GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
   AWS_ACCESS_KEY_ID: ${{ secrets.AWS_S3_ACCESS_KEY }}
@@ -26,13 +27,20 @@ jobs:
           secretId: ${{ secrets.VAULT_SECRET_ID }}
           secrets: /providers/github/organizations/spectrocloud/token?org_name=spectrocloud token | VAULT_GITHUB_TOKEN
 
-      - uses: actions-hub/gcloud@master
-        env:
-          PROJECT_ID: spectro-common-dev
-          APPLICATION_CREDENTIALS: ${{ secrets.GOOGLE_APPLICATION_CREDENTIALS }}
+      - uses: 'google-github-actions/auth@v2'
+        with:
+          project_id: spectro-common-dev
+          credentials_json: ${{ secrets.GOOGLE_APPLICATION_CREDENTIALS }}
+          cleanup_credentials: true
+
+      - name: 'Set up Cloud SDK'
+        uses: 'google-github-actions/setup-gcloud@v2'
         with:
-          args: cp gs://docs-education-automation/packs_inventory/packs_report.json  ./packs_report.json
-          cli: gsutil
+          version: '>= 503.0.0'    
+
+      - name: 'Get Packs Data'
+        run: |
+          gsutil cp gs://docs-education-automation/packs_inventory/packs_report.json  ./packs_report.json
 
       - name: Upload to S3
         run: |
@@ -49,4 +57,4 @@ jobs:
           SLACK_USERNAME: "spectromate"
           SLACK_ICON_EMOJI: ":robot:"
           SLACK_COLOR: ${{ job.status }}
-          SLACK_MESSAGE: 'The Docs cron job that generates the `packs.json` file failed. Please check the logs for more details.'
+          SLACK_MESSAGE: 'The Deprecated Docs cron job that generates the `packs.json` file failed. Please check the logs for more details.'
diff --git a/Makefile b/Makefile
@@ -15,7 +15,12 @@ ALOGLIA_CONFIG=$(shell cat docsearch.dev.config.json | jq -r tostring)
 # Find all *.md files in docs, cut the prefix ./ 
 # Remove all security-bulletins and cve-reports.md because they are rate limited by nvd.nist.gov
 # Remove oss-licenses.md because they are rate limited by npmjs.com
-VERIFY_URL_PATHS=$(shell find ./docs -name "*.md" | cut -c 3- | sed '/security-bulletins/d' | sed '/cve-reports/d' | sed '/oss-licenses/d')
+# Remove all /deprecated paths because we don't want to maintain their links
+VERIFY_URL_PATHS=$(shell find ./docs -name "*.md" | cut -c 3- | \
+	sed '/security-bulletins/d' | \
+	sed '/cve-reports/d' | \
+	sed '/oss-licenses/d' | \
+	sed '/deprecated/d' )
 
 RATE_LIMITED_FILES_LIST:="docs/docs-content/security-bulletins/**/*.md" \
 	"docs/docs-content/security-bulletins/*.md" \

diff --git a/README.md b/README.md
@@ -565,7 +565,9 @@ component will automatically display the badge in the correct color based on the
 ### Simple Card Grid
 
 This is a custom component that creates a grid of simple text cards with two columns, styled according to our color
-scheme. The rows of cards are dynamically created according to the list of specified cards.
+scheme. The rows of cards are dynamically created according to the list of specified cards. This component uses the
+`VersionedLink` under the covers. URLs should be specified as discussed in the [Internal Links](#internal-links)
+section.
 
 ```js
 <SimpleCardGrid
@@ -574,19 +576,19 @@ scheme. The rows of cards are dynamically created according to the list of speci
       title: "Lorem Ipsum",
       description: "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
       buttonText: "Learn more",
-      relativeURL: "./link",
+      url: "/path/to/link",
     },
     {
       title: "Lorem Ipsum",
       description: "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
       buttonText: "Learn more",
-      relativeURL: "./link",
+      url: "/path/to/link",
     },
     {
       title: "Lorem Ipsum",
       description: "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
       buttonText: "Learn more",
-      relativeURL: "./link",
+      url: "/path/to/link",
     },
   ]}
 />

diff --git a/_partials/self-hosted/_cloud-provider-config.mdx b/_partials/self-hosted/_cloud-provider-config.mdx
@@ -0,0 +1,202 @@
+---
+partial_category: self-hosted
+partial_name: cloud-provider-config
+---
+
+
+
+Different cloud providers use different image formats to create virtual machines. Amazon Web Services (AWS), for example, uses Amazon Machine Images (AMI), while Azure uses Virtual Hard Disks (VHDs). We provide public images for each cloud provider that contains the desired Operation System (OS) and Kubernetes binaries specified in a cluster profile. 
+We make these infrastructure provider images available to you by ensuring the images are available in the required cloud provider regions.
+
+When you deploy a cluster using {props.edition}, it automatically selects the correct infrastructure provider image that contains the desired Operation System (OS) and Kubernetes binaries specified in the cluster profile.
+The exception to this process is when you are using a custom image, in which case you must provide the image yourself through the <VersionedLink text="Bring Your Own OS (BYOOS) " url="/integrations/packs/?pack=generic-byoi"  /> pack.
+
+
+In the event you need to enable new cloud providers, or rotate the credentials used to access our infrastructure provider images, you can do so through the [System API](https://docs.spectrocloud.com/api/v1/system/).
+Use the following steps to modify the cloud provider configuration for your self-hosted {props.edition} instance.
+
+## Prerequisites
+
+- System administrator permissions, either a Root Administrator or Operations Administrator. Refer to the 
+  <PaletteVertexUrlMapper
+     edition={props.edition}
+     text="System Administrators"
+     url="/system-management/account-management"
+   /> page to learn more about system administrator roles.
+
+- You need cloud credentials from us to download the required infrastructure provider images. Reach out to our support team at [[email protected]](mailto:[email protected]) to obtain these credentials.
+
+- `curl` or similar tool to make API requests.
+
+## Update Cloud Provider Configuration
+
+1. Open a terminal session.
+
+
+2. Log in to the {props.edition} System API by using the `/v1/auth/syslogin` endpoint. Use the curl command below and replace the `example.com` placeholder URL with the URL of your {props.edition} instance.
+Ensure you replace the credentials below with your system console credentials.
+
+    ```shell
+    TOKEN=$(curl --insecure --location 'https://example.com/v1/auth/syslogin' \
+    --header 'Content-Type: application/json' \
+    --data '{
+      "password": "**********",
+      "username": "**********"
+    }')
+    ```
+
+    The response will contain the authentication token that you will use in the next request.
+
+
+3. Next, prepare a payload for the cloud provider you want to enable or update. Select the tab for details on the expected payload for each cloud provider.
+
+     Replace the placeholders in the payload below with the configuration values provided by our support team.
+
+      <!-- prettier-ignore -->
+
+      <Tabs groupId="provider">
+      <TabItem value="Azure" label="Azure">
+
+
+
+      ```json
+      CONFIG_JSON=$(cat <<EOF
+      {
+        "spec": {
+          "clientId": "**************",
+          "clientSecret": "**************",
+          "tenantId": "**************",
+          "subscriptionId": "**************"
+        }
+      }
+      EOF
+      )
+      ```
+      </TabItem>
+      <TabItem value="AWS" label="AWS">
+
+
+
+      ```json
+      CONFIG_JSON=$(cat <<EOF
+      {
+        "spec": {
+          "accessKey": "**************",
+          "secretKey": "**************"
+        }
+      }
+      EOF
+      )
+      ```
+      </TabItem>
+      <TabItem value="GCP" label="GCP">
+
+
+
+      ```json
+      CONFIG_JSON=$(cat <<EOF
+      {
+        "spec": {
+          "json": "**************"
+        }
+      }
+      EOF
+      )
+      ```
+      </TabItem>
+
+      </Tabs>
+
+4. Use the `/v1/system/config/:provider/account` endpoint to update the cloud provider configuration. Select the tab for the cloud provider you want to update and issue the corresponding curl command. Replace the `example.com` placeholder URL with the URL of your {props.edition} instance.
+
+    <!-- prettier-ignore -->
+
+    <Tabs groupId="provider">
+    <TabItem value="Azure" label="Azure">
+
+    ```shell
+    curl --insecure --request PUT --location 'https://example.com/v1/system/config/azure/account' \
+    --header "Authorization: $TOKEN" \
+    --header 'Content-Type: application/json' \
+    --data "$CONFIG_JSON"
+    ```
+    </TabItem>
+    <TabItem value="AWS" label="AWS">
+
+    ```shell
+    curl --insecure --request PUT --location 'https://vertex.example.com/v1/system/config/aws/account' \
+    --header "Authorization: $TOKEN" \
+    --header 'Content-Type: application/json' \
+    --data "$CONFIG_JSON"
+    ```
+    </TabItem>
+    <TabItem value="GCP" label="GCP">
+
+    ```shell
+    curl --insecure --request PUT --location 'https://vertex.example.com/v1/system/config/gcp/account' \
+    --header "Authorization: $TOKEN" \
+    --header 'Content-Type: application/json' \
+    --data "$CONFIG_JSON"
+    ```
+    </TabItem>
+
+    </Tabs>
+
+
+You have successfully updated the cloud provider configuration for your self-hosted {props.edition} instance.
+
+
+## Validate
+
+Use the following steps to validate the cloud provider configuration update.
+
+1. Open a terminal session.
+
+
+2. Log in to the {props.edition} System API by using the `/v1/auth/syslogin` endpoint. Use the curl command below and replace the `example.com` placeholder URL with the URL of your {props.edition} instance.
+Ensure you replace the credentials below with your system console credentials.
+
+    ```shell
+    TOKEN=$(curl --insecure --location 'https://example.com/v1/auth/syslogin' \
+    --header 'Content-Type: application/json' \
+    --data '{
+      "password": "**********",
+      "username": "**********"
+    }')
+    ```
+
+    The response will contain the authentication token that you will use in the next request.
+
+3.  Use the `/v1/system/config/:provider/account` endpoint to get the cloud provider configuration. Select the tab for the cloud provider you want to update and issue the corresponding curl command. Replace the `example.com` placeholder URL with the URL of your {props.edition} instance.
+
+    <!-- prettier-ignore -->
+
+    <Tabs groupId="provider">
+    <TabItem value="Azure" label="Azure">
+
+    ```shell
+    curl --insecure --request GET --location 'https://example.com/v1/system/config/azure/account' \
+    --header "Authorization: $TOKEN" \
+    --header 'Content-Type: application/json'
+    ```
+    </TabItem>
+    <TabItem value="AWS" label="AWS">
+
+    ```shell
+    curl --insecure --request GET --location 'https://vertex.example.com/v1/system/config/aws/account' \
+    --header "Authorization: $TOKEN" \
+    --header 'Content-Type: application/json'
+    ```
+    </TabItem>
+    <TabItem value="GCP" label="GCP">
+
+    ```shell
+    curl --insecure --request GET --location 'https://vertex.example.com/v1/system/config/gcp/account' \
+    --header "Authorization: $TOKEN" \
+    --header 'Content-Type: application/json'
+    ```
+    </TabItem>
+
+    </Tabs>
+
+4. The response will contain the cloud provider configuration details. Verify that the configuration values match the values you provided in the payload.
diff --git a/_partials/self-hosted/_kubernetes_palette_versions.mdx b/_partials/self-hosted/_kubernetes_palette_versions.mdx
@@ -0,0 +1,22 @@
+---
+partial_category: self-hosted
+partial_name: kubernetes-palette-versions
+---
+
+| **Palette Version** | **Kubernetes Version** | **OVA Download URL**                                                        | **FIPS OVA Download URL**                                                      |
+| ------------------- | ---------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
+| 4.5.11              | 1.29.9                 | `https://vmwaregoldenimage.s3.amazonaws.com/u-2204-0-k-1299-0.ova`          | `https://vmwaregoldenimage.s3.amazonaws.com/u-2004-0-k-1299-fips.ova`          |
+| 4.5.10              | 1.29.9                 | `https://vmwaregoldenimage.s3.amazonaws.com/u-2204-0-k-1299-0.ova`          | `https://vmwaregoldenimage.s3.amazonaws.com/u-2004-0-k-1299-fips.ova`          |
+| 4.5.8               | 1.29.9                 | `https://vmwaregoldenimage.s3.amazonaws.com/u-2204-0-k-1299-0.ova`          | `https://vmwaregoldenimage.s3.amazonaws.com/u-2004-0-k-1299-fips.ova`          |
+| 4.5.5               | 1.29.9                 | `https://vmwaregoldenimage.s3.amazonaws.com/u-2204-0-k-1299-0.ova`          | `https://vmwaregoldenimage.s3.amazonaws.com/u-2004-0-k-1299-fips.ova`          |
+| 4.5.4               | 1.29.9                 | `https://vmwaregoldenimage.s3.amazonaws.com/u-2204-0-k-1299-0.ova`          | `https://vmwaregoldenimage.s3.amazonaws.com/u-2004-0-k-1299-fips.ova`          |
+| 4.5.3               | 1.29.9                 | `https://vmwaregoldenimage.s3.amazonaws.com/u-2204-0-k-1299-0.ova`          | `https://vmwaregoldenimage.s3.amazonaws.com/u-2004-0-k-1299-fips.ova`          |
+| 4.4.20              | 1.28.13                | `https://vmwaregoldenimage.s3.amazonaws.com/u-2204-0-k-12813-0.ova`         | `https://vmwaregoldenimage.s3.amazonaws.com/u-2004-0-k-12813-fips.ova`         |
+| 4.4.18              | 1.28.13                | `https://vmwaregoldenimage.s3.amazonaws.com/u-2204-0-k-12813-0.ova`         | `https://vmwaregoldenimage.s3.amazonaws.com/u-2004-0-k-12813-fips.ova`         |
+| 4.4.14              | 1.28.12                | `https://vmwaregoldenimage.s3.amazonaws.com/u-2204-0-k-12812-0.ova`         | `https://vmwaregoldenimage.s3.amazonaws.com/u-2004-0-k-12812-fips.ova`         |
+| 4.4.11              | 1.28.11                | `https://vmwaregoldenimage-console.s3.amazonaws.com/u-2204-0-k-1289-0.ova`  | `https://vmwaregoldenimage-console.s3.amazonaws.com/u-2004-0-k-1289-fips.ova`  |
+| 4.4.6               | 1.28.9                 | `https://vmwaregoldenimage-console.s3.amazonaws.com/u-2204-0-k-1289-0.ova`  | `https://vmwaregoldenimage-console.s3.amazonaws.com/u-2004-0-k-1289-fips.ova`  |
+| 4.3.6               | 1.27.11                | `https://vmwaregoldenimage-console.s3.amazonaws.com/u-2204-0-k-12711-0.ova` | `https://vmwaregoldenimage-console.s3.amazonaws.com/u-2004-0-k-12711-fips.ova` |
+| 4.2.13              | 1.26.10                | `https://vmwaregoldenimage-console.s3.amazonaws.com/u-2204-0-k-12610-0.ova` | `https://vmwaregoldenimage-console.s3.amazonaws.com/u-2004-0-k-12610-fips.ova` |
+| 4.2.7               | 1.26.10                | `https://vmwaregoldenimage-console.s3.amazonaws.com/u-2204-0-k-12610-0.ova` | `https://vmwaregoldenimage-console.s3.amazonaws.com/u-2004-0-k-12610-fips.ova` |
+| 4.1.12              | 1.26.8                 | `https://vmwaregoldenimage-console.s3.amazonaws.com/u-2204-0-k-1268-0.ova`  | `https://vmwaregoldenimage-console.s3.amazonaws.com/u-2004-0-k-1268-fips.ova`  |
diff --git a/_partials/self-hosted/_setup-steps.mdx b/_partials/self-hosted/_setup-steps.mdx
@@ -51,9 +51,12 @@ partial_name: setup-steps
 3.  Right-click on your cluster or resource group and select **Deploy OVF Template**.
 
 4.  In the **Deploy OVF Template** wizard, enter the following URL to import the Operating System (OS) and Kubernetes
-    distribution OVA required for the {props.edition} nodes creation. Contact your {props.edition} support representative to learn if
-    the version of {props.edition} you are using requires a new OS and Kubernetes OVA.
+    distribution OVA required for the {props.edition} nodes creation. Refer to the 
+    <VersionedLink text="Kubernetes Requirements" url={props.requirementsURL} /> section to learn if the version of
+    {props.edition} you are installing requires a new OS and Kubernetes OVA.
 
+    {props.requirementsURL}
+
     <Tabs>
     <TabItem value="non-fips" label="Non-FIPS">
 

diff --git a/docs/docs-content/automation/palette-cli/palette-cli.md b/docs/docs-content/automation/palette-cli/palette-cli.md
@@ -7,7 +7,7 @@ tags: ["palette-cli"]
 ---
 
 The Palette CLI contains various functionalities that you can use to interact with Palette and manage resources. The
-Palette CLI is well suited for Continuous Delivery/Continuous Deployment (CI/CD) pipelines and recommended for
+Palette CLI is well suited for Continuous Integration/Continuous Deployment (CI/CD) pipelines and recommended for
 automation tasks, where Terraform or direct API queries are not ideal.
 
 To get started with the Palette CLI, check out the [Install](install-palette-cli.md) guide.

diff --git a/docs/docs-content/clusters/pcg/deploy-pcg-k8s.md b/docs/docs-content/clusters/pcg/deploy-pcg-k8s.md
@@ -71,6 +71,9 @@ development and testing environments.
     to the [PCG Sizing](#pcg-sizing) section for more information.
   - A Container Network Interface plugin installed.
   - A Container Storage Interface plugin installed.
+  - The Kubernetes cluster must be set up on a version of Kubernetes that is compatible to your PCG version. Refer to
+    the [Kubernetes Requirements](./pcg.md#kubernetes-requirements) section to find the version required for your
+    Palette installation
 
 - PCG IP address requirements:
 

diff --git a/docs/docs-content/clusters/pcg/pcg.md b/docs/docs-content/clusters/pcg/pcg.md
@@ -31,6 +31,21 @@ existing Kubernetes cluster. Refer to the table below to learn more about the su
 | VMware vSphere | ✅                   | The PCG is deployed into a VMware vSphere environment.                                          | [Deploy to VMware vSphere](./deploy-pcg/vmware.md)                    |
 | Other          | ❌                   | The PCG cluster is deployed into an existing Kubernetes cluster that is not managed by Palette. | [Deploy a PCG to an Existing Kubernetes Cluster](./deploy-pcg-k8s.md) |
 
+## Kubernetes Requirements
+
+The following table presents the Kubernetes version corresponding to each Palette version. It provides the download URLs
+for the Operating System and Kubernetes distribution OVA required for the PCG install. Ensure that you use FIPS OVA URL
+if you require a <VersionedLink text="FIPS" url="/vertex/fips/" /> compliant installation.
+
+:::warning
+
+The versions included in the following table apply for PCG installs on VMware vSphere and MAAS. The Kubernetes version
+for OpenStack is 1.24.10 on all the Palette versions included below.
+
+:::
+
+<PartialsComponent category="self-hosted" name="kubernetes-palette-versions" />
+
 ## Resources
 
 - [Architecture](./architecture.md)