Skip to content

Commit

Permalink
docs: create cloud-centric Getting Started DOC-1068 (#2389)
Browse files Browse the repository at this point in the history 
* docs: add navigation card components

* chore: Add a few more grid styles

* docs: add Jest test and adjust Getting Started landing page

* docs: fix formatting

* docs: fix lint errors in SimpleCard

* docs: refactor grid test DOC-1067

* docs: reduce duplication in SimpleCard test

* docs: reduce duplication in SimpleCard test

* docs: fix formatting DOC-1067

* docs: update SimpleCardGrid naming DOC-1067

* docs: create cloud-centric Getting Started prototype DOC-1068

* docs: fix formatting

* docs: adjust nav cards and rebase

* docs: update prototype DOC-1068

* docs: move dashboard to introduction DOC-1068

* docs: update AWS section DOC-1068

* docs: update Azure section DOC-1068

* docs: update GCP section DOC-1068

* docs: add tags to getting started DOC-1068

* docs: update formatting DOC-1068

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* docs: update GCP landing page DOC-1068

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <karl@spectrocloud.com>

* docs: adjust setup fro getting started DOC-1068

* docs: remove video from deploy cluster DOC-1068

* docs: update imports in AWS DOC-1068

* docs: fix formatting DOC-1068

* docs: fix broken links DOC-1068

* docs: fix broken links DOC-1068

* docs: adjust partials usage DOC-1068

* docs: use partials in getting started DOC-1068

* docs: use hello-universe pack in cluster profile DOC-1068

* Optimised images with calibre/image-actions

* docs: fix registries link DOC-1068

* docs: update aws cluster profile updates page DOC-1068

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* docs: update azure tutorial with hello-uni pack DOC-1068

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* docs: update gcp tutorial DOC-1068

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* docs: update azure guide with correct assets DOC-1068

---------

Co-authored-by: yuliiiah <horbenko.yuliya@gmail.com>
Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
Co-authored-by: Karl Cardenas <karl@spectrocloud.com>
  • Loading branch information
@addetz @yuliiiah
@vault-token-factory-spectrocloud @karl-cardenas-coding
4 people authored Jun 24, 2024
1 parent 4827d9c commit f5b3ace
Show file tree
Hide file tree
Showing 114 changed files with 3,129 additions and 1,061 deletions.
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -610,7 +610,7 @@ partial_name: palette-setup
This is how you set up Palette in {props.cloud}.
This is an <VersionedLink name="Internal Link" url="/getting-started/additional-capabilities"/>.
This is an <VersionedLink text="Internal Link" url="/getting-started/additional-capabilities"/>.
```
The path of the link should be the path of the destination file from the root directory, without any back operators
Expand Down
35 changes: 35 additions & 0 deletions _partials/_aws-static-credentials-setup.mdx
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
partial_category: palette-setup
partial_name: aws-static-credentials
---

1. Create an IAM Role or IAM User for Palette. Use the following resources if you need additional help.

- [IAM Role creation guide](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user.html).
- [IAM User creation guide](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_create.html).

2. In the AWS console, assign the Palette-required IAM policies to the IAM role or the IAM user that Palette will use.

3. Log in to [Palette](https://console.spectrocloud.com) as tenant admin.

4. From the left **Main Menu**, click on **Tenant Settings**.

5. Select **Cloud Accounts**, and click **+Add AWS Account**.

6. In the cloud account creation wizard provide the following information:

- **Account Name:** Custom name for the cloud account.

- **Description:** Optional description for the cloud account.
- **Partition:** Choose **AWS** from the **drop-down Menu**.

- **Credentials:**
- AWS Access key
- AWS Secret access key

7. Click the **Validate** button to validate the credentials.

8. Once the credentials are validated, the **Add IAM Policies** toggle displays. Toggle **Add IAM Policies** on.

9. Use the **drop-down Menu**, which lists available IAM policies in your AWS account, to select any desired IAM
policies you want to assign to Palette IAM role or IAM user.
32 changes: 32 additions & 0 deletions _partials/_azure-cloud-account-setup.mdx
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
partial_category: palette-setup
partial_name: azure-cloud-account
---

Use the following steps to add an Azure or Azure Government account in Palette or Palette VerteX.

1. Log in to [Palette](https://console.spectrocloud.com) or Palette VerteX as a tenant admin.

2. From the left **Main Menu**, select **Tenant Settings**.

3. Next, select **Cloud Accounts** in the **Tenant Settings Menu**.

4. Locate **Azure**, and click **+ Add Azure Account**.

5. Fill out the following information, and click **Confirm** to complete the registration.

| **Basic Information** | **Description** |
| --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **Account Name** | A custom account name. |
| **Tenant ID** | Unique tenant ID from Azure Management Portal. |
| **Client ID** | Unique client ID from Azure Management Portal. |
| **Client Secret** | Azure secret for authentication. Refer to Microsoft's reference guide for creating a [Client Secret](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#create-an-azure-active-directory-application). |
| **Cloud** | Select **Azure Public Cloud** or **Azure US Government**. |
| **Tenant Name** | An optional tenant name. |
| **Disable Properties** | This option prevents Palette and VerteX from creating Azure Virtual Networks (VNets) and other network resources on your behalf for static placement deployments. If you enable this option, all users must manually specify a pre-existing VNet, subnets, and security groups when creating clusters. |
| **Connect Private Cloud Gateway** | Select this option to connect to a Private Cloud Gateway (PCG) if you have a PCG deployed in your environment. Refer to the PCG <VersionedLink text="Architecture" url="/clusters/pcg/architecture"/> page to learn more about a PCG. |

6. After providing the required values, click the **Validate** button. If the client secret you provided is correct, a
_Credentials validated_ success message with a green check is displayed.

7. Click **Confirm** to complete the registration.
66 changes: 66 additions & 0 deletions _partials/_create-upload-ssh-key.mdx
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
---
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.

<br />

```shell
ls -la ~/.ssh
```

If you see files named **id_rsa** and **id_rsa.pub**, you already have an SSH key pair and can skip to step 8. If
not, proceed to step 3.

3. Generate a new SSH key pair by issuing the following command.

<br />

```shell
ssh-keygen -t rsa -b 4096 -C "your_email@example.com"
```

Replace `your_email@example.com` with your actual email address.

4. Press Enter to accept the default file location for the key pair.

5. Enter a passphrase (optional) and confirm it. We recommend using a strong passphrase for added security.

6. Copy the public SSH key value. Use the `cat` command to display the public key.

<br />

```shell
cat ~/.ssh/id_rsa.pub
```

Copy the entire key, including the `ssh-rsa` prefix and your email address at the end.

7. Log in to [Palette](https://console.spectrocloud.com).

8. Navigate to the left **Main Menu**, select **Project Settings**, and then the **SSH Keys** tab.

9. Open the **Add New SSH Key** tab and complete the **Add Key** input form:

- **Name**: Provide a unique name for the SSH key.

- **SSH Key**: Paste the SSH public key contents from the key pair generated earlier.

10. Click **Confirm** to complete the wizard.

<br />

:::info

You can edit or delete SSH keys later by using the **three-dot Menu** to the right of each key.

:::

During cluster creation, assign your SSH key to a cluster. You can use multiple keys to a project, but only one key can
be assigned to an individual cluster.
28 changes: 28 additions & 0 deletions _partials/_gcp-cloud-account-setup.mdx
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
partial_category: palette-setup
partial_name: gcp-cloud-account
---

1. Log in to [Palette](https://console.spectrocloud.com) as Tenant admin.

2. Navigate to the left **Main Menu** and select **Tenant Settings**.

3. Select **Cloud Accounts** and click on **Add GCP Account**.

4. In the cloud account creation wizard, provide the following information:

- **Account Name:** Custom name for the cloud account.

- **JSON Credentials:** The JSON credentials object.

<br />

:::info

You can use the **Upload** button to upload the JSON file you downloaded from the GCP console.

:::

5. Click the **Validate** button to validate the credentials.

6. When the credentials are validated, click on **Confirm** to save your changes.
63 changes: 1 addition & 62 deletions docs/docs-content/clusters/cluster-management/ssh-keys.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,68 +25,7 @@ you need a public SSH key registered in Palette.

## Create and Upload an 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.

<br />

```shell
ls -la ~/.ssh
```

If you see files named **id_rsa** and **id_rsa.pub**, you already have an SSH key pair and can skip to step 8. If
not, proceed to step 3.

3. Generate a new SSH key pair by issuing the following command.

<br />

```shell
ssh-keygen -t rsa -b 4096 -C "your_email@example.com"
```

Replace `your_email@example.com` with your actual email address.

4. Press Enter to accept the default file location for the key pair.

5. Enter a passphrase (optional) and confirm it. We recommend using a strong passphrase for added security.

6. Copy the public SSH key value. Use the `cat` command to display the public key.

<br />

```shell
cat ~/.ssh/id_rsa.pub
```

Copy the entire key, including the `ssh-rsa` prefix and your email address at the end.

7. Log in to [Palette](https://console.spectrocloud.com).

8. Navigate to the left **Main Menu**, select **Project Settings**, and then the **SSH Keys** tab.

9. Open the **Add New SSH Key** tab and complete the **Add Key** input form:

- **Name**: Provide a unique name for the SSH key.

- **SSH Key**: Paste the SSH public key contents from the key pair generated earlier.

10. Click **Confirm** to complete the wizard.

<br />

:::info

You can edit or delete SSH keys later by using the **three-dot Menu** to the right of each key.

:::

During cluster creation, assign your SSH key to a cluster. You can use multiple keys to a project, but only one key can
be assigned to an individual cluster.

<PartialsComponent category="palette-setup" name="generate-ssh-key" />
## Validate

You can validate that the SSH public key is available in Palette by attempting to deploy a host cluster. During the host
Expand Down
31 changes: 1 addition & 30 deletions docs/docs-content/clusters/public-cloud/aws/add-aws-accounts.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,36 +35,7 @@ Use the steps below to add an AWS cloud account using static access credentials.

#### Add AWS Account to Palette

1. Create an IAM Role or IAM User for Palette. Use the following resources if you need additional help.

- [IAM Role creation guide](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user.html).
- [IAM User creation guide](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_create.html).

2. In the AWS console, assign the Palette-required IAM policies to the IAM role or the IAM user that Palette will use.

3. Log in to [Palette](https://console.spectrocloud.com) as tenant admin.

4. From the left **Main Menu**, click on **Tenant Settings**.

5. Select **Cloud Accounts**, and click **+Add AWS Account**.

6. In the cloud account creation wizard provide the following information:

- **Account Name:** Custom name for the cloud account.

- **Description:** Optional description for the cloud account.
- **Partition:** Choose **AWS** from the **drop-down Menu**.

- **Credentials:**
- AWS Access key
- AWS Secret access key

7. Click the **Validate** button to validate the credentials.

8. Once the credentials are validated, the **Add IAM Policies** toggle displays. Toggle **Add IAM Policies** on.

9. Use the **drop-down Menu**, which lists available IAM policies in your AWS account, to select any desired IAM
policies you want to assign to Palette IAM role or IAM user.
<PartialsComponent category="palette-setup" name="aws-static-credentials" />

#### Validate

Expand Down
28 changes: 1 addition & 27 deletions docs/docs-content/clusters/public-cloud/azure/azure-cloud.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,33 +24,7 @@ authentication methods to register your cloud account.

## Add Azure Cloud Account

Use the following steps to add an Azure or Azure Government account in Palette or Palette VerteX.

1. Log in to [Palette](https://console.spectrocloud.com) or Palette VerteX as a tenant admin.

2. From the left **Main Menu**, select **Tenant Settings**.

3. Next, select **Cloud Accounts** in the **Tenant Settings Menu**.

4. Locate **Azure**, and click **+ Add Azure Account**.

5. Fill out the following information, and click **Confirm** to complete the registration.

| **Basic Information** | **Description** |
| --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **Account Name** | A custom account name. |
| **Tenant ID** | Unique tenant ID from Azure Management Portal. |
| **Client ID** | Unique client ID from Azure Management Portal. |
| **Client Secret** | Azure secret for authentication. Refer to Microsoft's reference guide for creating a [Client Secret](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#create-an-azure-active-directory-application). |
| **Cloud** | Select **Azure Public Cloud** or **Azure US Government**. |
| **Tenant Name** | An optional tenant name. |
| **Disable Properties** | This option prevents Palette and VerteX from creating Azure Virtual Networks (VNets) and other network resources on your behalf for static placement deployments. If you enable this option, all users must manually specify a pre-existing VNet, subnets, and security groups when creating clusters. |
| **Connect Private Cloud Gateway** | Select this option to connect to a Private Cloud Gateway (PCG) if you have a PCG deployed in your environment. Refer to the PCG [Architecture](../../pcg/architecture.md) page to learn more about a PCG. |

6. After providing the required values, click the **Validate** button. If the client secret you provided is correct, a
_Credentials validated_ success message with a green check is displayed.

7. Click **Confirm** to complete the registration.
<PartialsComponent category="palette-setup" name="azure-cloud-account" />

## Validate

Expand Down
24 changes: 1 addition & 23 deletions docs/docs-content/clusters/public-cloud/gcp/add-gcp-accounts.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,29 +44,7 @@ account in Palette.

## Create Account

1. Log in to [Palette](https://console.spectrocloud.com) as Tenant admin.

2. Navigate to the left **Main Menu** and select **Tenant Settings**.

3. Select **Cloud Accounts** and click on **Add GCP Account**.

4. In the cloud account creation wizard, provide the following information:

- **Account Name:** Custom name for the cloud account.

- **JSON Credentials:** The JSON credentials object.

<br />

:::info

You can use the **Upload** button to upload the JSON file you downloaded from the GCP console.

:::

5. Click the **Validate** button to validate the credentials.

6. When the credentials are validated, click on **Confirm** to save your changes.
<PartialsComponent category="palette-setup" name="gcp-cloud-account" />

## Validate

Expand Down
4 changes: 2 additions & 2 deletions ...docs-content/enterprise-version/system-management/ssl-certificate-management.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ keywords: ["self-hosted", "enterprise"]
Palette uses Secure Sockets Layer (SSL) certificates to secure internal and external communication with Hypertext
Transfer Protocol Secure (HTTPS). External Palette endpoints, such as the
[system console](../system-management/system-management.md#system-console),
[Palette dashboard](../../getting-started/dashboard.md), Palette API, and gRPC endpoints, are enabled by default with
HTTPS using an auto-generated self-signed certificate. You can replace the self-signed certificate with a custom SSL
[Palette dashboard](../../introduction/dashboard.md), Palette API, and gRPC endpoints, are enabled by default with HTTPS
using an auto-generated self-signed certificate. You can replace the self-signed certificate with a custom SSL
certificate to secure these endpoints.

:::info
Expand Down
3 changes: 3 additions & 0 deletions docs/docs-content/getting-started/aws/_category_.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"position": 40
}
Loading

0 comments on commit f5b3ace

Please sign in to comment.