From 2435bb9f8a19ea608c014c1578b0b7f25249dcf6 Mon Sep 17 00:00:00 2001 From: Patrice Ferlet Date: Tue, 15 Jul 2025 13:50:07 +0200 Subject: [PATCH 1/2] chore(doc): Rebuild label list and description --- README.md | 35 ++++++++++++++++++----------------- 1 file changed, 18 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index b4aeeed..d4e93a2 100644 --- a/README.md +++ b/README.md @@ -111,6 +111,7 @@ katenary completion fish | source ## Usage ```text + Katenary is a tool to convert compose files to Helm Charts. Each [command] and subcommand has got an "help" and "--help" flag to show more information. @@ -210,22 +211,22 @@ These labels could be found by `katenary help-labels`, and can be placed as labe To get more information about a label, use `katenary help-label e.g. katenary help-label dependencies -katenary.v3/configmap-files: list of strings Add files to the configmap. -katenary.v3/cronjob: object Create a cronjob from the service. -katenary.v3/dependencies: list of objects Add Helm dependencies to the service. -katenary.v3/description: string Description of the service -katenary.v3/env-from: list of strings Add environment variables from antoher service. -katenary.v3/exchange-volumes: list of objects Add exchange volumes (empty directory on the node) to share data -katenary.v3/health-check: object Health check to be added to the deployment. -katenary.v3/ignore: bool Ignore the service -katenary.v3/ingress: object Ingress rules to be added to the service. -katenary.v3/main-app: bool Mark the service as the main app. -katenary.v3/map-env: object Map env vars from the service to the deployment. -katenary.v3/ports: list of uint32 Ports to be added to the service. -katenary.v3/same-pod: string Move the same-pod deployment to the target deployment. -katenary.v3/secrets: list of string Env vars to be set as secrets. -katenary.v3/values: list of string or map Environment variables to be added to the values.yaml -katenary.v3/values-from: map[string]string Add values from another service. +katenary.v3/configmap-files: []string Inject files as Configmap. +katenary.v3/cronjob: object Create a cronjob from the service. +katenary.v3/dependencies: []object Add Helm dependencies to the service. +katenary.v3/description: string Description of the service +katenary.v3/env-from: []string Add environment variables from another service. +katenary.v3/exchange-volumes: []object Add exchange volumes (empty directory on the node) to share data +katenary.v3/health-check: object Health check to be added to the deployment. +katenary.v3/ignore: bool Ignore the service +katenary.v3/ingress: object Ingress rules to be added to the service. +katenary.v3/main-app: bool Mark the service as the main app. +katenary.v3/map-env: map[string]string Map env vars from the service to the deployment. +katenary.v3/ports: []uint32 Ports to be added to the service. +katenary.v3/same-pod: string Move the same-pod deployment to the target deployment. +katenary.v3/secrets: []string Env vars to be set as secrets. +katenary.v3/values: []string or map[string]string Environment variables to be added to the values.yaml +katenary.v3/values-from: map[string]string Add values from another service. ``` ## Katenary.yaml file and schema validation @@ -244,7 +245,7 @@ services: port: 80 ``` -You can remove the labels, and use a kanetary.yaml file: +You can remove the labels, and use a `katenary.yaml` file: ```yaml web: From bdf74f2debf8358d161d856c73b8e6915c5bb140 Mon Sep 17 00:00:00 2001 From: Patrice Ferlet Date: Tue, 15 Jul 2025 13:51:21 +0200 Subject: [PATCH 2/2] chore(cleanup): removed unecessary file --- doc/manpage_requirements.txt | 2 -- 1 file changed, 2 deletions(-) delete mode 100644 doc/manpage_requirements.txt diff --git a/doc/manpage_requirements.txt b/doc/manpage_requirements.txt deleted file mode 100644 index 9072507..0000000 --- a/doc/manpage_requirements.txt +++ /dev/null @@ -1,2 +0,0 @@ -beautifulsoup4==4.* -mkdocs-manpage[preprocess]