Skip to content

Commit

Permalink
docs: add docs for Python runtime (#1549)
Browse files Browse the repository at this point in the history
Signed-off-by: realanna <anna.reale@dynatrace.com>
  • Loading branch information
RealAnna committed Jun 20, 2023
1 parent 1384679 commit 2e53fda
Show file tree
Hide file tree
Showing 6 changed files with 15 additions and 5 deletions.
4 changes: 4 additions & 0 deletions docs/config/_default/config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ module:
- "mentorship"
- source: "README.md"
target: "./content/community/_index.md"

proxy: direct
languages:
en:
Expand All @@ -40,3 +41,6 @@ menu:
rel: external
url: https://v1.keptn.sh/
weight: 1

ignoreErrors:
- "error-remote-getjson"
2 changes: 2 additions & 0 deletions docs/config/_default/params.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ versions:
mermaid:
enable: true

currentversion: main

links:
developer:
- desc: Development takes place here!
Expand Down
1 change: 1 addition & 0 deletions docs/content/en/docs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,5 @@ linktitle: Docs
description: Learn how to use Keptn.
cascade:
type: docs
currentversion: main
---
4 changes: 2 additions & 2 deletions netlify.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ publish = "public/"
# On netlify our branch will always be the one we are currently building for
# important information regarding naming
# https://gohugo.io/getting-started/configuration/#configure-with-environment-variables
command = "HUGOxPARAMSxGITHUB_BRANCH=$BRANCH hugo -b $DEPLOY_PRIME_URL"
command = "HUGOxPARAMSxGITHUB_BRANCH=$BRANCH HUGOxPARAMSxCURRENTVERSION=$BRANCH hugo -b $DEPLOY_PRIME_URL"
ignore = "git diff --quiet $CACHED_COMMIT_REF $COMMIT_REF . ../netlify.toml"

[build.environment]
Expand All @@ -27,4 +27,4 @@ HUGO_ENV = "production"
# On netlify our branch will always be the one we are currently building for
# important information regarding naming
# https://gohugo.io/getting-started/configuration/#configure-with-environment-variables
command = "HUGOxPARAMSxGITHUB_BRANCH=$BRANCH hugo -b $URL"
command = "HUGOxPARAMSxGITHUB_BRANCH=$BRANCH HUGOxPARAMSxCURRENTVERSION=$BRANCH hugo -b $URL"
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
apiVersion: lifecycle.keptn.sh/v1alpha3
kind: KeptnTaskDefinition
metadata:
name: scheduled-deployment
name: scheduled-deployment-inline
spec:
python:
parameters:
Expand Down
7 changes: 5 additions & 2 deletions python-runtime/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,12 @@ docker build -t lifecycle-toolkit/python-runtime:${VERSION} .

## Usage

The Keptn python runtime uses python3, and enables the follwing packages: requests, json, git, yaml
The Keptn `python-runtime` runner uses python3
and enables the following packages: requests, json, git, yaml

The Keptn Lifecycle Toolkit uses this runtime to run [KeptnTask](https://lifecycle.keptn.sh/docs/tasks/write-tasks/)
The Keptn Lifecycle Toolkit uses this runner to execute tasks defined as
[KeptnTaskDefinition](https://lifecycle.keptn.sh/docs/yaml-crd-ref/taskdefinition/)
resources.
for pre- and post-checks.

`KeptnTask`s can be tested locally with the runtime using the following commands.
Expand Down

0 comments on commit 2e53fda

Please sign in to comment.