From 9fcbfa7fcc282f64de7b9807edddc4c476f1aa25 Mon Sep 17 00:00:00 2001 From: Stavros kois Date: Thu, 1 Dec 2022 16:49:16 +0200 Subject: [PATCH] tty and stdin docs --- library/common/1.0.0/values.yaml | 9 +++------ library/common/_docs/values/stdin.md | 15 +++++++++++++++ library/common/_docs/values/tty.md | 15 +++++++++++++++ 3 files changed, 33 insertions(+), 6 deletions(-) create mode 100644 library/common/_docs/values/stdin.md create mode 100644 library/common/_docs/values/tty.md diff --git a/library/common/1.0.0/values.yaml b/library/common/1.0.0/values.yaml index 11654c8a78..da5f99e200 100644 --- a/library/common/1.0.0/values.yaml +++ b/library/common/1.0.0/values.yaml @@ -63,6 +63,9 @@ hostNetwork: false hostname: "" +tty: false + +stdin: false # Everything bellow needs documentation global: @@ -79,15 +82,10 @@ podAnnotations: {} podLabels: {} -# TODO: docs ixExternalInterfacesConfigurationNames: [] # - interface1 # - interface2 -tty: false - -stdin: false - enableServiceLinks: false schedulerName: "" @@ -102,7 +100,6 @@ nodeSelector: {} tolerations: [] -# TODO: docs podSecurityContext: runAsUser: 568 runAsGroup: 568 diff --git a/library/common/_docs/values/stdin.md b/library/common/_docs/values/stdin.md new file mode 100644 index 0000000000..b73edbee67 --- /dev/null +++ b/library/common/_docs/values/stdin.md @@ -0,0 +1,15 @@ +# STDIN + +## key: stdin + +- Type: `boolean` +- Default: `false` +- Helm Template: ❌ + +Allocates a buffer for stdin in the container runtime. + +Examples: + +```yaml +stdin: true +``` diff --git a/library/common/_docs/values/tty.md b/library/common/_docs/values/tty.md new file mode 100644 index 0000000000..7cc54d277f --- /dev/null +++ b/library/common/_docs/values/tty.md @@ -0,0 +1,15 @@ +# TTY + +## key: tty + +- Type: `boolean` +- Default: `false` +- Helm Template: ❌ + +Allocates a TTY, requires also `stdin` set to true + +Examples: + +```yaml +tty: true +```