Skip to content

Commit

Permalink
Merge branch 'master' into calico-multiple-nic
Browse files Browse the repository at this point in the history
  • Loading branch information
@lennessyy
lennessyy authored Sep 24, 2024
2 parents 3c0b9d2 + 8960236 commit 80d6ea6
Show file tree
Hide file tree
Showing 315 changed files with 9,733 additions and 2,227 deletions.
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -726,7 +726,7 @@ partial_name: palette-setup
This is how you set up Palette in {props.cloud}.
This is a <VersionedLink text="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
40 changes: 40 additions & 0 deletions _partials/_authenticate-palette-cli.mdx
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
partial_category: pcg-vmware
partial_name: authenticate-palette-cli
---

The initial step to deploy a PCG using Palette CLI involves authenticating with your Palette environment using the
<VersionedLink text="palette login" url="/automation/palette-cli/commands/login" /> command.
In your terminal, execute the following command.

```bash
palette login
```

Once issued, you will be prompted for several parameters to complete the authentication. The table below outlines the
required parameters along with the values that will be utilized in this tutorial. If a parameter is specific to your
environment and Palette account, such as your Palette API key, ensure to input the value according to your environment.
Check out the <VersionedLink text="Deploy a PCG to VMware vSphere" url="/clusters/pcg/deploy-pcg/vmware"/> guide for
more information. option.

| **Parameter** | **Value** | **Environment-Specific** |
| ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ |
| **Spectro Cloud Console** | `https://console.spectrocloud.com`. If using a self-hosted instance of Palette, enter the URL for that instance. | No |
| **Allow Insecure Connection** | `Y`. Enabling this option bypasses x509 CA verification. In production environments, enter `Y` if you are using a self-hosted Palette or VerteX instance with self-signed TLS certificates and need to provide a file path to the instance CA. Otherwise, enter `N`. | No |
| **Spectro Cloud API Key** | Enter your Palette API Key. | Yes |
| **Spectro Cloud Organization** | Select your Palette Organization name. | Yes |
| **Spectro Cloud Project** | `None (TenantAdmin)` | No |
| **Acknowledge** | Accept the login banner message. <VersionedLink text="Login banner" url="/tenant-settings/login-banner"/> messages are only displayed if the tenant admin enabled a login banner. | Yes |

After accepting the login banner message, you will receive the following output confirming you have successfully
authenticated with Palette.

```text hideClipboard
Welcome to Spectro Cloud Palette
```

The video below demonstrates Palette's authentication process. Ensure you utilize values specific to your environment,
such as the correct Palette URL. Contact your Palette administrator for the correct URL if you use a self-hosted Palette
or VerteX instance.

<Video title="palette-login-video" src="/videos/palette-login.mp4"></Video>
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.
34 changes: 34 additions & 0 deletions _partials/_create-tenant-api-key.mdx
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
partial_category: palette-setup
partial_name: create-tenant-api-key
---

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

2. 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**.

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

6. Fill out the following input fields:

| **Input Field** | **Description** |
| ------------------- | ----------------------------------------------------------------------------------------------------------------- |
| **API Key Name** | Assign a name to the API key. |
| **Description** | Provide a description for the API key. |
| **User Name** | Select the user to assign the API key. |
| **Expiration Date** | Select an expiration date from the available options. You can also specify a custom date by selecting **Custom**. |

5. Click the **Generate** button.

6. Copy the API key and save it in a secure location, such as a password manager. Share the API key with the user you
created the API key for.

:::warning

Ensure you save the API key in a secure location. You will not be able to view the API key again.

:::
64 changes: 64 additions & 0 deletions _partials/_create-upload-ssh-key.mdx
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
partial_category: palette-setup
partial_name: generate-ssh-key
---

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 "[email protected]"
```

Replace `[email protected]` 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.
21 changes: 21 additions & 0 deletions _partials/_delete-pcg-vmware.mdx
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
partial_category: pcg-vmware
partial_name: delete-pcg-ui
---

After deleting your VMware cluster and cluster profile, proceed with the PCG deletion. Log in to Palette as a tenant
admin, navigate to the left **Main Menu** and select **Tenant Settings**. Next, from the **Tenant Settings Menu**, click
on **Private Cloud Gateways**. Identify the PCG you want to delete, click on the **Three-Dot Menu** at the end of the
PCG row, and select **Delete**. Click **OK** to confirm the PCG deletion.

![Delete PCG image](/clusters_pcg_deploy-app-pcg_pcg-delete.webp)

Palette will delete the PCG and the Palette services deployed on the PCG node. However, the underlying infrastructure
resources, such as the virtual machine, must be removed manually from VMware vSphere.

Log in to your VMware vSphere server and select the VM representing the PCG node named `gateway-tutorial-cp`. Click on
the **Three-Dot Actions** button, select **Power**, and **Power Off** to power off the machine. Once the machine is
powered off, click on the **Three-Dot Actions** button again and select **Delete from Disk** to remove the machine from
your VMware vSphere environment.

![Delete VMware VM](/clusters_pcg_deploy-app-pcg_vmware-delete.webp)
Loading

0 comments on commit 80d6ea6

Please sign in to comment.