feat(doc): regenerate docs
This commit is contained in:
@@ -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,7 +71,6 @@ 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...)
|
||||||
@@ -86,6 +86,7 @@ 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.
|
||||||
@@ -132,6 +133,7 @@ labels:
|
|||||||
password: the secret password
|
password: the secret password
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
### katenary.v3/description
|
### katenary.v3/description
|
||||||
|
|
||||||
Description of the service
|
Description of the service
|
||||||
@@ -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,6 +180,7 @@ 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
|
||||||
@@ -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,6 +259,7 @@ 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.
|
||||||
@@ -272,6 +278,7 @@ 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.
|
||||||
@@ -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.
|
||||||
@@ -325,6 +333,7 @@ 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.
|
||||||
@@ -343,6 +352,7 @@ 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.
|
||||||
@@ -367,6 +377,7 @@ 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.
|
||||||
@@ -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
|
||||||
@@ -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 !-->
|
||||||
|
Reference in New Issue
Block a user