Katenary/katenary
2
0
Fork 0
Code Issues 7 Pull Requests Actions Packages Projects Releases 15 Wiki Activity

feat(doc): regenerate docs

Browse Source
This commit is contained in:
Patrice Ferlet
2025-06-15 14:48:35 +02:00
parent bc0b65006d
commit ac5317e600
1 changed files with 41 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

68
doc/docs/labels.md
View File

@@ -37,8 +37,8 @@ Add files to the configmap.
**Type**: `[]string` **Type**: `[]string`
It makes a file or directory to be converted to one or more ConfigMaps It makes a file or directory to be converted to one or more ConfigMaps
and mounted in the pod. The file or directory is relative to the and mounted in the pod. The file or directory is relative to the
service directory. service directory.
If it is a directory, all files inside it are added to the ConfigMap. If it is a directory, all files inside it are added to the ConfigMap.
@@ -47,7 +47,7 @@ If the directory as subdirectories, so one configmap per subpath are created.
!!! Warning !!! Warning
It is not intended to be used to store an entire project in configmaps. It is not intended to be used to store an entire project in configmaps.
It is intended to be used to store configuration files that are not managed It is intended to be used to store configuration files that are not managed
by the application, like nginx configuration files. Keep in mind that your by the application, like nginx configuration files. Keep in mind that your
project sources should be stored in an application image or in a storage. project sources should be stored in an application image or in a storage.
@@ -61,6 +61,7 @@ labels:
- ./conf.d - ./conf.d
``` ```
### katenary.v3/cronjob ### katenary.v3/cronjob
Create a cronjob from the service. Create a cronjob from the service.
@@ -70,9 +71,8 @@ Create a cronjob from the service.
This adds a cronjob to the chart. This adds a cronjob to the chart.
The label value is a YAML object with the following attributes: The label value is a YAML object with the following attributes:
- command: the command to be executed
- command: the command to be executed - schedule: the cron schedule (cron format or @every where "every" is a
- schedule: the cron schedule (cron format or @every where "every" is a
duration like 1h30m, daily, hourly...) duration like 1h30m, daily, hourly...)
- rbac: false (optionnal), if true, it will create a role, a rolebinding and - rbac: false (optionnal), if true, it will create a role, a rolebinding and
a serviceaccount to make your cronjob able to connect the Kubernetes API a serviceaccount to make your cronjob able to connect the Kubernetes API
@@ -86,14 +86,15 @@ labels:
schedule: "* */1 * * *" # or @hourly for example schedule: "* */1 * * *" # or @hourly for example
``` ```
### katenary.v3/dependencies ### katenary.v3/dependencies
Add Helm dependencies to the service. Add Helm dependencies to the service.
**Type**: `[]object` **Type**: `[]object`
Set the service to be, actually, a Helm dependency. This means that the Set the service to be, actually, a Helm dependency. This means that the
service will not be exported as template. The dependencies are added to service will not be exported as template. The dependencies are added to
the Chart.yaml file and the values are added to the values.yaml file. the Chart.yaml file and the values are added to the values.yaml file.
It's a list of objects with the following attributes: It's a list of objects with the following attributes:
@@ -105,12 +106,12 @@ It's a list of objects with the following attributes:
!!! Info !!! Info
Katenary doesn't update the helm depenedencies by default. Katenary doesn't update the helm depenedencies by default.
Use `--helm-update` (or `-u`) flag to update the dependencies. Use `--helm-update` (or `-u`) flag to update the dependencies.
example: <code>katenary convert -u</code> example: <code>katenary convert -u</code>
By setting an alias, it is possible to change the name of the dependency By setting an alias, it is possible to change the name of the dependency
in values.yaml. in values.yaml.
**Example:** **Example:**
@@ -132,13 +133,14 @@ labels:
password: the secret password password: the secret password
``` ```
### katenary.v3/description ### katenary.v3/description
Description of the service Description of the service
**Type**: `string` **Type**: `string`
This replaces the default comment in values.yaml file to the given description. This replaces the default comment in values.yaml file to the given description.
It is useful to document the service and configuration. It is useful to document the service and configuration.
The value can be set with a documentation in multiline format. The value can be set with a documentation in multiline format.
@@ -152,6 +154,7 @@ labels:
It can be multiline. It can be multiline.
``` ```
### katenary.v3/env-from ### katenary.v3/env-from
Add environment variables from antoher service. Add environment variables from antoher service.
@@ -177,13 +180,14 @@ service2:
- myservice1 - myservice1
``` ```
### katenary.v3/exchange-volumes ### katenary.v3/exchange-volumes
Add exchange volumes (empty directory on the node) to share data Add exchange volumes (empty directory on the node) to share data
**Type**: `[]object` **Type**: `[]object`
This label allows sharing data between containres. The volume is created in This label allows sharing data between containres. The volume is created in
the node and mounted in the pod. It is useful to share data between containers the node and mounted in the pod. It is useful to share data between containers
in a "same pod" logic. For example to let PHP-FPM and Nginx share the same direcotory. in a "same pod" logic. For example to let PHP-FPM and Nginx share the same direcotory.
@@ -194,10 +198,9 @@ This will create:
- a `initContainer` for each definition - a `initContainer` for each definition
Fields: Fields:
- name: the name of the volume (manadatory)
- name: the name of the volume (manadatory) - mountPath: the path where the volume is mounted in the pod (optional, default is `/opt`)
- mountPath: the path where the volume is mounted in the pod (optional, default is `/opt`) - init: a command to run to initialize the volume with data (optional)
- init: a command to run to initialize the volume with data (optional)
!!! Warning !!! Warning
This is highly experimental. This is mainly useful when using the "same-pod" label. This is highly experimental. This is mainly useful when using the "same-pod" label.
@@ -220,6 +223,7 @@ php:
init: cp -ra /var/www/html/* /opt init: cp -ra /var/www/html/* /opt
``` ```
### katenary.v3/health-check ### katenary.v3/health-check
Health check to be added to the deployment. Health check to be added to the deployment.
@@ -239,6 +243,7 @@ labels:
port: 8080 port: 8080
``` ```
### katenary.v3/ignore ### katenary.v3/ignore
Ignore the service Ignore the service
@@ -254,13 +259,14 @@ labels:
katenary.v3/ignore: "true" katenary.v3/ignore: "true"
``` ```
### katenary.v3/ingress ### katenary.v3/ingress
Ingress rules to be added to the service. Ingress rules to be added to the service.
**Type**: `object` **Type**: `object`
Declare an ingress rule for the service. The port should be exposed or Declare an ingress rule for the service. The port should be exposed or
declared with `katenary.v3/ports`. declared with `katenary.v3/ports`.
**Example:** **Example:**
@@ -272,13 +278,14 @@ labels:
hostname: mywebsite.com (optional) hostname: mywebsite.com (optional)
``` ```
### katenary.v3/main-app ### katenary.v3/main-app
Mark the service as the main app. Mark the service as the main app.
**Type**: `bool` **Type**: `bool`
This makes the service to be the main application. Its image tag is This makes the service to be the main application. Its image tag is
considered to be the Chart appVersion and to be the defaultvalue in Pod considered to be the Chart appVersion and to be the defaultvalue in Pod
container image attribute. container image attribute.
@@ -298,6 +305,7 @@ ghost:
katenary.v3/main-app: true katenary.v3/main-app: true
``` ```
### katenary.v3/map-env ### katenary.v3/map-env
Map env vars from the service to the deployment. Map env vars from the service to the deployment.
@@ -305,8 +313,8 @@ Map env vars from the service to the deployment.
**Type**: `map[string]string` **Type**: `map[string]string`
Because you may need to change the variable for Kubernetes, this label Because you may need to change the variable for Kubernetes, this label
forces the value to another. It is also particullary helpful to use a template forces the value to another. It is also particullary helpful to use a template
value instead. For example, you could bind the value to a service name value instead. For example, you could bind the value to a service name
with Helm attributes: with Helm attributes:
`{{ tpl .Release.Name . }}`. `{{ tpl .Release.Name . }}`.
@@ -325,13 +333,14 @@ labels:
DB_HOST: '{{ include "__APP__.fullname" . }}-database' DB_HOST: '{{ include "__APP__.fullname" . }}-database'
``` ```
### katenary.v3/ports ### katenary.v3/ports
Ports to be added to the service. Ports to be added to the service.
**Type**: `[]uint32` **Type**: `[]uint32`
Only useful for services without exposed port. It is mandatory if the Only useful for services without exposed port. It is mandatory if the
service is a dependency of another service. service is a dependency of another service.
**Example:** **Example:**
@@ -343,16 +352,17 @@ labels:
- 8081 - 8081
``` ```
### katenary.v3/same-pod ### katenary.v3/same-pod
Move the same-pod deployment to the target deployment. Move the same-pod deployment to the target deployment.
**Type**: `string` **Type**: `string`
This will make the service to be included in another service pod. Some services This will make the service to be included in another service pod. Some services
must work together in the same pod, like a sidecar or a proxy or nginx + php-fpm. must work together in the same pod, like a sidecar or a proxy or nginx + php-fpm.
Note that volume and VolumeMount are copied from the source to the target Note that volume and VolumeMount are copied from the source to the target
deployment. deployment.
**Example:** **Example:**
@@ -367,13 +377,14 @@ php:
katenary.v3/same-pod: web katenary.v3/same-pod: web
``` ```
### katenary.v3/secrets ### katenary.v3/secrets
Env vars to be set as secrets. Env vars to be set as secrets.
**Type**: `[]string` **Type**: `[]string`
This label allows setting the environment variables as secrets. The variable This label allows setting the environment variables as secrets. The variable
is removed from the environment and added to a secret object. is removed from the environment and added to a secret object.
The variable can be set to the `katenary.v3/values` too, The variable can be set to the `katenary.v3/values` too,
@@ -390,6 +401,7 @@ labels:
- PASSWORD - PASSWORD
``` ```
### katenary.v3/values ### katenary.v3/values
Environment variables to be added to the values.yaml Environment variables to be added to the values.yaml
@@ -400,11 +412,11 @@ By default, all environment variables in the "env" and environment
files are added to configmaps with the static values set. This label files are added to configmaps with the static values set. This label
allows adding environment variables to the values.yaml file. allows adding environment variables to the values.yaml file.
Note that the value inside the configmap is `{{ tpl vaname . }}`, so Note that the value inside the configmap is `{{ tpl vaname . }}`, so
you can set the value to a template that will be rendered with the you can set the value to a template that will be rendered with the
values.yaml file. values.yaml file.
The value can be set with a documentation. This may help to understand The value can be set with a documentation. This may help to understand
the purpose of the variable. the purpose of the variable.
**Example:** **Example:**
@@ -426,6 +438,7 @@ labels:
It can be, of course, a multiline text. It can be, of course, a multiline text.
``` ```
### katenary.v3/values-from ### katenary.v3/values-from
Add values from another service. Add values from another service.
@@ -463,4 +476,5 @@ php:
DB_PASSWORD: database.MARIADB_PASSWORD DB_PASSWORD: database.MARIADB_PASSWORD
``` ```
<!-- STOP_DETAILED_DOC : do not remove this tag !--> <!-- STOP_DETAILED_DOC : do not remove this tag !-->