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.

Sign up for GitHub

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: add docs for Python runtime #1549

Merged
merged 2 commits into from
Jun 20, 2023
Merged

docs: add docs for Python runtime #1549

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
670639e
remove conflicting file
RealAnna Jun 12, 2023
76968a3
remove conflicting file
RealAnna Jun 20, 2023
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
4 changes: 4 additions & 0 deletions docs/config/_default/config.yaml
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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"
2 changes: 1 addition & 1 deletion operator/config/samples/python_execution/taskdefinition_pyfunction_inline.yaml
View file
Open in desktop
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
View file
Open in desktop
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