Skip to content

Commit 41473f0

Browse files
docs: address getting started feedback (#4809) (#4826)
* docs: address getting started feedback * docs: vale feedback * docs: fix typo * Apply suggestions from code review Co-authored-by: Adelina Simion <[email protected]> * docs: apply suggestions from code review --------- Co-authored-by: Adelina Simion <[email protected]> (cherry picked from commit 8402c66) Co-authored-by: caroldelwing <[email protected]>
1 parent 5da7f4a commit 41473f0

27 files changed

+210
-111
lines changed

_partials/_create-tenant-api-key.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@ partial_category: palette-setup
33
partial_name: create-tenant-api-key
44
---
55

6-
1. Log in to [Palette](https://console.spectrocloud.com) as a tenant admin.
6+
1. Log in to [Palette](https://console.spectrocloud.com).
77

8-
2. Switch to the **Tenant Admin** scope
8+
2. Click on the **drop-down Menu** at the top of the page and switch to the **Tenant Admin** scope.
99

1010
3. Navigate to the left **Main Menu** and select **Tenant Settings**.
1111

12-
4. From the **Tenant Settings Menu**, select **API Keys**.
12+
4. From the **Tenant Settings Menu**, click on **Security** and select **API Keys**.
1313

1414
5. Click on **Add New API key**.
1515

docs/docs-content/getting-started/aws/aws.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ introducing you with Palette workflows and capabilities.
2222
In this section, you learn how to create a cluster profile. Then, you deploy a cluster to AWS by using Palette. Once
2323
your cluster is deployed, you can update it using cluster profile updates.
2424

25+
<!-- vale off -->
26+
2527
<SimpleCardGrid
2628
cards={[
2729
{

docs/docs-content/getting-started/aws/create-cluster-profile.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -44,24 +44,25 @@ In the **Basic Information** section, assign the name **aws-profile**, a brief p
4444
defaults to **1.0.0**. Click on **Next**.
4545

4646
**Cloud Type** allows you to choose the infrastructure provider with which this cluster profile is associated. Select
47-
**AWS** and click on **Next**.
47+
**AWS IaaS** and click on **Next**.
4848

4949
The **Profile Layers** step is where you specify the packs that compose the profile. There are four required
5050
infrastructure packs and several optional add-on packs you can choose from. Every pack requires you to select the **Pack
5151
Type**, **Registry**, and **Pack Name**.
5252

53-
For this tutorial, use the following packs:
53+
For this tutorial, use the following packs. If there are differences between the latest version of a pack and the
54+
version you select, a YAML editor will open. Click **Confirm Changes** to proceed.
5455

55-
| Pack Name | Version | Layer |
56-
| -------------- | ------- | ---------------- |
57-
| ubuntu-aws LTS | 22.4.x | Operating System |
58-
| Kubernetes | 1.29.x | Kubernetes |
59-
| cni-calico | 3.27.x | Network |
60-
| csi-aws-ebs | 1.26.x | Storage |
56+
| Pack Name | Version | Registry | Layer |
57+
| --------------------------- | ------- | ----------- | ---------------- |
58+
| Ubuntu | 22.4.x | Public Repo | Operating System |
59+
| Palette eXtended Kubernetes | 1.29.x | Public Repo | Kubernetes |
60+
| Calico | 3.27.x | Public Repo | Network |
61+
| Amazon EBS CSI | 1.26.x | Public Repo | Storage |
6162

62-
As you fill out the information for each layer, click on **Next** to proceed to the next layer.
63+
As you select each layer, click on **Next Layer** to proceed to the next one.
6364

64-
Click on **Confirm** after you have completed filling out all the core layers.
65+
Click on **Confirm** and then **Next** after you have completed selecting all the core layers.
6566

6667
![A view of the cluster profile stack](/getting-started/aws/getting-started_create-cluster-profile_clusters_parameters.webp)
6768

@@ -101,7 +102,7 @@ Select the **Enable Hello Universe API** preset. The pack manifest changes accor
101102
The pack requires two values to be replaced for the authorization token and for the database password when using this
102103
preset. Replace these values with your own base64 encoded values. The
103104
[_hello-universe_](https://github.com/spectrocloud/hello-universe?tab=readme-ov-file#single-load-balancer) repository
104-
provides a token that you can use.
105+
provides an unencoded token that you can use.
105106

106107
Click on **Confirm Updates**. The manifest editor closes.
107108

docs/docs-content/getting-started/aws/deploy-k8s-cluster.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,13 @@ application with a frontend, API server, and Postgres database.
145145

146146
Use the following steps to remove all the resources you created for the tutorial.
147147

148+
:::tip
149+
150+
If you plan to explore the [Deploy Cluster Profile Updates](./update-k8s-cluster.md) tutorial, do not delete your
151+
cluster, as it is a prerequisite for the tutorial.
152+
153+
:::
154+
148155
To remove the cluster, navigate to the left **Main Menu** and click on **Clusters**. Select the cluster you want to
149156
delete to access its details page.
150157

docs/docs-content/getting-started/aws/deploy-manage-k8s-cluster-tf.md

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -373,7 +373,19 @@ resource "spectrocloud_cluster_aws" "aws-cluster" {
373373
## Terraform Tests
374374

375375
Before starting the cluster deployment, test the Terraform code to ensure the resources will be provisioned correctly.
376-
Issue the following command in your terminal.
376+
377+
Issue the following command in your terminal to initialize Terraform. The `init` command initializes the working
378+
directory that contains the Terraform files.
379+
380+
```shell
381+
terraform init
382+
```
383+
384+
```text hideClipboard
385+
Terraform has been successfully initialized!
386+
```
387+
388+
Next, issue the `terraform test` command to start the tests.
377389

378390
```bash
379391
terraform test
@@ -428,8 +440,10 @@ the control plane or worker node pools as needed.
428440

429441
:::warning
430442

431-
Ensure that the SSH key pair specified in `aws-key-pair-name` is available in the same region specified by `aws-region`.
432-
For example, if `aws-region` is set to `us-east-1`, use the name of a key pair that exists in the `us-east-1` region.
443+
Note that `aws-cloud-account-name` must be replaced with the name of the AWS cloud account registered in Palette.
444+
Additionally, ensure that the SSH key pair specified in `aws-key-pair-name` is available in the same region specified by
445+
`aws-region`. For example, if `aws-region` is set to `us-east-1`, use the name of a key pair that exists in the
446+
`us-east-1` region.
433447

434448
:::
435449

@@ -472,17 +486,6 @@ environment variable. This step allows the Terraform code to authenticate with t
472486
export SPECTROCLOUD_APIKEY=<Your-Spectro-Cloud-API-key>
473487
```
474488

475-
Next, issue the following command to initialize Terraform. The `init` command initializes the working directory that
476-
contains the Terraform files.
477-
478-
```shell
479-
terraform init
480-
```
481-
482-
```text hideClipboard
483-
Terraform has been successfully initialized!
484-
```
485-
486489
:::warning
487490

488491
Before deploying the resources, ensure that there are no active clusters named `aws-cluster` or cluster profiles named

docs/docs-content/getting-started/aws/scale-secure-cluster.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -106,12 +106,11 @@ are only visible in the **Default** project. Therefore, you will need to create
106106
Navigate to the left **Main Menu** and click on **Profiles**. Click on **Import Cluster Profile**. The **Import Cluster
107107
Profile** pane opens.
108108

109-
Paste the following in the text editor. Click on **Validate**. The **Select repositories** dialog appears.
109+
Paste the following in the text editor. Click on **Validate**.
110110

111111
<PartialsComponent category="getting-started" name="import-hello-uni-aws" />
112112

113-
Click on **Confirm**. Then, click on **Confirm** on the **Import Cluster Profile** pane. Palette creates a new cluster
114-
profile named **aws-profile**.
113+
Click on **Confirm**. Palette creates a new cluster profile named **aws-profile**.
115114

116115
On the **Profiles** list, select **Project** from the **Contexts** drop-down. Your newly created cluster profile
117116
displays. The Palette UI confirms that the cluster profile was created in the scope of the

docs/docs-content/getting-started/aws/update-k8s-cluster.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,7 @@ This file enables you and other users to issue kubectl commands against the host
149149
![Image that the kubeconfig file](/getting-started/aws/getting-started_update-k8s-cluster_download-kubeconfig.webp)
150150

151151
Open a terminal window and set the environment variable `KUBECONFIG` to point to the kubeconfig file you downloaded.
152+
Issue the following command, replacing `~/Downloads/admin.aws-cluster.kubeconfig` with the path to your kubeconfig file.
152153

153154
```shell
154155
export KUBECONFIG=~/Downloads/admin.aws-cluster.kubeconfig

docs/docs-content/getting-started/azure/azure.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ approach, while introducing you with Palette workflows and capabilities.
2222
In this section, you learn how to create a cluster profile. Then, you deploy a cluster to Azure by using Palette. Once
2323
your cluster is deployed, you can update it using cluster profile updates.
2424

25+
<!-- vale off -->
26+
2527
<SimpleCardGrid
2628
cards={[
2729
{

docs/docs-content/getting-started/azure/create-cluster-profile.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -43,24 +43,25 @@ In the **Basic Information** section, assign the name **azure-profile**, a brief
4343
version defaults to **1.0.0**. Click on **Next**.
4444

4545
**Cloud Type** allows you to choose the infrastructure provider with which this cluster profile is associated. Select
46-
**Azure** and click on **Next**.
46+
**Azure IaaS** and click on **Next**.
4747

4848
The **Profile Layers** step is where you specify the packs that compose the profile. There are four required
4949
infrastructure packs and several optional add-on packs you can choose from. Every pack requires you to select the **Pack
5050
Type**, **Registry**, and **Pack Name**.
5151

52-
For this tutorial, use the following packs:
52+
For this tutorial, use the following packs. If there are differences between the latest version of a pack and the
53+
version you select, a YAML editor will open. Click **Confirm Changes** to proceed.
5354

54-
| Pack Name | Version | Layer |
55-
| ---------------- | ------- | ---------------- |
56-
| ubuntu-azure LTS | 22.4.x | Operating System |
57-
| Kubernetes | 1.30.x | Kubernetes |
58-
| cni-calico-azure | 3.26.x | Network |
59-
| Azure Disk | 1.28.x | Storage |
55+
| Pack Name | Version | Registry | Layer |
56+
| --------------------------- | ------- | ----------- | ---------------- |
57+
| Ubuntu | 22.4.x | Public Repo | Operating System |
58+
| Palette eXtended Kubernetes | 1.30.x | Public Repo | Kubernetes |
59+
| Calico | 3.26.x | Public Repo | Network |
60+
| Azure Disk | 1.28.x | Public Repo | Storage |
6061

61-
As you fill out the information for each layer, click on **Next** to proceed to the next layer.
62+
As you select each layer, click on **Next Layer** to proceed to the next one.
6263

63-
Click on **Confirm** after you have completed filling out all the core layers.
64+
Click on **Confirm** and then **Next** after you have completed selecting all the core layers.
6465

6566
![Azure cluster profile overview page](/getting-started/azure/getting-started_create-cluster-profile_cluster_profile_stack.webp)
6667

@@ -100,7 +101,7 @@ Select the **Enable Hello Universe API** preset. The pack manifest changes accor
100101
The pack requires two values to be replaced for the authorization token and for the database password when using this
101102
preset. Replace these values with your own base64 encoded values. The
102103
[_hello-universe_](https://github.com/spectrocloud/hello-universe?tab=readme-ov-file#single-load-balancer) repository
103-
provides a token that you can use.
104+
provides an unencoded token that you can use.
104105

105106
Click on **Confirm Updates**. The manifest editor closes.
106107

docs/docs-content/getting-started/azure/deploy-k8s-cluster.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,13 @@ application with a frontend, API server, and Postgres database.
144144

145145
Use the following steps to remove all the resources you created for the tutorial.
146146

147+
:::tip
148+
149+
If you plan to explore the [Deploy Cluster Profile Updates](./update-k8s-cluster.md) tutorial, do not delete your
150+
cluster, as it is a prerequisite for the tutorial.
151+
152+
:::
153+
147154
To remove the cluster, navigate to the left **Main Menu** and click on **Clusters**. Select the cluster you want to
148155
delete to access its details page.
149156

0 commit comments

Comments
 (0)