Skip to content

Commit 9990ffb

Browse files
jul-danjul-dan
authored
Merge pull request #540 from Qovery/feat/add_sts_credentials_doc
Add assume role via STS authentication type
2 parents b072884 + 975c10e commit 9990ffb

File tree

2 files changed

+99
-1
lines changed

2 files changed

+99
-1
lines changed

‎website/docs/getting-started/install-qovery/aws/cluster-managed-by-qovery/create-credentials.md

Lines changed: 52 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
---
2-
last_modified_on: "2025-03-06"
2+
last_modified_on: "2025-03-31"
33
title: "Create Credentials"
44
description: "Generate AWS credentials for Qovery"
55
---
6+
7+
import Tabs from '@theme/Tabs';
8+
import TabItem from '@theme/TabItem';
9+
610
import Steps from '@site/src/components/Steps';
711
import Alert from '@site/src/components/Alert';
812
import Assumptions from '@site/src/components/Assumptions';
@@ -25,6 +29,50 @@ This guide will help you to create your Amazon Web Services (AWS) credentials fo
2529

2630
## Generate AWS credentials
2731

32+
We support two authentication methods for AWS: Assume Role via STS and Static Credentials (Access Key & Secret Access Key).
33+
34+
For security reasons, we strongly recommend using Assume Role via STS. Static credentials are long-lived and more exposed to leaks, while Assume Role provides short-lived, automatically refreshed credentials with granular access control, reducing security risks.
35+
36+
<Tabs
37+
centered={true}
38+
className={"rounded"}
39+
defaultValue={"Assume role via STS (preferred)"}
40+
placeholder="Select your credentials"
41+
select={false}
42+
size={null}
43+
values={[{"group":"Credentials","label":"Assume role via STS (preferred)","value":"Assume role via STS (preferred)"},{"group":"Credentials","label":"Static credentials","value":"Static credentials"}]}>
44+
45+
<TabItem value="Assume role via STS (preferred)">
46+
47+
<Steps headingDepth={3}>
48+
<ol>
49+
50+
<li>
51+
52+
[Connect to your AWS console](https://console.aws.amazon.com). Make sure you are connected to the right AWS account.
53+
54+
</li>
55+
56+
<li>
57+
58+
Execute the following [Cloudformation stack](https://console.aws.amazon.com/cloudformation/home?#/stacks/quickcreate?templateURL=https%3A%2F%2Fs3.amazonaws.com%2Fcloudformation-qovery-role-creation%2Ftemplate.json&stackName=qovery-role-creation
59+
) and retrieve the role ARN from the `Outputs`section.
60+
61+
It will create a role for Qovery and grant assume role permissions.
62+
63+
</li>
64+
65+
<li>
66+
67+
Insert the role ARN in Qovery and provide a credentials name to identify this role.
68+
69+
</li>
70+
</ol>
71+
</Steps>
72+
</TabItem>
73+
74+
<TabItem value="Static credentials">
75+
2876
<Steps headingDepth={3}>
2977
<ol>
3078

@@ -163,6 +211,9 @@ You can now save the `access key id` and `secret access key`
163211
</Steps>
164212

165213
Well done!! You now have your AWS `access key id` and `secret access key` and your permissions are setups; It is time to connect Qovery to your AWS account.
214+
</TabItem>
215+
</Tabs>
216+
166217

167218
### Install a new cluster on Qovery
168219

‎website/docs/getting-started/install-qovery/aws/cluster-managed-by-qovery/create-credentials.md.erb

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,50 @@ This guide will help you to create your Amazon Web Services (AWS) credentials fo
1616

1717
## Generate AWS credentials
1818

19+
We support two authentication methods for AWS: Assume Role via STS and Static Credentials (Access Key & Secret Access Key).
20+
21+
For security reasons, we strongly recommend using Assume Role via STS. Static credentials are long-lived and more exposed to leaks, while Assume Role provides short-lived, automatically refreshed credentials with granular access control, reducing security risks.
22+
23+
<Tabs
24+
centered={true}
25+
className={"rounded"}
26+
defaultValue={"Assume role via STS (preferred)"}
27+
placeholder="Select your credentials"
28+
select={false}
29+
size={null}
30+
values={[{"group":"Credentials","label":"Assume role via STS (preferred)","value":"Assume role via STS (preferred)"},{"group":"Credentials","label":"Static credentials","value":"Static credentials"}]}>
31+
32+
<TabItem value="Assume role via STS (preferred)">
33+
34+
<Steps headingDepth={3}>
35+
<ol>
36+
37+
<li>
38+
39+
[Connect to your AWS console](https://console.aws.amazon.com). Make sure you are connected to the right AWS account.
40+
41+
</li>
42+
43+
<li>
44+
45+
Execute the following [Cloudformation stack](https://console.aws.amazon.com/cloudformation/home?#/stacks/quickcreate?templateURL=https%3A%2F%2Fs3.amazonaws.com%2Fcloudformation-qovery-role-creation%2Ftemplate.json&stackName=qovery-role-creation
46+
) and retrieve the role ARN from the `Outputs`section.
47+
48+
It will create a role for Qovery and grant assume role permissions.
49+
50+
</li>
51+
52+
<li>
53+
54+
Insert the role ARN in Qovery and provide a credentials name to identify this role.
55+
56+
</li>
57+
</ol>
58+
</Steps>
59+
</TabItem>
60+
61+
<TabItem value="Static credentials">
62+
1963
<Steps headingDepth={3}>
2064
<ol>
2165

@@ -154,6 +198,9 @@ You can now save the `access key id` and `secret access key`
154198
</Steps>
155199

156200
Well done!! You now have your AWS `access key id` and `secret access key` and your permissions are setups; It is time to connect Qovery to your AWS account.
201+
</TabItem>
202+
</Tabs>
203+
157204

158205
### Install a new cluster on Qovery
159206

0 commit comments

Comments
 (0)