Skip to content

Commit

Permalink
Add symbolic links
Browse files Browse the repository at this point in the history
  • Loading branch information
DerTiedemann committed Nov 5, 2024
1 parent 90d13d4 commit 1ae7318
Show file tree
Hide file tree
Showing 4 changed files with 79 additions and 109 deletions.
30 changes: 29 additions & 1 deletion actions/gcp-gsm-load-secrets/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

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

## How to use
## Usage

To load a secret from GSM figure out the following:

Expand All @@ -27,3 +27,31 @@ To load a secret from GSM figure out the following:
- 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
48 changes: 48 additions & 0 deletions actions/gcp-gsm-parse-secrets/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +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
57 changes: 0 additions & 57 deletions docs/actions/gcp-gsm-load-secrets/README.md

This file was deleted.

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

This file was deleted.

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

0 comments on commit 1ae7318

Please sign in to comment.