Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

EKS user journey #1715

Merged
merged 31 commits into from
Nov 8, 2023
Merged

EKS user journey #1715

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
1058b13
Revise steps
ritawatson Oct 27, 2023
409c9a7
Fixed tables
ritawatson Oct 30, 2023
7f48f31
Clean up steps, improve flow
ritawatson Oct 30, 2023
f106bb2
Add info based on prototype.
ritawatson Oct 30, 2023
59b230d
Verify steps, add resources
ritawatson Oct 31, 2023
97aeb89
Several small changes
ritawatson Oct 31, 2023
e28de57
Add links to existing OIDC documentation
ritawatson Oct 31, 2023
9a8fba1
Add links to other docs
ritawatson Nov 1, 2023
0bae33a
Last changes from final workflow walkthrough
ritawatson Nov 1, 2023
06bd761
Updates for internal style, grammar: add aws acct
ritawatson Nov 1, 2023
f32a937
Merge branch 'master' into user-journey-cleanup-eks-first-cluster
ritawatson Nov 1, 2023
626c2a6
Fix repeated 'the'
ritawatson Nov 1, 2023
1259567
Vale fixes
ritawatson Nov 1, 2023
8954d43
Incorporate first comments
ritawatson Nov 1, 2023
09756d7
Revise info block, add link
ritawatson Nov 1, 2023
ea289f8
Added review comments
ritawatson Nov 3, 2023
88d6751
Fix typo in policy name
ritawatson Nov 3, 2023
42c1545
Revised KMS key creation section
ritawatson Nov 4, 2023
166aac2
Merge branch 'master' into user-journey-cleanup-eks-first-cluster
ritawatson Nov 4, 2023
64369d0
Apply suggestions from code review
ritawatson Nov 6, 2023
cd858a9
Apply suggestions from code review
ritawatson Nov 6, 2023
61e5463
Incorporate review comments for KMS key
ritawatson Nov 6, 2023
6dbe303
Fix typo
ritawatson Nov 6, 2023
0c01a03
Create new page for KMS key
ritawatson Nov 7, 2023
bf6f844
Add Access EKS Cluster section
ritawatson Nov 7, 2023
f2d8e03
Minor change to Access EKS Cluster
ritawatson Nov 7, 2023
c55dc72
Replace kubelogin prereq w. aws-iam-authenticator
ritawatson Nov 7, 2023
f992abb
Revised Access EKS Cluster, step 9, prereqs
ritawatson Nov 8, 2023
92960ba
Merge branch 'master' of github.com:spectrocloud/librarium into user-…
karl-cardenas-coding Nov 8, 2023
9148df8
docs: updates and clarifications
karl-cardenas-coding Nov 8, 2023
995655b
Fix typo
ritawatson Nov 8, 2023
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
106 changes: 60 additions & 46 deletions docs/docs-content/clusters/public-cloud/aws/add-aws-accounts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,17 +21,17 @@ Palette supports integration with AWS Cloud Accounts. This also includes support

## AWS Account

<br />
This section provides guidance in creating an AWS account that uses static or dynamic access credentials.

### Static Access Credentials

To add an AWS cloud account using static access credentials follow these steps:
Use the steps below to add an AWS cloud account using static access credentials.

#### Prerequisites

- An AWS account
- Sufficient access to create an IAM role or IAM user.
- Palette IAM policies. Please review the [Required IAM Policies](required-iam-policies.md) section for guidance.
- Palette IAM policies. Review the [Required IAM Policies](required-iam-policies.md) section for guidance.


#### Add AWS Account to Palette
Expand All @@ -40,95 +40,101 @@ To add an AWS cloud account using static access credentials follow these steps:
- [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 role or the IAM user that Palette will use.
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.
3. Log in to [Palette](https://console.spectrocloud.com) as tenant admin.


4. Go to **Tenant Settings** > **Cloud Accounts** and click **+Add AWS Account**.
4. From the left **Main Menu**, click on **Tenant Settings**.


5. In the cloud account creation wizard provide the following information:
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.
* **Partition:** Choose **AWS** from the **drop-down Menu**.

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


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

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

8. A drop-down menu displays a lists of available AWS IAM policies in your AWS account. Select any desired IAM policies you want to assign to Palette IAM role or IAM user.
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.


#### Validate

You can validate the account is available in Palette by reviewing the list of cloud accounts. To review the list of cloud accounts navigate to the left **Main Menu**. Click on **Tenant Settings**. Next, click on **Cloud Accounts**. Your newly added AWS cloud account is listed under the AWS sections.
You can validate the account is available in Palette by reviewing the list of cloud accounts. To review the list of cloud accounts, navigate to the left **Main Menu** and click on **Tenant Settings**. Next, click on **Cloud Accounts**. Your newly added AWS cloud account is listed under the AWS section.



### Dynamic Access Credentials

To add an AWS cloud account using STS credentials follow the steps below:
Use the steps below to add an AWS cloud account using Security Token Service (STS) credentials.

#### Prerequisites

- An AWS account
- An AWS account.
- Sufficient access to create an IAM role or IAM user.
- Palette IAM policies. Please review the [Required IAM Policies](required-iam-policies.md) section for guidance.
- Palette IAM policies. Review the [Required IAM Policies](required-iam-policies.md) section for guidance.


#### Add AWS Account to Palette

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


2. Go to **Tenant Settings** > **Cloud Accounts** and click **+Add AWS Account**.
2. From the left **Main Menu**, click on **Tenant Settings**.


3. In the cloud account creation wizard give the following information:
* **Account Name**
* **Description**
* Select **STS** authentication for validation:
3. Select **Cloud Accounts**, and click **+Add AWS Account**.


4. In the cloud account creation wizard give the following information:
* **Account Name**: Custom name for the cloud account.
* **Description**: Optional description for the cloud account.
* Select **STS** authentication for validation.


4. You will be provided with information on the right hand-side of the wizard. You will need this information to create an IAM Role for Palette. The following table lists out the information provided by the wizard after your selects **STS**.
5. You will be provided with information on the right side of the wizard. You will need this information to create an IAM Role for Palette. The following table lists the information provided by the wizard after you select **STS**.

|**Parameter**|**Description**|
|---------|---------------|
|**Trusted Entity Type**| Another AWS account|
|**Account ID**|Copy the Account ID displayed on the UI|
|**Require External ID**| Enable|
|**External ID**|Copy the External ID displayed on the UI|
|**Permissions Policy**|Search and select the 4 policies added in step #2|
|**Permissions Policy**|Search and select the 4 policies added in step 2|
|**Role Name**|SpectroCloudRole|

5. In the AWS console, create a new IAM role for Palette. Use the following resources if you need additional help.
6. In the AWS console, create a new IAM role 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).


6. In the AWS console, assign the [Palette required IAM policies](required-iam-policies.md) to the role that Palette will use.
7. In the AWS console, assign the [Palette required IAM policies](required-iam-policies.md) to the role that Palette will use.


7. In the AWS console, browse to the **Role Details** page and copy the Amazon Resource Name (ARN) for the role.
8. In the AWS console, browse to the **Role Details** page and copy the Amazon Resource Name (ARN) for the role.


8. In Palette, paste the role ARN into the **ARN** input box.
9. In Palette, paste the role ARN into the **ARN** input box.


9. Click the **Validate** button to validate the credentials.
10. Click the **Validate** button to validate the credentials.


#### Validate

You can validate the account is available in Palette by reviewing the list of cloud accounts. To review the list of cloud accounts navigate to the left **Main Menu**. Click on **Tenant Settings**. Next, click on **Cloud Accounts**. Your newly added AWS cloud account is listed under the AWS sections.
You can validate the account is available in Palette by reviewing the list of cloud accounts. To review the list of cloud accounts navigate to the left **Main Menu**. Click on **Tenant Settings**. Next, click on **Cloud Accounts**. Your newly added AWS cloud account is listed under the AWS section.



Expand All @@ -137,11 +143,13 @@ You can validate the account is available in Palette by reviewing the list of cl

## AWS GovCloud Account

Palette supports integration with [AWS GovCloud (US)](https://aws.amazon.com/govcloud-us/?whats-new-ess.sort-by=item.additionalFields.postDateTime&whats-new-ess.sort-order=desc). Using Palette you can deploy Kubernetes clusters to your AWS GovCloud account. To get started with AWS GovCloud and Palette, use the following steps.
<br />
Palette supports integration with [AWS GovCloud (US)](https://aws.amazon.com/govcloud-us/?whats-new-ess.sort-by=item.additionalFields.postDateTime&whats-new-ess.sort-order=desc). Using Palette you can deploy Kubernetes clusters to your AWS GovCloud account. This section provides guidance in creating an AWS GovCloud account that uses static or dynamic access credentials.

### Static Access Credentials

Use the steps below to add an AWS cloud account using static access credentials.


#### Prerequisites

- An AWS account
Expand All @@ -161,10 +169,13 @@ Palette supports integration with [AWS GovCloud (US)](https://aws.amazon.com/gov
3. Log in to [Palette](https://console.spectrocloud.com) as Tenant admin.


4. Go to **Tenant Settings** > **Cloud Accounts** and click **+Add AWS Account**.
4. From the left **Main Menu**, click on **Tenant Settings**.


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


5. In the cloud account creation wizard provide the following information:
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.
Expand All @@ -175,20 +186,20 @@ Palette supports integration with [AWS GovCloud (US)](https://aws.amazon.com/gov
* AWS Secret access key


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

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

8. A drop-down menu displays a lists of available AWS IAM policies in your AWS account. Select any desired IAM policies you want to assign to Palette IAM role or IAM user.
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.


#### Validate

You can validate the account is available in Palette by reviewing the list of cloud accounts. To review the list of cloud accounts navigate to the left **Main Menu**. Click on **Tenant Settings**. Next, click **Cloud Accounts**. Your newly added AWS cloud account is listed under the AWS sections.
You can validate the account is available in Palette by reviewing the list of cloud accounts. To review the list of cloud accounts navigate to the left **Main Menu**. Click on **Tenant Settings**. Next, click **Cloud Accounts**. Your newly added AWS cloud account is listed under the AWS section.

### Dynamic Access Credentials

To add an AWS GovCloud cloud account using STS credentials follow the steps below:
Use the steps below to add an AWS cloud account using STS credentials.

#### Prerequisites

Expand All @@ -202,16 +213,19 @@ To add an AWS GovCloud cloud account using STS credentials follow the steps belo
1. Log in to [Palette](https://console.spectrocloud.com) as Tenant admin.


2. Go to **Tenant Settings** > **Cloud Accounts** and click **+Add AWS Account**.
2. From the left **Main Menu**, click on **Tenant Settings**.


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


3. In the cloud account creation wizard give the following information:
4. In the cloud account creation wizard give the following information:
* **Account Name**
* **Description**
* Select **STS** authentication for validation:


4. You will be provided with information on the right hand-side of the wizard. You will need this information to create an IAM Role for Palette. The following table lists out the information provided by the wizard after you selects **STS**.
5. You will be provided with information on the right side of the wizard. You will need this information to create an IAM Role for Palette. The following table lists the information provided by the wizard after you select **STS**.

|**Parameter**|**Description**|
|---------|---------------|
Expand All @@ -222,21 +236,21 @@ To add an AWS GovCloud cloud account using STS credentials follow the steps belo
|**Permissions Policy**|Search and select the 4 policies added in step #2|
|**Role Name**|SpectroCloudRole|

5. In the AWS console, create a new IAM role for Palette. Use the following resources if you need additional help.
6. In the AWS console, create a new IAM role 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).


6. In the AWS console, assign the [Palette required IAM policies](required-iam-policies.md) to the role that Palette will use.
7. In the AWS console, assign the [Palette required IAM policies](required-iam-policies.md) to the role that Palette will use.


7. In the AWS console, browse to the **Role Details** page and copy the Amazon Resource Name (ARN) for the role.
8. In the AWS console, browse to the **Role Details** page and copy the Amazon Resource Name (ARN) for the role.


8. In Palette, paste the role arn into the **ARN** input box.
9. In Palette, paste the role ARN into the **ARN** input box.


9. Click the **Validate** button to validate the credentials.
10. Click on the **Validate** button to validate the credentials.


#### Validate
Expand Down
Loading