Skip to content

Commit

Permalink
fix symlinks
Browse files Browse the repository at this point in the history
  • Loading branch information
DerTiedemann committed Nov 6, 2024
1 parent 0f947d0 commit de61ae6
Show file tree
Hide file tree
Showing 4 changed files with 109 additions and 109 deletions.
56 changes: 0 additions & 56 deletions actions/gcp-gsm-load-secrets/README.md

This file was deleted.

1 change: 1 addition & 0 deletions actions/gcp-gsm-load-secrets/README.md
51 changes: 0 additions & 51 deletions actions/gcp-gsm-parse-secrets/README.md

This file was deleted.

1 change: 1 addition & 0 deletions actions/gcp-gsm-parse-secrets/README.md
1 change: 0 additions & 1 deletion docs/actions/gcp-gsm-load-secrets/README.md

This file was deleted.

56 changes: 56 additions & 0 deletions docs/actions/gcp-gsm-load-secrets/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# gcp-gsm-load-secrets

This action is set to replace GitHub actions integrated secret management.

## Usage

To load a secret from GSM figure out the following:

- check if the repository has access to the secret
- repository is owned by bakdata
- repository is private
- even if the labels are correctly set, you will need to run Terraform to set the proper roles
- use this template:

```yaml
- name: Load secrets
id: load-secrets
uses: bakdata/ci-templates/actions/gcp-gsm-load-secrets
with:
gke-project-name: <can be found from gcp console>
gke-project-id: <can be found from gcp console>
secrets-to-inject: |-
<secret_name>/<optional version, if not set the latest version is loaded>
<other_secret>/<optional version, if not set the latest version is loaded>
```
- it is possible to load multiple secrets in the same call
- loaded secrets will be injected as environment variables and the name will be cannonicalized to SCREAMING_SNAKE_CASE. Example: `i-like_trains__why_this?` -> `I_LIKE_TRAINS_WHY_THIS`

## References

### Inputs

<!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->

| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
| -------------------------- | ------ | -------- | -------- | --------------------------------------------- |
| export-to-environment | string | false | `"true"` | Export secrets to environment |
| gke-project-name | string | true | | GKE project name for authentication |
| gke-service-account | string | true | | GKE service account for authentication |
| secrets-to-inject | string | true | | Secrets to inject into the environment |
| workload-identity-provider | string | true | | Workload identity provider for authentication |

<!-- AUTO-DOC-INPUT:END -->

### Outputs

<!-- AUTO-DOC-OUTPUT:START - Do not remove or modify this section -->

| OUTPUT | TYPE | DESCRIPTION |
| ------- | ------ | ---------------------------------- |
| secrets | string | Secrets loaded from Secret Manager |

<!-- AUTO-DOC-OUTPUT:END -->

### Secrets
1 change: 0 additions & 1 deletion docs/actions/gcp-gsm-parse-secrets/README.md

This file was deleted.

51 changes: 51 additions & 0 deletions docs/actions/gcp-gsm-parse-secrets/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# gcp-gsm-parse-secrets

Converts a lists of strings of secrets references into screaming snake case. Look at the tests.py for furhter details.

### Inputs

<!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->

| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
| ------------ | ------ | -------- | ------- | --------------------------------------------- |
| project-name | string | true | | GKE project name where the secrets are stored |
| secrets-list | string | true | | Secrets to inject into the environment |

<!-- AUTO-DOC-INPUT:END -->

### Outputs

<!-- AUTO-DOC-OUTPUT:START - Do not remove or modify this section -->

| OUTPUT | TYPE | DESCRIPTION |
| ------------ | ------ | ------------------------------- |
| secrets-list | string | secret list with correct format |

<!-- AUTO-DOC-OUTPUT:END -->

### Secrets

## References

### Inputs

<!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->

| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
| ------------ | ------ | -------- | ------- | --------------------------------------------- |
| project-name | string | true | | GKE project name where the secrets are stored |
| secrets-list | string | true | | Secrets to inject into the environment |

<!-- AUTO-DOC-INPUT:END -->

### Outputs

<!-- AUTO-DOC-OUTPUT:START - Do not remove or modify this section -->

| OUTPUT | TYPE | DESCRIPTION |
| ------------ | ------ | ------------------------------- |
| secrets-list | string | secret list with correct format |

<!-- AUTO-DOC-OUTPUT:END -->

### Secrets

0 comments on commit de61ae6

Please sign in to comment.