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.

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 2 commits into from
Mar 2, 2023
Merged
Changes from all commits
Commits
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
40 changes: 38 additions & 2 deletions docs/content/en/docs/tasks/write-tasks/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Copy link
Contributor

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

The value of that field will then be available to the functions runtime via an environment variable called `SECURE_DATA`.
Copy link
Contributor

Choose a reason for hiding this comment

The 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);
```