-
Notifications
You must be signed in to change notification settings - Fork 2
feat(Playbook): Secret parameter #424
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.
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
Open
adityathebe
wants to merge
4
commits into
main
Choose a base branch
from
feat/sensitive-playbook-parameter
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Submodule mission-control-chart
updated
11 files
43 changes: 43 additions & 0 deletions
43
mission-control/docs/guide/playbooks/concepts/sensitive-data.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
--- | ||
title: Sensitive Data | ||
sidebar_custom_props: | ||
icon: material-symbols-light:security | ||
--- | ||
|
||
Sensitive data includes passwords, API keys, tokens, and other confidential information that requires protection from unauthorized access or exposure. Mission Control provides comprehensive protection for sensitive data throughout the entire playbook lifecycle. | ||
|
||
## Secret Parameters | ||
|
||
Use `secret` type parameters to handle sensitive data in playbooks: | ||
|
||
```yaml | ||
parameters: | ||
- name: database_password | ||
type: secret | ||
label: "Database Password" | ||
description: "Password for database connection" | ||
required: true | ||
``` | ||
|
||
## KMS Connection | ||
|
||
:::info | ||
Your Mission Control instance **must** have a KMS connection configured to use secret parameters. | ||
::: | ||
|
||
Configure this using the `--secret-keeper-connection` flag: | ||
|
||
```bash | ||
mission-control serve --secret-keeper-connection "connection://default/my-kms-key" | ||
``` | ||
|
||
or in the helm chart: | ||
|
||
```yaml | ||
kmsConnection: "connection://default/my-kms-key" | ||
``` | ||
|
||
Supported connection types: | ||
- AWS KMS | ||
- Azure Key Vault | ||
- GCP KMS |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we update the setup guides for AWS/GCP for the creation of this key, and connection and the updates to the IAM binding needed.
This is also I think a post-setup task as it requires the ability to create the connection first