From 41962d761f68c09a565fc9d041cecb56ab83a824 Mon Sep 17 00:00:00 2001 From: Lenny Chen <55669665+lennessyy@users.noreply.github.com> Date: Fri, 20 Dec 2024 14:48:14 -0800 Subject: [PATCH] docs: aws sts creds (#5135) * docs: create partial * docs: fix gitleak * docs: DOC-1528 (#5084) * docs: slack notification for release to production (gh-action) (#5083) * docs: slack notif draft for release gh-action * docs: amend slack notif description * docs: add slack notification for all jobs in release * docs: try ubuntu as runs-on * docs: set runs-on tags back * docs: fix URL formatting for slack notif * docs: remove test failure step * docs: add current step failure logic * docs: fix indentation * docs: add some step failures * docs: remove force failure * Apply suggestions from code review Co-authored-by: Karl Cardenas <29551334+karl-cardenas-coding@users.noreply.github.com> --------- Co-authored-by: Karl Cardenas <29551334+karl-cardenas-coding@users.noreply.github.com> * docs: add backlinks * docs: copy edits * docs: copy edit * Apply suggestions from code review Co-authored-by: Adelina Simion <43963729+addetz@users.noreply.github.com> * ci: auto-formatting prettier issues * docs: DOC-1518: Getting Started cleanup (#5042) * Initial Getting Started cleanup * Updates to Deploy Cluster Profile page * Minor parallel fix and package.json output update for deploy custom add-on pack tutorial * Updates to scale cluster section * Copying certain AWS changes over to other provider tutorials * Updated filter image for Azure clusters * ci: auto-formatting prettier issues * Optimised images with calibre/image-actions * Fixed ableism with see * ci: auto-formatting prettier issues --------- Co-authored-by: achuribooks Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com> * chore: upgrade docusaurus-theme-openapi-docs plugin (#5111) * chore: upgrade docusaurus-theme-openapi-docs plugin * docs: trigger visual tests * docs: DOC-1529: Add PCP-3592 to release notes (#5103) * Add PCP-3592 to release notes * Minor correction * docs: address feedback * Update _partials/self-hosted/_aws-sts-config.mdx Co-authored-by: Karl Cardenas <29551334+karl-cardenas-coding@users.noreply.github.com> --------- Co-authored-by: Karl Cardenas <29551334+karl-cardenas-coding@users.noreply.github.com> Co-authored-by: Ben Radstone <56587332+benradstone@users.noreply.github.com> Co-authored-by: Adelina Simion <43963729+addetz@users.noreply.github.com> Co-authored-by: lennessyy Co-authored-by: Amanda Churi Filanowski Co-authored-by: achuribooks Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com> Co-authored-by: caroldelwing (cherry picked from commit afa1341d93bc55252633136d630cd258b9352538) --- _partials/self-hosted/_aws-sts-config.mdx | 29 +++++++++++++++++------ 1 file changed, 22 insertions(+), 7 deletions(-) diff --git a/_partials/self-hosted/_aws-sts-config.mdx b/_partials/self-hosted/_aws-sts-config.mdx index 763cf5f8c1..a77d974d40 100644 --- a/_partials/self-hosted/_aws-sts-config.mdx +++ b/_partials/self-hosted/_aws-sts-config.mdx @@ -85,12 +85,27 @@ to deploy clusters in AWS using STS. Without this configuration, the STS option ## Validate -Issue the following command to make an API call that confirms that the credentials were configured successfully. +1. Open a terminal session. -```bash -curl --request POST \ - --url https:///v1/system/config/aws/account \ - --header 'Authorization: $TOKEN' -``` +2. Log in to the {props.edition} System API by using the `/v1/auth/syslogin` endpoint. + Use the curl command below and replace the `example.com` placeholder URL with the URL of your {props.edition} instance. + Ensure you replace the credentials below with your system console credentials. + + ```shell + TOKEN=$(curl --insecure --location 'https://example.com/v1/auth/syslogin' \ + --header 'Content-Type: application/json' \ + --data '{ + "password": "**********", + "username": "**********" + }') + +2. Issue the following command to make an API call that confirms that the credentials were configured successfully. + + ```shell + curl --request GET \ + --url https:///v1/system/config/aws/account \ + --header 'Authorization: $TOKEN' + ``` + + If you receive a response that contains the payload you configured, the configuration was successful. -If you receive a response that contains the payload you configured, the configuration was successful.