Files
chart/library/common/docs/scaleCertificate.md
Stavros Kois 929e60d801 NAS-121003 / 23.10 / Adapt charts CI and improve/fix common (#1011)
* Adapt charts CI and improve/fix common

* add check on permissions contaienr

* add postgres template

* update comments

* Update create_app.sh

* add check

* update script

* auto gen item.yaml from Chart,yaml

* rename readme on dest

* duplicate readme from the same source

* correct comment

* reoder

* remove extra space

* keep both README and app-readme

* update regex, to also allow 2 letter names, which is also valid

* No need to check host network if there aren't any pod values

* use same pattern as the pod.name label (not prepending release-name

* update deps

* add chart dirs to ci

* Add a validation to check if there is any yaml errors after merging files

* update charts path on ci

* common/1.0.0/ -> common/

* update common-test dep path

* temp update create_app script

* make permissions container name configurable, incase we want to change order of execution

* update naming convention

* fix typo and a missed name change

* do not allow `--` in names
2023-03-16 17:36:19 +02:00

86 lines
2.5 KiB
Markdown

# Scale Certificate
| Key | Type | Required | Helm Template | Default | Description |
| :--------------------------------------- | :-------: | :------: | :----------------: | :-----: | :-------------------------------------------- |
| scaleCertificate | `dict` | ❌ | ❌ | `{}` | Define the certificate as dicts |
| scaleCertificate.[cert-name].enabled | `boolean` | ✅ | ❌ | `false` | Enables the certificate (The secret creation) |
| scaleCertificate.[cert-name].labels | `dict` | ❌ | ✅ (On value only) | `{}` | Additional labels for secret |
| scaleCertificate.[cert-name].annotations | `dict` | ❌ | ✅ (On value only) | `{}` | Additional annotations for secret |
| scaleCertificate.[cert-name].id | `string` | ✅ | ❌ | `""` | ID of the certificate in ixCertificates |
> A secret will be created with 2 keys in the data section: `tls.crt` and `tls.key`.
---
Appears in:
- `.Values.scaleCertificate`
---
Naming scheme:
- `$FullName-$CertName` (release-name-chart-name-CertName)
---
Examples:
```yaml
scaleCertificate:
cert-name:
enabled: false
labels: {}
annotations: {}
id: 1
```
You can mount certificate as a secret using the following snippet:
```yaml
scaleCertificate:
cert-name:
enabled: false
id: 1
persistence:
# This will mount it on the primary pod/container
cert-vol:
enabled: true
type: secret
objectName: cert-name
expandObjectName: true # You can omit this, it's the default
# subPath
mountPath: /path/to/mount/cert.crt
subPath: cert.crt
# or items
mountPath: /path/to/mount
items:
- key: tls.crt
path: cert.crt
# This will mount it on the specific pod/container
cert-vol:
enabled: true
type: secret
objectName: cert-name
expandObjectName: true # You can omit this, it's the default
# subPath
subPath: tls.crt
targetSelector:
workload-name:
container-name:
mountPath: /path/to/mount/cert.crt
# subPath: cert.crt (You can define subPath here as well, per container)
# or items
items:
- key: tls.crt
path: cert.crt
targetSelector:
workload-name:
container-name:
mountPath: /path/to/mount
# Both will result in a mounted file in the container at /path/to/mount/cert.crt
```