feat(doc): regenerate docs
This commit is contained in:
@@ -37,8 +37,8 @@ Add files to the configmap.
|
||||
|
||||
**Type**: `[]string`
|
||||
|
||||
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
|
||||
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
|
||||
service directory.
|
||||
|
||||
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
|
||||
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
|
||||
project sources should be stored in an application image or in a storage.
|
||||
|
||||
@@ -61,6 +61,7 @@ labels:
|
||||
- ./conf.d
|
||||
```
|
||||
|
||||
|
||||
### katenary.v3/cronjob
|
||||
|
||||
Create a cronjob from the service.
|
||||
@@ -70,9 +71,8 @@ Create a cronjob from the service.
|
||||
This adds a cronjob to the chart.
|
||||
|
||||
The label value is a YAML object with the following attributes:
|
||||
|
||||
- command: the command to be executed
|
||||
- schedule: the cron schedule (cron format or @every where "every" is a
|
||||
- command: the command to be executed
|
||||
- schedule: the cron schedule (cron format or @every where "every" is a
|
||||
duration like 1h30m, daily, hourly...)
|
||||
- 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
|
||||
@@ -86,14 +86,15 @@ labels:
|
||||
schedule: "* */1 * * *" # or @hourly for example
|
||||
```
|
||||
|
||||
|
||||
### katenary.v3/dependencies
|
||||
|
||||
Add Helm dependencies to the service.
|
||||
|
||||
**Type**: `[]object`
|
||||
|
||||
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
|
||||
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
|
||||
the Chart.yaml file and the values are added to the values.yaml file.
|
||||
|
||||
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
|
||||
Katenary doesn't update the helm depenedencies by default.
|
||||
|
||||
|
||||
Use `--helm-update` (or `-u`) flag to update the dependencies.
|
||||
|
||||
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.
|
||||
|
||||
**Example:**
|
||||
@@ -132,13 +133,14 @@ labels:
|
||||
password: the secret password
|
||||
```
|
||||
|
||||
|
||||
### katenary.v3/description
|
||||
|
||||
Description of the service
|
||||
|
||||
**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.
|
||||
|
||||
The value can be set with a documentation in multiline format.
|
||||
@@ -152,6 +154,7 @@ labels:
|
||||
It can be multiline.
|
||||
```
|
||||
|
||||
|
||||
### katenary.v3/env-from
|
||||
|
||||
Add environment variables from antoher service.
|
||||
@@ -177,13 +180,14 @@ service2:
|
||||
- myservice1
|
||||
```
|
||||
|
||||
|
||||
### katenary.v3/exchange-volumes
|
||||
|
||||
Add exchange volumes (empty directory on the node) to share data
|
||||
|
||||
**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
|
||||
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
|
||||
|
||||
Fields:
|
||||
|
||||
- name: the name of the volume (manadatory)
|
||||
- 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)
|
||||
- name: the name of the volume (manadatory)
|
||||
- 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)
|
||||
|
||||
!!! Warning
|
||||
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
|
||||
```
|
||||
|
||||
|
||||
### katenary.v3/health-check
|
||||
|
||||
Health check to be added to the deployment.
|
||||
@@ -239,6 +243,7 @@ labels:
|
||||
port: 8080
|
||||
```
|
||||
|
||||
|
||||
### katenary.v3/ignore
|
||||
|
||||
Ignore the service
|
||||
@@ -254,13 +259,14 @@ labels:
|
||||
katenary.v3/ignore: "true"
|
||||
```
|
||||
|
||||
|
||||
### katenary.v3/ingress
|
||||
|
||||
Ingress rules to be added to the service.
|
||||
|
||||
**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`.
|
||||
|
||||
**Example:**
|
||||
@@ -272,13 +278,14 @@ labels:
|
||||
hostname: mywebsite.com (optional)
|
||||
```
|
||||
|
||||
|
||||
### katenary.v3/main-app
|
||||
|
||||
Mark the service as the main app.
|
||||
|
||||
**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
|
||||
container image attribute.
|
||||
|
||||
@@ -298,6 +305,7 @@ ghost:
|
||||
katenary.v3/main-app: true
|
||||
```
|
||||
|
||||
|
||||
### katenary.v3/map-env
|
||||
|
||||
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`
|
||||
|
||||
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
|
||||
value instead. For example, you could bind the value to a service name
|
||||
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
|
||||
with Helm attributes:
|
||||
`{{ tpl .Release.Name . }}`.
|
||||
|
||||
@@ -325,13 +333,14 @@ labels:
|
||||
DB_HOST: '{{ include "__APP__.fullname" . }}-database'
|
||||
```
|
||||
|
||||
|
||||
### katenary.v3/ports
|
||||
|
||||
Ports to be added to the service.
|
||||
|
||||
**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.
|
||||
|
||||
**Example:**
|
||||
@@ -343,16 +352,17 @@ labels:
|
||||
- 8081
|
||||
```
|
||||
|
||||
|
||||
### katenary.v3/same-pod
|
||||
|
||||
Move the same-pod deployment to the target deployment.
|
||||
|
||||
**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.
|
||||
|
||||
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.
|
||||
|
||||
**Example:**
|
||||
@@ -367,13 +377,14 @@ php:
|
||||
katenary.v3/same-pod: web
|
||||
```
|
||||
|
||||
|
||||
### katenary.v3/secrets
|
||||
|
||||
Env vars to be set as secrets.
|
||||
|
||||
**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.
|
||||
|
||||
The variable can be set to the `katenary.v3/values` too,
|
||||
@@ -390,6 +401,7 @@ labels:
|
||||
- PASSWORD
|
||||
```
|
||||
|
||||
|
||||
### katenary.v3/values
|
||||
|
||||
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
|
||||
allows adding environment variables to the values.yaml file.
|
||||
|
||||
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
|
||||
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
|
||||
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.
|
||||
|
||||
**Example:**
|
||||
@@ -426,6 +438,7 @@ labels:
|
||||
It can be, of course, a multiline text.
|
||||
```
|
||||
|
||||
|
||||
### katenary.v3/values-from
|
||||
|
||||
Add values from another service.
|
||||
@@ -463,4 +476,5 @@ php:
|
||||
DB_PASSWORD: database.MARIADB_PASSWORD
|
||||
```
|
||||
|
||||
|
||||
<!-- STOP_DETAILED_DOC : do not remove this tag !-->
|
||||
|
||||
Reference in New Issue
Block a user