Skip to content
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 0 additions & 31 deletions _partials/_aws-static-credentials-setup.mdx

This file was deleted.

12 changes: 12 additions & 0 deletions _partials/clusters/aws/_aws-account-setup-validate.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
partial_category: clusters-aws-account-setup
partial_name: aws-account-setup-validate
---

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

2. From the left main menu, select **Tenant Settings**.

3. From the **Tenant Settings Menu**, select **Cloud Accounts**.

4. Verify that your AWS account appears in the **AWS** section.
40 changes: 40 additions & 0 deletions _partials/clusters/aws/_aws-dynamic-credentials-enablement-1.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
partial_category: clusters-aws-account-setup
partial_name: aws-dynamic-credentials-enablement-1
---

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

2. From the left main menu, select **Tenant Settings**.

3. From the **Tenant Settings Menu**, select **Cloud Accounts**.

4. Locate the **AWS** section and select **Add AWS Account**.

5. Fill out the following information.

| **Palette Parameter** | **Description** |
| -------------------------- | --------------------------------------------------------------------------------------------------- |
| **Account Name** | Enter a custom account name. The account name must be unique within the tenant scope. |
| **Description (Optional)** | Enter a description for the cloud account. |
| **Partition** | Select **{props.partition}**. |
| **STS** | Select **STS** to authenticate your AWS account using STS credentials and reveal the **ARN** field. |

6. When you select **STS**, the right side of the wizard populates with details on how to create an IAM role for
Palette. Log in to your AWS account and begin the IAM role creation process by navigating to **IAM > Roles > Create
role**. The following table expands on the information provided by the wizard.

| **AWS Parameter** | **Description** |
| ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Trusted entity type** | Select **AWS account**. In the **An AWS account** section, select **Another AWS account**. |
| **Account ID** | Copy the **Account ID** displayed on the Palette wizard. If using a self-hosted instance, this is the same AWS account that you configured for your Palette or VerteX instance to enable STS. Refer to the appropriate [Enable Adding AWS Accounts Using STS - Palette](/enterprise-version/system-management/configure-aws-sts-account/) or [Enable Adding AWS Accounts Using STS - VerteX](/vertex/system-management/configure-aws-sts-account/) guide for more information. |
| **Require external ID** | In the **An AWS account** section, below **Options**, select **Require External ID**. |
| **External ID** | Copy the **External ID** displayed on the Palette wizard. This ID is generated by Palette or VerteX and is different for each tenant. |
| **Permissions policies** | Search for and select the [required IAM policies](/clusters/public-cloud/aws/required-iam-policies/): **PaletteControllerPolicy**, **PaletteControlPlanePolicy**, **PaletteDeploymentPolicy**, and **PaletteNodesPolicy**. If deploying EKS clusters, add the **PaletteControllersEKSPolicy** as well. |
| **Role name** | In the **Role details** section, enter `SpectroCloudRole` for the **Role name**. |

7. Your new role appears in the **Roles** list. Locate and select the new role. In the **Summary** section, copy the
Amazon Resource Name (**ARN**) for the role.

8. In Palette, paste the role ARN into the **ARN** field.

17 changes: 17 additions & 0 deletions _partials/clusters/aws/_aws-dynamic-credentials-prerequisites.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
partial_category: clusters-aws-account-setup
partial_name: aws-dynamic-credentials-prerequisites
---

- A Palette account with [tenant admin](/tenant-settings/) access.

- An AWS account with the [required IAM policies](/clusters/public-cloud/aws/required-iam-policies/).

- The ability to create an [IAM role](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user.html)
that Palette can assume using STS. You will create the role while adding your AWS account to Palette.

- (Self-hosted Palette and Palette VerteX only) By default, adding AWS accounts using STS is disabled in self-hosted
Palette and Palette VerteX. To allow tenants to add AWS accounts using STS, refer to the appropriate
[Enable Adding AWS Accounts Using STS - Palette](/enterprise-version/system-management/configure-aws-sts-account/)
or [Enable Adding AWS Accounts Using STS - VerteX](/vertex/system-management/configure-aws-sts-account/)
guide.
24 changes: 24 additions & 0 deletions _partials/clusters/aws/_aws-static-credentials-enablement-1.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
partial_category: clusters-aws-account-setup
partial_name: aws-static-credentials-enablement-1
---

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

2. From the left main menu, select **Tenant Settings**.

3. From the **Tenant Settings Menu**, select **Cloud Accounts**.

4. Locate the **AWS** section and select **Add AWS Account**.

5. Fill out the following information.

| **Parameter** | **Description** |
| --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **Account Name** | Enter a custom account name. The account name must be unique within the tenant scope. |
| **Description (Optional)** | Enter a description for the cloud account. |
| **Partition** | Select **{props.partition}**. |
| **Credentials** | Select **Credentials** to authenticate your AWS account using static access credentials and reveal the fields **Access key** and **Secret access key**. |
| **Access key** | Enter your IAM user's access key. This is found in the **Summary** section of your AWS **IAM > Users** dashboard. Refer to [Manage access keys for IAM users](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html) for more information on access keys. |
| **Secret access key** | Enter your IAM user's secret access key that corresponds to the **Access key**. This key cannot be viewed or regenerated after the initial creation of your **Access key**. If you cannot retrieve your secret access key, you must create a new access key pair. |

Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
partial_category: clusters-aws-account-setup
partial_name: aws-static-credentials-prerequisites
---

- A {props.edition} account with [tenant admin](/tenant-settings/) access.

- An AWS account with an [IAM user](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_create.html) for {props.edition}.
The IAM user must be assigned the [required IAM policies](/clusters/public-cloud/aws/required-iam-policies/).
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
partial_category: clusters-aws-account-setup
partial_name: aws-static-dynamic-credentials-enablement-2
---

Select **Validate** to verify your AWS credentials. A green check mark indicates valid credentials. You cannot add your AWS account to Palette until you verify your credentials.

<li>Once your credentials are verified, the **Add IAM Policies** toggle is displayed. Toggle **Add IAM Policies** on and use the **Policies** drop-down menu to select any desired IAM policies you want to assign to the Palette IAM user. </li>

<li>To deploy clusters to your AWS cloud through a [Private Cloud Gateway (PCG)](/clusters/pcg/architecture/), toggle **Connect Private Cloud Gateway** on and select a **Private Cloud Gateway** from the drop-down menu. The PCG must be deployed and registered with {props.edition} at **Tenant Settings > Private Cloud Gateway** in order to select it. </li>

<li>Select **Confirm** to add your AWS account to Palette.</li>

Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
partial_category: eks-pod-identity
partial_name: eks-pod-identity-enablement
---

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

2. From the left main menu, select **Tenant Settings**.

3. From the **Tenant Settings Menu**, select **Cloud Accounts**.

4. Locate the **AWS** section and select **Add AWS Account**.

5. Fill out the following information.

| **Palette Parameter** | **Description** |
| -------------------------- | --------------------------------------------------------------------------------------------------- |
| **Account Name** | Enter a custom account name. The account name must be unique within the tenant scope. |
| **Description (Optional)** | Enter a description for the cloud account. |
| **Partition** | Select **{props.partition}**. |
| **EKS Pod Identity** | Select **EKS Pod Identity** to authenticate your AWS account using the EKS Pod Identity method and reveal the **ARN** field. |

6. In the AWS console, navigate to **IAM > Roles**, and select the new IAM role created for Palette (for example,`SpectroCloudRole`). In the **Summary** section, copy the Amazon Resource Name (**ARN**) for the role.

7. In Palette, paste the role ARN into the **ARN** field.

8. Select **Validate** to verify your AWS credentials. A green check mark indicates valid credentials. You cannot add your AWS account to Palette until you verify your credentials.

The **Add IAM Policies** option appears after successful validation. Leave this blank, as the required IAM policies have already been assigned to the IAM role created for Palette (for
example, `SpectroCloudRole`).

9. (Optional) To set a
[permission boundary](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html), toggle
**Add Permission Boundary** on and provide the ARN of a IAM policy or role in the **Permission Boundary ARN**
field.

10. Select Confirm to add your AWS account to Palette.
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,22 @@ partial_category: eks-pod-identity
partial_name: eks-pod-identity-validate
---

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

2. From the left main menu, click on **Tenant Settings**.
2. From the left main menu, select **Tenant Settings**.

3. Ensure **Cloud Accounts** is selected. Your newly added AWS cloud account is listed under the AWS section.
3. From the **Tenant Settings Menu**, select **Cloud Accounts**.

4. Open a terminal session and ensure you have access to the kubeconfig file for the Amazon EKS cluster where Palette or
4. Verify that your AWS account appears in the **AWS** section.

5. Open a terminal session and ensure you have access to the kubeconfig file for the Amazon EKS cluster where Palette or
Palette VerteX is deployed. Set the `KUBECONFIG` environment variable to point to the file.

```bash
export KUBECONFIG=/path/to/kubeconfig/file
```

5. Issue the following `kubectl` commands to verify that EKS Pod Identity has set the required environment variables for the `spectro-hubble`
6. Issue the following `kubectl` commands to verify that EKS Pod Identity has set the required environment variables for the `spectro-hubble`
and `palette-identity` pods.

```bash
Expand Down
35 changes: 0 additions & 35 deletions _partials/eks-pod-identity/_eks-pod-identity-enablement.mdx

This file was deleted.

Loading
Loading