Skip to content

Commit 63de9ff

Browse files
Shubham9t9Shubham9t9
andauthored
docs: updated aws external secret doc (#2781)
* updated adding aws external secret doc * Update secrets.md * restuctured eso secrets * Update aws-eso.md * restructured content * changed-generic-secret-image * updated summary.md * correction Co-authored-by: Shubham9t9 <[email protected]>
1 parent 7c83045 commit 63de9ff

File tree

4 files changed

+69
-28
lines changed

4 files changed

+69
-28
lines changed

docs/SUMMARY.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,9 @@
5959
* [CD Pipeline](user-guide/creating-application/workflow/cd-pipeline.md)
6060
* [Config Maps](user-guide/creating-application/config-maps.md)
6161
* [Secrets](user-guide/creating-application/secrets.md)
62+
* [External Secret Operator (ESO)](user-guide/creating-application/eso/README.md)
63+
* [AWS Secrets Manager](user-guide/creating-application/eso/aws-eso.md)
64+
6265
* [Environment Overrides](user-guide/creating-application/environment-overrides.md)
6366
* [Deleting Application](user-guide/deleting-application.md)
6467
* [Build and Deploy](user-guide/deploying-application/README.md)
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# External Secret Operator (ESO)
2+
3+
> **Prerequisites:** Chart version should be > 4.14.0
4+
5+
External Secrets Operator is a Kubernetes operator that integrates external secret management systems like AWS Secrets Manager, HashiCorp Vault, Google Secrets Manager, Azure Key Vault and many more. The operator reads information from external APIs and automatically injects the values into a Kubernetes Secret.
6+
7+
## Install External Secret Operator
8+
9+
Before creating any external secrets on Devtron, `External Secret Operator` must be installed on the target cluster. `External Secret Operator` allows you to use external secret management systems (e.g., AWS Secrets Manager, Hashicorp Vault, Azure Secrets Manager, Google Secrets Manager etc.) to securely inject secrets in Kubernetes.
10+
11+
You can install `External Secrets Operator` using charts store:
12+
13+
1. Go to charts store.
14+
2. Search chart with name `external-secrets`.
15+
16+
![External secrets chart](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/secrets/external-secret.png)
17+
18+
3. If you don't find any chart with this name i.e `external-secrets`, add chart repository using repository url ` https://charts.external-secrets.io`. Please follow this [documentation](https://docs.devtron.ai/getting-started/global-configurations/chart-repo#add-chart-repository) for adding chart repository.
19+
4. Deploy the chart.
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# AWS Secrets Manager
2+
3+
To add secrets from **AWS Secrets Manager**, we need to create a generic Kubernetes secret for AWS authentication.
4+
5+
Create a Kubernetes secret in the namespace in which the application is to be deployed using base64 encoded AWS access-key and secret-access-key. You can use devtron generic chart for this.
6+
7+
**Note:** You don't have to create the Kubernetes secret everytime you create External Secret for the respective namespace.
8+
9+
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/secrets/aws-secret-generic-chart.jpg)
10+
11+
After creating the generic secret, navigate to `Secrets` section of the application and follow the steps mentioned below :
12+
13+
1. Click `Add Secret` to add a new secret.
14+
15+
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/secrets/add-secrets.jpg)
16+
17+
2. Select `AWS Secret Manager` under `External Secret Operator` (ESO) from the dropdown of `Data type`.
18+
19+
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/secrets/aws-secret-manager-dropdown.jpg)
20+
21+
3. Configure secret:
22+
23+
| Key | Description |
24+
| :--- | :--- |
25+
| `region` | AWS region in which secret is created. |
26+
| `accessKeyIDSecretRef.name` | Name of secret created that would be used for authentication.|
27+
| `accessKeyIDSecretRef.key` | In generic secret created for AWS authentication, variable name in which base64 encoded AWS access-key is stored. |
28+
| `secretAccessKeySecretRef.name` | Name of secret created that would be used for authentication.|
29+
| `secretAccessKeySecretRef.key` | In generic secret created for AWS authentication, variable name in which base64 encoded secret-access-key is stored.|
30+
| `secretKey` | Variable name to store secret. |
31+
| `key` | AWS Secrets Manager secret name. |
32+
| `property` | AWS Secrets Manager secret key. |
33+
34+
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/secrets/aws-eso.jpg)
35+
36+
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/secrets/aws-external-secret.jpg)
37+
38+
39+
4. Save secret.

docs/user-guide/creating-application/secrets.md

Lines changed: 8 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Secret objects let you store and manage sensitive information, such as passwords
88

99
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/secrets/add-secret.jpg)
1010

11-
Click on `Add Secret` to add a new secret.
11+
Click `Add Secret` to add a new secret.
1212

1313

1414
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/secrets/creating-applications-secrets-2.jpg)
@@ -37,7 +37,7 @@ AWS Secret Manager, AWS System Manager and Hashi Corp Vault, for these cases `Na
3737
File permission will be provide at the configmap level not on the each key of the configmap. it will take 3 digit standard permission for the file.
3838

3939

40-
Click on `Save Secret` to save the secret.
40+
Click `Save Secret` to save the secret.
4141

4242
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/secrets/creating-applications-secrets-4.jpg)
4343

@@ -49,15 +49,15 @@ You can see the Secret is added.
4949

5050
You can update your secrets anytime later, but you cannot change the name of your secrets. If you want to change your name of secrets then you have to create a new secret.
5151

52-
To update secrets, click on the secret you wish to update.
52+
To update secrets, click the secret you wish to update.
5353

5454
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/secrets/creating-applications-secrets-6.jpg)
5555

56-
Click on `Update Secret` to update your secret.
56+
Click `Update Secret` to update your secret.
5757

5858
## Delete Secret
5959

60-
You can delete your secret. Click on your secret and click on the `delete sign` to delete your secret.
60+
You can delete your secret. Click your secret and click the `delete sign` to delete your secret.
6161

6262
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/secrets/creating-applications-secrets-7.jpg)
6363

@@ -77,32 +77,12 @@ There are five Data types that you can use to save your secret.
7777

7878
Use this option to mount an existing Kuberentes Secret in your application pods. A Secret will not be created by system so please ensure that the secret already exist within the namespace else the deployment will fail.
7979

80-
### External Secret Operator (ESO)
81-
82-
> **Prerequisites:** Chart version should be > 4.14.0
83-
84-
External Secrets Operator is a Kubernetes operator that integrates external secret management systems like AWS Secrets Manager, HashiCorp Vault, Google Secrets Manager, Azure Key Vault and many more. The operator reads information from external APIs and automatically injects the values into a Kubernetes Secret.
85-
86-
#### AWS Secret Manager
87-
88-
Before creating any external secrets on Devtron, `External Secret Operator` must be installed on the target cluster. `External Secret Operator` allows you to use external secret management systems (e.g., AWS Secrets Manager, Hashicorp Vault, Azure Secrets Manager, Google Secrets Manager etc.) to securely inject secrets in Kubernetes.
89-
90-
You can install `External Secrets Operator` using charts store:
91-
92-
1. Go to charts store.
93-
2. Search chart with name `external-secrets`.
94-
95-
![External secrets chart](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/secrets/external-secret.png)
96-
97-
3. If you don't find any chart with this name i.e `external-secrets`, add chart repository using repository url ` https://charts.external-secrets.io`. Please follow this [documentation](https://docs.devtron.ai/getting-started/global-configurations/chart-repo#add-chart-repository) for adding chart repository.
98-
4. Deploy the chart.
99-
10080
### Kubernetes External Secret (Deprecated)
10181

10282
The secret that is already created and stored in the environment and being used by Devtron externally is referred here as `Kubernetes External Secret`. For this option, Devtron will not create any secret by itself but they can be used within the pods. Before adding secret from kubernetes external secret, please make sure that secret with the same name is present in the environment. To add secret from kubernetes external secret, follow the steps mentioned below:
10383

10484
1. Navigate to `Secrets` of the application.
105-
2. Click on `Add Secret` to add a new secret.
85+
2. Click `Add Secret` to add a new secret.
10686
3. Select `Kubernetes External Secret` from dropdown of `Data type`.
10787
4. Provide a name to your secret. Devtron will search secret in the environment with the same name that you mention here.
10888

@@ -128,7 +108,7 @@ To add secrets from AWS secret manager, navigate to `Secrets` of the application
128108

129109
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/secrets/creating-applications-secrets-8.jpg)
130110

131-
1. Click on `Add Secret` to add a new secret.
111+
1. Click `Add Secret` to add a new secret.
132112

133113
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/secrets/aws-secret.png)
134114

@@ -154,7 +134,7 @@ All the required field to pass your data to fetch secrets on Devtron are describ
154134
To add secrets in AWS secret manager, do the following steps :
155135

156136
1. Go to AWS secret manager console.
157-
2. Click on `Store a new secret`.
137+
2. Click `Store a new secret`.
158138
3. Add and save your secret.
159139

160140
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/secrets/creating-applications-secrets-10.jpg)

0 commit comments

Comments
 (0)