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

Jump to bottom

docs: specify the process to provide an application secret via AWS Secrets Manager #2744

Merged
merged 3 commits into from
May 10, 2024
Merged

docs: specify the process to provide an application secret via AWS Secrets Manager #2744

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b13b34d
docs: specify the process to provide an application secret via AWS Se…
giorgiosironi May 9, 2024
529d80f
docs: add relevant operator to the list of provided services sciety/s…
giorgiosironi May 9, 2024
1f1af6b
docs: list examples of secrets consumption sciety/sciety#3230
giorgiosironi May 9, 2024
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
16 changes: 16 additions & 0 deletions docs/guide-for-application-teams.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Dashboards
- [Grafana Dashboards](https://grafana.elifesciences.org/dashboards)
- [Prometheus (Metrics)](https://prometheus.elifesciences.org)
- [Alertmanager](https://alertmanager.elifesciences.org)
- [AWS console for the `512686554592` account](https://512686554592.signin.aws.amazon.com/)

The __#cluster-alerts__ slack channel receives alerts from:

Expand All @@ -34,6 +35,19 @@ Adding Helm Charts
- Setup an [`ImageUpdateAutomation`](https://fluxcd.io/docs/components/image/imageupdateautomations/) to describe which `GitRepository` object you want flux to update, and which directory
- Add a [policy marker](https://fluxcd.io/docs/guides/image-update/#configure-image-update-for-custom-resources) to tell Flux how to update te yaml files

Provide a secret to an application
----------------------------------

### Via AWS Secrets Manager

1. Store the secret in [AWS Secrets Manager](https://us-east-1.console.aws.amazon.com/secretsmanager/listsecrets?region=us-east-1) under a team-based prefix such as `sciety-team/*`.
1. Create an [`ExternalSecret`](https://external-secrets.io/latest/api/spec/#external-secrets.io/v1beta1.ExternalSecret) manifest to pull the secret into the cluster, in the form of a Kubernetes [`Secret`](https://kubernetes.io/docs/concepts/configuration/secret/) managed by the platform.

Kubernetes resources can use the secret:

- directly in workloads e.g. via an [environment variable](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#environment-variables)
- by receiving its value as an [Helm release value](https://fluxcd.io/flux/components/helm/helmreleases/#values-references)

Services available on the Cluster
=================================

Expand All @@ -45,6 +59,8 @@ Services available on the Cluster
- __PrometheusOperator__ ([docs/monitoring-alerting](docs/monitoring-alerting.md))
- __oauth2-proxy__ ([docs/oauth-proxy](docs/oauth-proxy.md))
- limit access to elifesciences github org
- __ExternalSecrets Operator__
- pulls in secrets from storage easily accessible to the application teams
- __SealedSecrets__ ([docs/sealed-secrets.md](docs/sealed-secrets.md))
- encrypt secrets for safe storage in this repo
- __Loki__
Expand Down