Merge branch 'master' into crossplane-doc

spectrocloud · Apr 29, 2024 · 500a174 · 500a174
2 parents b0d52c3 + 1667b59
commit 500a174
Show file tree

Hide file tree

Showing 50 changed files with 3,928 additions and 1,189 deletions.
diff --git a/.github/workflows/aloglia_crawler.yaml b/.github/workflows/aloglia_crawler.yaml
@@ -6,6 +6,11 @@ on:
     types: [completed]
   workflow_dispatch:
 
+env:
+  ALGOLIA_CRAWLER_USER_ID: ${{ secrets.ALGOLIA_CRAWLER_V3_USER_ID }}
+  ALGOLIA_CRAWLER_API_KEY: ${{ secrets.ALGOLIA_CRAWLER_V3_API_KEY }}
+  CRAWLER_ID: ${{ secrets.ALGOLIA_CRAWLER_V3_ID }}
+
 jobs:
   docsearch:
     runs-on: ubuntu-latest
@@ -20,6 +25,11 @@ jobs:
           API_KEY: ${{ secrets.ALGOLIA_ADMIN_KEY }}
         run: docker run  -e APPLICATION_ID=$APPLICATION_ID  -e API_KEY=$API_KEY  -e "CONFIG=$(cat ./docsearch.config.json | jq -r tostring)" algolia/docsearch-scraper
 
+      - name: Trigger DocSearch v3 Crawler
+        run: |
+          curl -H "Content-Type: application/json" -X POST --user ${ALGOLIA_CRAWLER_USER_ID}:${ALGOLIA_CRAWLER_API_KEY} "https://crawler.algolia.com/api/1/crawlers/${CRAWLER_ID}/reindex"
+
+
       - name: Slack Notification
         if: ${{ failure() }}
         uses: rtCamp/action-slack-notify@v2

diff --git a/.github/workflows/nightly-docker-build.yaml b/.github/workflows/nightly-docker-build.yaml
@@ -5,6 +5,7 @@ on:
     - cron: '15 22 * * 1-5'  # 22:15 UTC, Monday through Friday
   workflow_dispatch:
 
+
 env:
   GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
   # We cannot use our production values for nightly Docker builds as that would leak our production secrets.
@@ -28,6 +29,7 @@ jobs:
 
       - name: Compile
         run: |
+          touch .env
           make build
 
 

diff --git a/.github/workflows/release-preview.yaml b/.github/workflows/release-preview.yaml
@@ -41,6 +41,7 @@ jobs:
 
       - name: Build
         run: |
+          touch .env
           make build
 
       - name: Deploy Preview

diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -55,6 +55,7 @@ jobs:
 
       - name: Compile
         run: |
+          touch .env
           make versions-ci
           make build
 

diff --git a/.gitleaksignore b/.gitleaksignore
@@ -109,3 +109,4 @@ fd60bdc4fdfe8b66925db07865cb530eab4978df:docs/docs-content/integrations/kubernet
 e4040084011d4d7935a589959b96ebc5cfba7a94:docs/docs-content/integrations/kubernetes.md:generic-api-key:759
 e4040084011d4d7935a589959b96ebc5cfba7a94:docs/docs-content/integrations/kubernetes.md:generic-api-key:1125
 e4040084011d4d7935a589959b96ebc5cfba7a94:docs/docs-content/integrations/kubernetes.md:generic-api-key:391
+87bf9f7353f94ac2ecf85da3be3412202de7b72f:docusaurus.config.js:generic-api-key:363
diff --git a/Makefile b/Makefile
@@ -1,5 +1,7 @@
 .PHONY: initialize start commit build
 
+-include .env
+
 IMAGE:=spectrocloud/librarium
 # Retrieve all modified files in the content folder and compare the difference between the master branch git tree blob AND this commit's git tree blob
 CHANGED_FILE=$(shell git diff-tree -r --no-commit-id --name-only master HEAD | grep content)
@@ -8,6 +10,7 @@ TEMP_DIR=$(shell $TMPDIR)
 
 CPUS := $(shell sysctl -n hw.ncpu | awk '{print int($$1 / 2)}')
 
+ALOGLIA_CONFIG=$(shell cat docsearch.dev.config.json | jq -r tostring)
 
 
 help: ## Display this help
@@ -198,4 +201,14 @@ verify-url-links-ci: ## Check for broken URLs in production in a GitHub Actions
 
 format-images: ## Format images
 	@echo "formatting images in /static/assets/docs/images/ folder"
-	./scripts/compress-convert-images.sh
+	./scripts/compress-convert-images.sh
+
+###@ Aloglia Indexing
+
+update-dev-index: ## Update the Algolia index for the dev environment
+	@echo "updating Algolia index for dev environment"
+	docker run  -e APPLICATION_ID=${ALGOLIA_APP_ID}  -e API_KEY=${ALGOLIA_ADMIN_KEY} -e CONFIG='${ALOGLIA_CONFIG}'  algolia/docsearch-scraper
+
+remove-dev-index: ## Remove the Algolia index for the dev environment
+	@echo "removing Algolia index for dev environment"
+	algolia index delete dev-docusaurus-librarium --confirm
diff --git a/...ntent/clusters/cluster-management/backup-restore/add-backup-location-dynamic.md b/...ntent/clusters/cluster-management/backup-restore/add-backup-location-dynamic.md
@@ -102,6 +102,9 @@ cloud account.
   [Troubleshooting key access](https://docs.aws.amazon.com/kms/latest/developerguide/policy-evaluation.html) guide to
   learn more about common KMS issues.
 
+- If you are using a custom Certificate Authority (CA) for SSL/TLS connections, provide the x509 certificate in
+  Privacy-Enhanced Mail (PEM) format to Palette.
+
   :::tip
 
   Use the IAM Policy Simulator to verify the IAM role has the necessary permissions to access a customer managed KMS
@@ -130,7 +133,7 @@ cloud account.
    | ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
    | **Location Name**       | Provide a name of your choice.                                                                                                                                                                                                                                                                |
    | **Location Provider**   | Select AWS from the **drop-down** Menu.                                                                                                                                                                                                                                                       |
-   | **Certificate**         | Optional service provider x509 certificate.                                                                                                                                                                                                                                                   |
+   | **Certificate**         | Provide the CA bundle in PEM format if you are using a custom certificate bundle to establish SSL/TLS sessions.                                                                                                                                                                               |
    | **S3 Bucket**           | The name of the S3 bucket you created in the object store. The bucket name must be DNS-compliant. For more information, refer to the [Bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html) defined by AWS.                                      |
    | **Region**              | Region where the S3 bucket is hosted. You can check region codes in the [Service endpoints](https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_region) section in the AWS documentation.                                                                                                |
    | **S3 URL**              | Optional S3 URL. If you choose to provide a value, refer to the [Methods for accessing a bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-bucket-intro.html#virtual-host-style-url-ex) guide to determine the bucket URL and enable the **Force S3 path style** checkbox. |
@@ -231,6 +234,9 @@ multiple cloud accounts.
 
 - An S3 bucket in AWS Account B. The bucket will store the backup of your clusters or workspaces.
 
+- If you are using a custom Certificate Authority (CA) for SSL/TLS connections, provide the x509 certificate in
+  Privacy-Enhanced Mail (PEM) format to Palette.
+
 - The following IAM policy must be created in your AWS Account B. Replace the `BUCKET-NAME` placeholder in the policy
   below with your bucket name. Refer to the
   [Creating IAM policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_create-console.html) for

diff --git a/...ontent/clusters/cluster-management/backup-restore/add-backup-location-static.md b/...ontent/clusters/cluster-management/backup-restore/add-backup-location-static.md
@@ -99,6 +99,9 @@ The following sections provide detailed instructions. Select the environment whe
   [Troubleshooting key access](https://docs.aws.amazon.com/kms/latest/developerguide/policy-evaluation.html) guide to
   learn more about common KMS issues.
 
+- If you are using a custom Certificate Authority (CA) for SSL/TLS connections, provide the x509 certificate in
+  Privacy-Enhanced Mail (PEM) format to Palette.
+
   :::tip
 
   Use the IAM Policy Simulator to verify the IAM role has the necessary permissions to access a customer managed KMS
@@ -122,7 +125,7 @@ The following sections provide detailed instructions. Select the environment whe
    | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
    | **Location Name**       | Provide a name of your choice.                                                                                                                                                                                                                                                                                            |
    | **Location Provider**   | Select AWS from the **drop-down** Menu.                                                                                                                                                                                                                                                                                   |
-   | **Certificate**         | Optional Service provider certificate.                                                                                                                                                                                                                                                                                    |
+   | **Certificate**         | Provide the CA bundle in PEM format if you are using a custom certificate bundle to establish SSL/TLS sessions.                                                                                                                                                                                                           |
    | **S3 Bucket**           | Name of the S3 bucket you created in the object store. The bucket name must be DNS-compliant. For more information, refer to the [Bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html) defined by AWS.                                                                      |
    | **Region**              | Region where the S3 bucket is hosted. You can check the region code from the [Service endpoints](https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_region) section in the AWS documentation.                                                                                                                       |
    | **S3 URL**              | Optional bucket URL. If you choose to provide a value, refer to the [Methods for accessing a bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-bucket-intro.html#virtual-host-style-url-ex) guide to determine the bucket URL. If you provided an S3 URL, enable the **Force S3 path style** checkbox. |
@@ -234,7 +237,9 @@ Use the following steps to validate adding the new backup location.
   [MinIO official documentation](https://min.io/docs/minio/kubernetes/upstream/administration/identity-access-management/minio-user-management.html#access-keys)
   to learn about creating access keys.
 
-- An optional service provider x509 certificate.
+- If you are using a custom Certificate Authority (CA) for SSL/TLS connections, provide the x509 certificate in
+  Privacy-Enhanced Mail (PEM) format to Palette. This is required if the MinIO endpoint is using a self-signed
+  certificate.
 
 ### Add a MinIO Bucket
 
@@ -246,15 +251,15 @@ Use the following steps to validate adding the new backup location.
 
 4. Fill out the following input fields. Refer to the table below to learn more.
 
-   | **Field**               | **Value**                                                                   |
-   | ----------------------- | --------------------------------------------------------------------------- |
-   | **Location Name**       | Provide a name of your choice.                                              |
-   | **Location Provider**   | Select MinIO from the drop-down field.                                      |
-   | **Certificate**         | Service provider certificate, if your organization prefers it.              |
-   | **S3 Bucket**           | The name of the S3 bucket you created in the MinIO object store.            |
-   | **Region**              | The region where the MinIO server is configured. Example: `us-east-1`       |
-   | **S3 URL**              | The MinIO object storage console URL. Example: `http://12.123.234.567:0000` |
-   | **Force S3 path style** | This value is required for MinIO.                                           |
+   | **Field**               | **Value**                                                                                                                                                                       |
+   | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+   | **Location Name**       | Provide a name of your choice.                                                                                                                                                  |
+   | **Location Provider**   | Select MinIO from the drop-down field.                                                                                                                                          |
+   | **Certificate**         | Provide the CA bundle in PEM format if you are using a custom certificate bundle to establish SSL/TLS sessions. This is required for endpoints using a self-signed certificate. |
+   | **S3 Bucket**           | The name of the S3 bucket you created in the MinIO object store.                                                                                                                |
+   | **Region**              | The region where the MinIO server is configured. Example: `us-east-1`                                                                                                           |
+   | **S3 URL**              | The MinIO object storage console URL. Example: `http://12.123.234.567:0000`                                                                                                     |
+   | **Force S3 path style** | This value is required for MinIO.                                                                                                                                               |
 
    <br />
 
@@ -310,6 +315,7 @@ guide to learn how to create an Azure storage account
 
 - An Azure service principal with sufficient permissions to perform the required read and write operations on the
   container. You will need the values of the following items:
+
   - Client ID
   - Client Secret
 

diff --git a/docs/docs-content/clusters/edge/edge-configuration/installer-reference.md b/docs/docs-content/clusters/edge/edge-configuration/installer-reference.md
@@ -28,7 +28,7 @@ The Edge Installer is configured with a set of default values.
 
 | Parameter             | Default                                        | Description                                                                                                                                                                                                           |
 | --------------------- | ---------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `paletteEndpoint`     | `api.console.spectrocloud.com`                 | The Palette API endpoint.                                                                                                                                                                                             |
+| `paletteEndpoint`     | `api.spectrocloud.com`                         | The Palette API endpoint.                                                                                                                                                                                             |
 | `prefix`              | `edge`                                         | The prefix prepended to the edge device hostname to form the unique identifier.                                                                                                                                       |
 | `registrationURL`     | `https://edge-registration-generic.vercel.app` | The URL that operators should use when registering the Edge host with Palette.                                                                                                                                        |
 | `disableAutoRegister` | `false`                                        | Set to `true` if you want to disable auto registration. Refer to the [Register Edge Host](../site-deployment/site-installation/edge-host-registration.md) reference page to learn more about Edge host registrations. |

diff --git a/docs/docs-content/enterprise-version/install-palette/airgap/airgap.md b/docs/docs-content/enterprise-version/install-palette/airgap/airgap.md
@@ -1,7 +1,7 @@
 ---
-sidebar_label: "Airgap"
-title: "Airgap"
-description: "Learn about Palette in an airgap environment and how to install Palette in an airgap environment."
+sidebar_label: "Airgap Resources"
+title: "Airgap Resources"
+description: "Airgap installation resources for Palette."
 icon: ""
 sidebar_position: 10
 hide_table_of_contents: false
@@ -55,13 +55,11 @@ following diagram outlines the major pre-install steps for an airgap installatio
 
 To get started with an airgap Palette installation, check out the respective platform guide.
 
-- [Kubernetes Airgap Instructions](kubernetes-airgap-instructions.md)
+- [Kubernetes Airgap Instructions](../install-on-kubernetes/airgap-install/kubernetes-airgap-instructions.md)
 
-- [VMware vSphere Airgap Instructions](vmware-vsphere-airgap-instructions.md)
+- [VMware vSphere Airgap Instructions](../install-on-vmware/airgap-install/vmware-vsphere-airgap-instructions.md)
 
-Each platform guide provides detailed instructions on how to complete the pre-install steps. We also recommend you
-review the [Checklist](checklist.md) to ensure you have completed all the required steps before deploying the airgap
-Palette installation.
+Each platform guide provides detailed instructions on how to complete the pre-install steps.
 
 ## Supported Platforms
 
@@ -76,10 +74,4 @@ The following table outlines the platforms supported for airgap VerteX installat
 
 ## Resources
 
-- [Kubernetes Airgap Instructions](kubernetes-airgap-instructions.md)
-
-- [VMware vSphere Airgap Instructions](vmware-vsphere-airgap-instructions.md)
-
-- [Checklist](checklist.md)
-
-- [Additional Packs](supplemental-packs.md)
+- [Additional Packs](../airgap/supplemental-packs.md)