diff --git a/_partials/_create-tenant-api-key.mdx b/_partials/_create-tenant-api-key.mdx index 42b66330cd..a2f504f0b8 100644 --- a/_partials/_create-tenant-api-key.mdx +++ b/_partials/_create-tenant-api-key.mdx @@ -3,13 +3,13 @@ partial_category: palette-setup partial_name: create-tenant-api-key --- -1. Log in to [Palette](https://console.spectrocloud.com) as a tenant admin. +1. Log in to [Palette](https://console.spectrocloud.com). -2. Switch to the **Tenant Admin** scope +2. Click on the **drop-down Menu** at the top of the page and switch to the **Tenant Admin** scope. 3. Navigate to the left **Main Menu** and select **Tenant Settings**. -4. From the **Tenant Settings Menu**, select **API Keys**. +4. From the **Tenant Settings Menu**, click on **Security** and select **API Keys**. 5. Click on **Add New API key**. diff --git a/docs/docs-content/getting-started/aws/aws.md b/docs/docs-content/getting-started/aws/aws.md index 2b4d53c7a4..65b549b94a 100644 --- a/docs/docs-content/getting-started/aws/aws.md +++ b/docs/docs-content/getting-started/aws/aws.md @@ -22,6 +22,8 @@ introducing you with Palette workflows and capabilities. In this section, you learn how to create a cluster profile. Then, you deploy a cluster to AWS by using Palette. Once your cluster is deployed, you can update it using cluster profile updates. + + ``` -Next, issue the following command to initialize Terraform. The `init` command initializes the working directory that -contains the Terraform files. - -```shell -terraform init -``` - -```text hideClipboard -Terraform has been successfully initialized! -``` - :::warning Before deploying the resources, ensure that there are no active clusters named `aws-cluster` or cluster profiles named diff --git a/docs/docs-content/getting-started/aws/scale-secure-cluster.md b/docs/docs-content/getting-started/aws/scale-secure-cluster.md index a93c3aaab0..97d0315b38 100644 --- a/docs/docs-content/getting-started/aws/scale-secure-cluster.md +++ b/docs/docs-content/getting-started/aws/scale-secure-cluster.md @@ -106,12 +106,11 @@ are only visible in the **Default** project. Therefore, you will need to create Navigate to the left **Main Menu** and click on **Profiles**. Click on **Import Cluster Profile**. The **Import Cluster Profile** pane opens. -Paste the following in the text editor. Click on **Validate**. The **Select repositories** dialog appears. +Paste the following in the text editor. Click on **Validate**. -Click on **Confirm**. Then, click on **Confirm** on the **Import Cluster Profile** pane. Palette creates a new cluster -profile named **aws-profile**. +Click on **Confirm**. Palette creates a new cluster profile named **aws-profile**. On the **Profiles** list, select **Project** from the **Contexts** drop-down. Your newly created cluster profile displays. The Palette UI confirms that the cluster profile was created in the scope of the diff --git a/docs/docs-content/getting-started/aws/update-k8s-cluster.md b/docs/docs-content/getting-started/aws/update-k8s-cluster.md index 920bc5bb5f..c7ef39af1d 100644 --- a/docs/docs-content/getting-started/aws/update-k8s-cluster.md +++ b/docs/docs-content/getting-started/aws/update-k8s-cluster.md @@ -149,6 +149,7 @@ kubectl commands against the host cluster. ![Image that the kubeconfig file](/getting-started/aws/getting-started_update-k8s-cluster_download-kubeconfig.webp) Open a terminal window and set the environment variable `KUBECONFIG` to point to the kubeconfig file you downloaded. +Issue the following command, replacing `~/Downloads/admin.aws-cluster.kubeconfig` with the path to your kubeconfig file. ```shell export KUBECONFIG=~/Downloads/admin.aws-cluster.kubeconfig diff --git a/docs/docs-content/getting-started/azure/azure.md b/docs/docs-content/getting-started/azure/azure.md index 1040e56734..3503036dde 100644 --- a/docs/docs-content/getting-started/azure/azure.md +++ b/docs/docs-content/getting-started/azure/azure.md @@ -22,6 +22,8 @@ approach, while introducing you with Palette workflows and capabilities. In this section, you learn how to create a cluster profile. Then, you deploy a cluster to Azure by using Palette. Once your cluster is deployed, you can update it using cluster profile updates. + + ``` -Next, issue the following command to initialize Terraform. The `init` command initializes the working directory that -contains the Terraform files. - -```shell -terraform init -``` - -```text hideClipboard -Terraform has been successfully initialized! -``` - :::warning Before deploying the resources, ensure that there are no active clusters named `azure-cluster` or cluster profiles named diff --git a/docs/docs-content/getting-started/azure/scale-secure-cluster.md b/docs/docs-content/getting-started/azure/scale-secure-cluster.md index 4c5269754b..5da05b65c1 100644 --- a/docs/docs-content/getting-started/azure/scale-secure-cluster.md +++ b/docs/docs-content/getting-started/azure/scale-secure-cluster.md @@ -106,12 +106,11 @@ are only visible in the **Default** project. Therefore, you will need to create Navigate to the left **Main Menu** and click on **Profiles**. Click on **Import Cluster Profile**. The **Import Cluster Profile** pane opens. -Paste the following in the text editor. Click on **Validate**. The **Select repositories** dialog appears. +Paste the following in the text editor. Click on **Validate**. -Click on **Confirm**. Then, click on **Confirm** on the **Import Cluster Profile** pane. Palette creates a new cluster -profile named **azure-profile**. +Click on **Confirm**. Palette creates a new cluster profile named **azure-profile**. On the **Profiles** list, select **Project** from the **Contexts** drop-down. Your newly created cluster profile displays. The Palette UI confirms that the cluster profile was created in the scope of the diff --git a/docs/docs-content/getting-started/azure/update-k8s-cluster.md b/docs/docs-content/getting-started/azure/update-k8s-cluster.md index 1c4f02115b..ac25880aaf 100644 --- a/docs/docs-content/getting-started/azure/update-k8s-cluster.md +++ b/docs/docs-content/getting-started/azure/update-k8s-cluster.md @@ -149,6 +149,8 @@ kubectl commands against the host cluster. ![Image that the kubeconfig file](/getting-started/azure/getting-started_update-k8s-cluster_download-kubeconfig.webp) Open a terminal window and set the environment variable `KUBECONFIG` to point to the kubeconfig file you downloaded. +Issue the following command, replacing `~/Downloads/admin.azure-cluster.kubeconfig` with the path to your kubeconfig +file. ```shell export KUBECONFIG=~/Downloads/admin.azure-cluster.kubeconfig diff --git a/docs/docs-content/getting-started/gcp/create-cluster-profile.md b/docs/docs-content/getting-started/gcp/create-cluster-profile.md index b5d81a098b..b64389dab4 100644 --- a/docs/docs-content/getting-started/gcp/create-cluster-profile.md +++ b/docs/docs-content/getting-started/gcp/create-cluster-profile.md @@ -41,25 +41,26 @@ In the **Basic Information** section, assign the name **gcp-profile**, provide a **Full**, and assign the tag **env:gcp**. You can leave the version empty if you want to. Just be aware that the version defaults to **1.0.0**. Click on **Next**. -Cloud Type allows you to choose the infrastructure provider with which this cluster profile is associated. Select -**Google Cloud** and click on **Next**. +Cloud Type allows you to choose the infrastructure provider with which this cluster profile is associated. Select **GCP +IaaS** and click on **Next**. The **Profile Layers** step is where you specify the packs that compose the profile. There are four required infrastructure packs and several optional add-on packs you can choose from. Every pack requires you to select the **Pack Type**, **Registry**, and **Pack Name**. -For this tutorial, use the following packs: +For this tutorial, use the following packs. If there are differences between the latest version of a pack and the +version you select, a YAML editor will open. Click **Confirm Changes** to proceed. -| Pack Name | Version | Layer | -| -------------- | ------- | ---------------- | -| ubuntu-gcp LTS | 22.4.x | Operating System | -| Kubernetes | 1.28.x | Kubernetes | -| cni-calico | 3.27.x | Network | -| csi-gcp-driver | 1.12.x | Storage | +| Pack Name | Version | Registry | Layer | +| --------------------------- | ------- | ----------- | ---------------- | +| Ubuntu | 22.4.x | Public Repo | Operating System | +| Palette eXtended Kubernetes | 1.28.x | Public Repo | Kubernetes | +| Calico | 3.27.x | Public Repo | Network | +| GCE Persistent Disk CSI | 1.12.x | Public Repo | Storage | -As you fill out the information for each layer, click on **Next** to proceed to the next layer. +As you select each layer, click on **Next Layer** to proceed to the next one. -Click on **Confirm** after you have completed filling out all the core layers. +Click on **Confirm** and then **Next** after you have completed selecting all the core layers. ![GCP cluster profile view](/getting-started/gcp/getting-started_create-cluster-profile_cluster_profile_stack.webp) @@ -99,7 +100,7 @@ Select the **Enable Hello Universe API** preset. The pack manifest changes accor The pack requires two values to be replaced for the authorization token and for the database password when using this preset. Replace these values with your own base64 encoded values. The [_hello-universe_](https://github.com/spectrocloud/hello-universe?tab=readme-ov-file#single-load-balancer) repository -provides a token that you can use. +provides an unencoded token that you can use. Click on **Confirm Updates**. The manifest editor closes. diff --git a/docs/docs-content/getting-started/gcp/deploy-k8s-cluster.md b/docs/docs-content/getting-started/gcp/deploy-k8s-cluster.md index 95ae5b6420..3ed182ef53 100644 --- a/docs/docs-content/getting-started/gcp/deploy-k8s-cluster.md +++ b/docs/docs-content/getting-started/gcp/deploy-k8s-cluster.md @@ -145,6 +145,13 @@ application with a frontend, API server, and Postgres database. Use the following steps to remove all the resources you created for the tutorial. +:::tip + +If you plan to explore the [Deploy Cluster Profile Updates](./update-k8s-cluster.md) tutorial, do not delete your +cluster, as it is a prerequisite for the tutorial. + +::: + To remove the cluster, navigate to the left **Main Menu** and click on **Clusters**. Select the cluster you want to delete to access its details page. diff --git a/docs/docs-content/getting-started/gcp/deploy-manage-k8s-cluster-tf.md b/docs/docs-content/getting-started/gcp/deploy-manage-k8s-cluster-tf.md index e17b6aaac5..b6359cf63a 100644 --- a/docs/docs-content/getting-started/gcp/deploy-manage-k8s-cluster-tf.md +++ b/docs/docs-content/getting-started/gcp/deploy-manage-k8s-cluster-tf.md @@ -373,7 +373,19 @@ resource "spectrocloud_cluster_gcp" "gcp-cluster" { ## Terraform Tests Before starting the cluster deployment, test the Terraform code to ensure the resources will be provisioned correctly. -Issue the following command in your terminal. + +Issue the following command in your terminal to initialize Terraform. The `init` command initializes the working +directory that contains the Terraform files. + +```shell +terraform init +``` + +```text hideClipboard +Terraform has been successfully initialized! +``` + +Next, issue the `terraform test` command to start the tests. ```bash terraform test @@ -426,6 +438,12 @@ occurrences of `REPLACE_ME` with their corresponding values, such as those for t `gcp-region`, `gcp_project_name`, and `availability_zones` variables. You can also update the values for the nodes in the control plane or worker node pools as needed. +:::warning + +Ensure that `gcp-cloud-account-name` is replaced with the name of the GCP cloud account registered in Palette. + +::: + ```hcl {4,7-9,16,24} ########################### # GCP Deployment Settings @@ -465,17 +483,6 @@ environment variable. This step allows the Terraform code to authenticate with t export SPECTROCLOUD_APIKEY= ``` -Next, issue the following command to initialize Terraform. The `init` command initializes the working directory that -contains the Terraform files. - -```shell -terraform init -``` - -```text hideClipboard -Terraform has been successfully initialized! -``` - :::warning Before deploying the resources, ensure that there are no active clusters named `gcp-cluster` or cluster profiles named diff --git a/docs/docs-content/getting-started/gcp/gcp.md b/docs/docs-content/getting-started/gcp/gcp.md index b3657d821e..b15e5200ce 100644 --- a/docs/docs-content/getting-started/gcp/gcp.md +++ b/docs/docs-content/getting-started/gcp/gcp.md @@ -22,6 +22,8 @@ introducing you with Palette workflows and capabilities. In this section, you learn how to create a cluster profile. Then, you deploy a cluster to GCP by using Palette. Once your cluster is deployed, you can update it using cluster profile updates. + + -Click on **Confirm**. Then, click on **Confirm** on the **Import Cluster Profile** pane. Palette creates a new cluster -profile named **gcp-profile**. +Click on **Confirm**. Palette creates a new cluster profile named **gcp-profile**. On the **Profiles** list, select **Project** from the **Contexts** drop-down. Your newly created cluster profile displays. The Palette UI confirms that the cluster profile was created in the scope of the diff --git a/docs/docs-content/getting-started/gcp/update-k8s-cluster.md b/docs/docs-content/getting-started/gcp/update-k8s-cluster.md index ab2fc76dac..d694159022 100644 --- a/docs/docs-content/getting-started/gcp/update-k8s-cluster.md +++ b/docs/docs-content/getting-started/gcp/update-k8s-cluster.md @@ -149,6 +149,7 @@ kubectl commands against the host cluster. ![Image that the kubeconfig file](/getting-started/gcp/getting-started_update-k8s-cluster_download-kubeconfig.webp) Open a terminal window and set the environment variable `KUBECONFIG` to point to the kubeconfig file you downloaded. +Issue the following command, replacing `~/Downloads/admin.gcp-cluster.kubeconfig` with the path to your kubeconfig file. ```shell export KUBECONFIG=~/Downloads/admin.gcp-cluster.kubeconfig diff --git a/docs/docs-content/getting-started/getting-started.md b/docs/docs-content/getting-started/getting-started.md index 1fdc586690..fc29e91d72 100644 --- a/docs/docs-content/getting-started/getting-started.md +++ b/docs/docs-content/getting-started/getting-started.md @@ -27,8 +27,8 @@ a quick overview of Palette's key functionalities. ## Deploy Kubernetes Clusters with Palette The first step towards adopting Palette in your organization is to -[create a login](https://www.spectrocloud.com/get-started). The -[Palette Free Tier](https://www.spectrocloud.com/free-tier) allows you to experience the benefits of Palette first-hand. +[book a demo](https://www.spectrocloud.com/get-started) with one of our experts. This will allow you to experience the +benefits of Palette first-hand. We have curated the pages in the Getting Started section to give you a gradual introduction to the fundamental concepts and workflows you need to deploy and manage Kubernetes clusters through Palette. @@ -49,6 +49,8 @@ orchestration. Explore more through the following pages. + + + + diff --git a/docs/docs-content/getting-started/vmware/create-cluster-profile.md b/docs/docs-content/getting-started/vmware/create-cluster-profile.md index 44a0cd6128..2e02911ab1 100644 --- a/docs/docs-content/getting-started/vmware/create-cluster-profile.md +++ b/docs/docs-content/getting-started/vmware/create-cluster-profile.md @@ -50,18 +50,19 @@ The **Profile Layers** step is where you specify the packs that compose the prof infrastructure packs and several optional add-on packs you can choose from. Every pack requires you to select the **Pack Type**, **Registry**, and **Pack Name**. -For this tutorial, use the following packs: +For this tutorial, use the following packs. If there are differences between the latest version of a pack and the +version you select, a YAML editor will open. Click **Confirm Changes** to proceed. -| Pack Name | Version | Layer | -| --------------- | ------- | ---------------- | -| ubuntu-vsphere | 22.4.x | Operating System | -| kubernetes | 1.28.x | Kubernetes | -| cni-calico | 3.27.x | Network | -| csi-vsphere-csi | 3.1.x | Storage | +| Pack Name | Version | Registry | Layer | +| --------------------------- | ------- | ----------- | ---------------- | +| Ubuntu | 22.4.x | Public Repo | Operating System | +| Palette eXtended Kubernetes | 1.28.x | Public Repo | Kubernetes | +| Calico | 3.27.x | Public Repo | Network | +| vSphere CSI | 3.1.x | Public Repo | Storage | -As you fill out the information for each layer, click on **Next** to proceed to the next layer. +As you select each layer, click on **Next Layer** to proceed to the next one. -Click on **Confirm** after you have completed filling out all the core layers. +Click on **Confirm** and then **Next** after you have completed selecting all the core layers. ![VMware core layers](/getting-started/vmware/getting-started_create-cluster-profile_cluster-profile-core-stack.webp) @@ -124,7 +125,7 @@ Select the **Enable Hello Universe API** preset. The pack manifest changes accor The pack requires two values to be replaced for the authorization token and for the database password when using this preset. Replace these values with your own base64 encoded values. The [_hello-universe_](https://github.com/spectrocloud/hello-universe?tab=readme-ov-file#single-load-balancer) repository -provides a token that you can use. +provides an unencoded token that you can use. Click on **Confirm Updates**. The manifest editor closes. diff --git a/docs/docs-content/getting-started/vmware/deploy-k8s-cluster.md b/docs/docs-content/getting-started/vmware/deploy-k8s-cluster.md index 297e66a71f..28b6d8437c 100644 --- a/docs/docs-content/getting-started/vmware/deploy-k8s-cluster.md +++ b/docs/docs-content/getting-started/vmware/deploy-k8s-cluster.md @@ -145,6 +145,13 @@ application with a frontend, API server, and Postgres database. Use the following steps to remove all the resources you created for the tutorial. +:::tip + +If you plan to explore the [Deploy Cluster Profile Updates](./update-k8s-cluster.md) tutorial, do not delete your +cluster, as it is a prerequisite for the tutorial. + +::: + To remove the cluster, navigate to the left **Main Menu** and click on **Clusters**. Select the cluster you want to delete to access its details page. diff --git a/docs/docs-content/getting-started/vmware/deploy-manage-k8s-cluster-tf.md b/docs/docs-content/getting-started/vmware/deploy-manage-k8s-cluster-tf.md index 2ed544f695..5133b66a49 100644 --- a/docs/docs-content/getting-started/vmware/deploy-manage-k8s-cluster-tf.md +++ b/docs/docs-content/getting-started/vmware/deploy-manage-k8s-cluster-tf.md @@ -415,7 +415,19 @@ resource "spectrocloud_cluster_vsphere" "vmware-cluster" { ## Terraform Tests Before starting the cluster deployment, test the Terraform code to ensure the resources will be provisioned correctly. -Issue the following command in your terminal. + +Issue the following command in your terminal to initialize Terraform. The `init` command initializes the working +directory that contains the Terraform files. + +```shell +terraform init +``` + +```text hideClipboard +Terraform has been successfully initialized! +``` + +Next, issue the `terraform test` command to start the tests. ```bash terraform test @@ -518,17 +530,6 @@ environment variable. This step allows the Terraform code to authenticate with t export SPECTROCLOUD_APIKEY= ``` -Next, issue the following command to initialize Terraform. The `init` command initializes the working directory that -contains the Terraform files. - -```shell -terraform init -``` - -```text hideClipboard -Terraform has been successfully initialized! -``` - :::warning Before deploying the resources, ensure that there are no active clusters named `vmware-cluster` or cluster profiles diff --git a/docs/docs-content/getting-started/vmware/scale-secure-cluster.md b/docs/docs-content/getting-started/vmware/scale-secure-cluster.md index 9c1f706a04..a01003f784 100644 --- a/docs/docs-content/getting-started/vmware/scale-secure-cluster.md +++ b/docs/docs-content/getting-started/vmware/scale-secure-cluster.md @@ -109,12 +109,11 @@ are only visible in the **Default** project. Therefore, you will need to create Navigate to the left **Main Menu** and click on **Profiles**. Click on **Import Cluster Profile**. The **Import Cluster Profile** pane opens. -Paste the following in the text editor. Click on **Validate**. The **Select repositories** dialog appears. +Paste the following in the text editor. Click on **Validate**. -Click on **Confirm**. Then, click on **Confirm** on the **Import Cluster Profile** pane. Palette creates a new cluster -profile named **vmware-profile**. +Click on **Confirm**. Palette creates a new cluster profile named **vmware-profile**. On the **Profiles** list, select **Project** from the **Contexts** drop-down. Your newly created cluster profile displays. The Palette UI confirms that the cluster profile was created in the scope of the diff --git a/docs/docs-content/getting-started/vmware/update-k8s-cluster.md b/docs/docs-content/getting-started/vmware/update-k8s-cluster.md index 2b0f36257e..66605ea6ec 100644 --- a/docs/docs-content/getting-started/vmware/update-k8s-cluster.md +++ b/docs/docs-content/getting-started/vmware/update-k8s-cluster.md @@ -150,6 +150,9 @@ kubectl commands against the host cluster. Open a terminal window and set the environment variable `KUBECONFIG` to point to the kubeconfig file you downloaded. +Issue the following command, replacing `~/Downloads/admin.vmware-cluster.kubeconfig` with the path to your kubeconfig +file. + ```shell export KUBECONFIG=~/Downloads/admin.vmware-cluster.kubeconfig ``` diff --git a/docs/docs-content/getting-started/vmware/vmware.md b/docs/docs-content/getting-started/vmware/vmware.md index 8a38d55860..efb584707a 100644 --- a/docs/docs-content/getting-started/vmware/vmware.md +++ b/docs/docs-content/getting-started/vmware/vmware.md @@ -22,6 +22,8 @@ introducing you with Palette workflows and capabilities. In this section, you learn how to create a cluster profile. Then, you deploy a cluster to VMware vSphere using Palette. Once your cluster is deployed, you can update it using cluster profile updates. + +