From 9af2a3776a405e55645d13499406fc769c30e8b9 Mon Sep 17 00:00:00 2001 From: Lenny Chen Date: Wed, 18 Dec 2024 14:55:18 -0800 Subject: [PATCH] docs: create partial --- _partials/self-hosted/_aws-sts-config.mdx | 99 +++++++++++++++++++ .../configure-aws-sts-account.md | 14 +++ 2 files changed, 113 insertions(+) create mode 100644 _partials/self-hosted/_aws-sts-config.mdx create mode 100644 docs/docs-content/enterprise-version/system-management/configure-aws-sts-account.md diff --git a/_partials/self-hosted/_aws-sts-config.mdx b/_partials/self-hosted/_aws-sts-config.mdx new file mode 100644 index 0000000000..5407e416ea --- /dev/null +++ b/_partials/self-hosted/_aws-sts-config.mdx @@ -0,0 +1,99 @@ +--- +partial_category: self-hosted +partial_name: sts-config +--- + +{props.edition} allows tenants to use AWS Secret Token Service (STS) to add an AWS cloud accounts to their {props.edition} environment. +In order to do this, {props.edition} relies on a system-level AWS cloud account that is configured on the {props.edition} instance +to assume a custom role created on the tenant's AWS account. + +This custom role establishes a trust relationship between the tenant's AWS account and the system-level AWS account bound to the {props.edition} instance. +It allows the system-level AWS account to receive temporary credentials from the tenant's AWS account to deploy infrastructure in AWS using STS. +For more information on how to add an AWS cloud account using STS, refer to the guide. + +You must configure your {props.edition} instance with the system-level AWS account before your tenants can add AWS cloud accounts +to deploy clusters in AWS using STS. Without this configuration, the STS option will be greyed out when your tenants try to add an AWS account. + +## Prerequisites + +- Access to the {props.edition} system console. + +- The role of Root Administrator or Account Administrator. + +- An AWS IAM user that is allowed to assume cross-account IAM roles. + +## Configure System-Level AWS account + +1. Log in to the system console using the `/v1/auth/syslogin` endpoint and retrieve the authorization JWT token. + + ```shell + curl --insecure --location 'https://palette.domain.example/v1/auth/syslogin' \ + --header 'Content-Type: application/json' \ + --data '{ + "password": "**********", + "username": "**********" + }' + ``` + + Replace the username and password fields with the username and password of your system console user. A successful request will return a JWT token. + + ```json + { + "Authorization": "eyJhmp3dFRva2VuIiwiU2Vzc2l...BrRiM23aWxA19f4Lldm-nO_SH3VR4QAEfQ", + "IsEmailSet": true, + "IsEmailVerified": false, + "IsMfa": false, + "IsPasswordReset": true + } + ``` + +2. Issue the following commend to invoke the {props.edition} API to configure the system-level AWS account. + + + + + + ```bash + curl --request POST \ + --url https:///v1/system/config/aws/account \ + --header 'Authorization: *******' \ + --data '{ + "accessKey": "**********", + "secretKey": "**********", + "accountId": "123456789" + }' + ``` + + + + + + ```bash + curl --request POST \ + --url https:///v1/system/config/awsgov/sts/account \ + --header 'Authorization: *******' \ + --data '{ + "accessKey": "**********", + "secretKey": "**********", + "accountId": "123456789" + }' + ``` + + + + + + Replace the `accessKey`, `secretKey`, and `accountId` fields with the AWS access key, secret key, and account ID of your AWS account. + + +## Validate + +Issue the following command to make an API call that confirms that the credentials were configured successfully. + +```bash +curl --request POST \ + --url https:///v1/system/config/aws/account \ + --header 'Authorization: *******' +``` + +If you receive a response that contains the `accessKey`, `secretKey`, and `accountId` fields you configured, the configuration was successful. diff --git a/docs/docs-content/enterprise-version/system-management/configure-aws-sts-account.md b/docs/docs-content/enterprise-version/system-management/configure-aws-sts-account.md new file mode 100644 index 0000000000..096750b8db --- /dev/null +++ b/docs/docs-content/enterprise-version/system-management/configure-aws-sts-account.md @@ -0,0 +1,14 @@ +--- +sidebar_label: "Enable Adding AWS Accounts Using STS " +title: "Enable Adding AWS Accounts Using STS " +description: "This page teaches you how to allow tenants to add AWS accounts using STS." +icon: "" +hide_table_of_contents: false +sidebar_position: 20 +tags: ["palette", "management", "account", "credentials"] +keywords: ["self-hosted", "palette"] +--- + +import StsConfig from "../../../../_partials/self-hosted/_aws-sts-config.mdx"; + +