-
Notifications
You must be signed in to change notification settings - Fork 118
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
docs: added more detailed explanation of how to make use of secrets in KeptnTasks #959
Merged
Merged
Changes from all commits
Commits
Show all changes
2 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 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 |
---|---|---|
|
@@ -73,5 +73,41 @@ The Lifecycle Toolkit passes the values defined inside the `map` field as a JSON | |
At the moment, multi-level maps are not supported. | ||
The JSON object can be read through the environment variable `DATA` using `Deno.env.get("DATA");`. | ||
Kubernetes secrets can also be passed to the function using the `secureParameters` field. | ||
Here, the `secret` value is the K8s secret name that will be mounted into the runtime and made available to the function | ||
via the environment variable `SECURE_DATA`. | ||
|
||
Here, the `secret` value is the name of the K8s secret containing a field with the key `SECURE_DATA`. | ||
The value of that field will then be available to the functions runtime via an environment variable called `SECURE_DATA`. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. "The value of that field is then available..." "...to the function runtime..." or "to the functions's runtime" or "to the functions at runtime" -- not sure what is best but this syntax isn't good. |
||
|
||
For example, if you have a task function that should make use of secret data, you must first ensure that the secret | ||
containing the `SECURE_DATA` key exists, as e.g.: | ||
|
||
```yaml | ||
apiVersion: v1 | ||
kind: Secret | ||
metadata: | ||
name: deno-demo-secret | ||
thschue marked this conversation as resolved.
Show resolved
Hide resolved
|
||
namespace: default | ||
type: Opaque | ||
data: | ||
SECURE_DATA: YmFyCg== # base64 encoded string, e.g. 'bar' | ||
``` | ||
|
||
Then, you can make use of that secret as follows: | ||
|
||
```yaml | ||
apiVersion: lifecycle.keptn.sh/v1alpha3 | ||
kind: KeptnTaskDefinition | ||
metadata: | ||
name: deployment-hello | ||
namespace: "default" | ||
spec: | ||
function: | ||
secureParameters: | ||
secret: deno-demo-secret | ||
inline: | ||
code: | | ||
console.log("Deployment Hello Task has been executed"); | ||
|
||
let foo = Deno.env.get('SECURE_DATA'); | ||
console.log(foo); | ||
Deno.exit(0); | ||
``` |
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.
Are suggestions deliberately disabled here?
I think Kubernetess should be spelled out here rather than K8s