Skip to content

Commit

Permalink
docs: add azure terraform tutorial, clean up gs section (#3330)
Browse files Browse the repository at this point in the history
* docs: add azure terraform tutorial, clean up gs section

* docs: add gcp tutorial

* docs: add vmware terraform tutorial

* docs: vale suggestions

* Optimised images with calibre/image-actions

* docs: vale suggestions

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* docs: style guide fixes

* docs: apply suggestions from review

---------

Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
  • Loading branch information
1 parent e2cf2d2 commit 19544ff
Show file tree
Hide file tree
Showing 49 changed files with 2,351 additions and 1,184 deletions.
2 changes: 0 additions & 2 deletions _partials/_create-upload-ssh-key.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ partial_category: palette-setup
partial_name: generate-ssh-key
---

Follow these steps to create an SSH key using the terminal and upload it to Palette:

1. Open the terminal on your computer.

2. Check for existing SSH keys by invoking the following command.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ with the new cluster profile version, and then perform a rollback.

To complete this tutorial, you will need the following items in place:

- Tenant admin access to Palette.
- Follow the steps described in the [Set up Palette with AWS](./setup.md) guide to authenticate Palette for use with
your AWS cloud account and create a Palette API key.
- [Docker Desktop](https://www.docker.com/products/docker-desktop/) or [Podman](https://podman.io/docs/installation)
Expand Down Expand Up @@ -248,27 +247,31 @@ resource "spectrocloud_cluster_profile" "aws-profile" {
tag = data.spectrocloud_pack.aws_ubuntu.version
uid = data.spectrocloud_pack.aws_ubuntu.id
values = data.spectrocloud_pack.aws_ubuntu.values
type = "spectro"
}
pack {
name = data.spectrocloud_pack.aws_k8s.name
tag = data.spectrocloud_pack.aws_k8s.version
uid = data.spectrocloud_pack.aws_k8s.id
values = data.spectrocloud_pack.aws_k8s.values
type = "spectro"
}
pack {
name = data.spectrocloud_pack.aws_cni.name
tag = data.spectrocloud_pack.aws_cni.version
uid = data.spectrocloud_pack.aws_cni.id
values = data.spectrocloud_pack.aws_cni.values
type = "spectro"
}
pack {
name = data.spectrocloud_pack.aws_csi.name
tag = data.spectrocloud_pack.aws_csi.version
uid = data.spectrocloud_pack.aws_csi.id
values = data.spectrocloud_pack.aws_csi.values
type = "spectro"
}
pack {
Expand All @@ -282,6 +285,7 @@ resource "spectrocloud_cluster_profile" "aws-profile" {
db_password = base64encode(var.db_password),
auth_token = base64encode(var.auth_token)
})
type = "oci"
}
}
```
Expand Down Expand Up @@ -474,6 +478,13 @@ terraform init
Terraform has been successfully initialized!
```

:::warning

Before deploying the resources, ensure that there are no active clusters named `aws-cluster` or cluster profiles named
`tf-aws-profile` in your Palette project.

:::

Issue the `plan` command to preview the resources that Terraform will create.

```shell
Expand Down Expand Up @@ -533,9 +544,9 @@ to click on the logo to increase the counter and for a fun image change.

## Version Cluster Profiles

As previously mentioned, Palette supports the creation of multiple cluster profile versions using the same profile name.
This provides you with better change visibility and control over the layers in your host clusters. Profile versions are
commonly used for adding or removing layers and pack configuration updates.
Palette supports the creation of multiple cluster profile versions using the same profile name. This provides you with
better change visibility and control over the layers in your host clusters. Profile versions are commonly used for
adding or removing layers and pack configuration updates.

The version number of a given profile must be unique and use the semantic versioning format `major.minor.patch`. In this
tutorial, you used Terraform to deploy two versions of an AWS cluster profile. The snippet below displays a segment of
Expand Down Expand Up @@ -611,10 +622,8 @@ Once the changes have been completed, Palette marks the cluster layers with a gr

![Image that shows the cluster with Kubecost](/getting-started/aws/getting-started_deploy-manage-k8s-cluster_profile-with-kubecost.webp)

Next, download the
[kubeconfig](https://deploy-preview-3173--docs-spectrocloud.netlify.app/clusters/cluster-management/kubeconfig/) file
for your cluster from the Palette UI. This file enables you and other users to issue `kubectl` commands against the host
cluster.
Next, download the [kubeconfig](../../clusters/cluster-management/kubeconfig.md) file for your cluster from the Palette
UI. This file enables you and other users to issue `kubectl` commands against the host cluster.

![Image that shows the cluster's kubeconfig file location](/getting-started/aws/getting-started_deploy-manage-k8s-cluster_kubeconfig.webp)

Expand Down Expand Up @@ -685,7 +694,7 @@ the resources you created through Terraform.
terraform destroy --auto-approve
```

Output:
A successful execution of `terraform destroy` will output the following.

```shell
Destroy complete! Resources: 3 destroyed.
Expand Down
11 changes: 3 additions & 8 deletions docs/docs-content/getting-started/aws/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,11 @@ order to authenticate Palette and allow it to deploy host clusters.

## Prerequisites

The prerequisite steps to getting started with Palette on AWS are as follows.

- Sign up to [Palette](https://www.spectrocloud.com/get-started).

- Your Palette account role must have the `clusterProfile.create` permission to create a cluster profile. Refer to the
[Roles and Permissions](../../user-management/palette-rbac/project-scope-roles-permissions.md#cluster-profile-admin)
documentation for more information.
- A Palette account with [tenant admin](../../tenant-settings/tenant-settings.md) access.

- Sign up to a public cloud account from
[AWS](https://aws.amazon.com/premiumsupport/knowledge-center/create-and-activate-aws-account).
[AWS](https://aws.amazon.com/premiumsupport/knowledge-center/create-and-activate-aws-account). The AWS cloud account
must have the required [IAM policies](../../clusters/public-cloud/aws/required-iam-policies.md).

- An SSH key pair available in the region where you want to deploy the cluster. Check out the
[Create EC2 SSH Key Pair](https://docs.aws.amazon.com/ground-station/latest/ug/create-ec2-ssh-key-pair.html) for
Expand Down
4 changes: 2 additions & 2 deletions docs/docs-content/getting-started/aws/update-k8s-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -284,5 +284,5 @@ Cluster profiles provide consistency during the cluster creation process, as wel
They can be versioned to keep a record of previously working cluster states, giving you visibility when updating or
rolling back workloads across your environments.

We recommend that you continue to the [Deploy a Cluster with Terraform](./deploy-manage-k8s-cluster-tf.md) page to learn
about how you can use Palette with Terraform.
We recommend that you continue to the [Cluster Management with Terraform](./deploy-manage-k8s-cluster-tf.md) page to
learn about how you can use Palette with Terraform.
6 changes: 3 additions & 3 deletions docs/docs-content/getting-started/azure/azure.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,10 @@ your cluster is deployed, you can update it using cluster profile updates.
relativeURL: "./update-k8s-cluster",
},
{
title: "Deploy a Cluster with Terraform",
description: "Deploy a Palette host cluster with Terraform.",
title: "Cluster Management with Terraform",
description: "Deploy and update a Palette host cluster with Terraform.",
buttonText: "Learn more",
relativeURL: "./deploy-k8s-cluster-tf",
relativeURL: "./deploy-manage-k8s-cluster-tf",
},
]}
/>
Loading

0 comments on commit 19544ff

Please sign in to comment.