mkdocs values¶
Every value of chart mkdocs 0.3.3, read from values.yaml and values.schema.json. A map is listed with its keys; a map without a description of its own is listed by its keys only. Every value has a default: the chart installs with none given.
| Value | Type | Default | Description |
|---|---|---|---|
fullnameOverride |
string | mkdocs |
|
source.gitRepo |
string | "" |
empty: an example site is generated, so the chart installs without a repository |
source.gitRef |
string | main |
|
source.contextDir |
string | "" |
directory in the repository that holds the config file; empty: the root |
source.configFile |
string | mkdocs.yml |
|
source.requirementsFile |
string | "" |
pip requirements file in that directory; empty: mkdocs-material is installed |
source.strict |
boolean | true |
|
source.private |
boolean | false |
the repository needs a login: user name here, password under secrets |
source.gitUsername |
string | "" |
|
source.pollSchedule |
string | */10 * * * * |
how often to look for a new commit; empty: never |
source.webhook |
boolean | false |
true: the Git server starts a build on a push through the webhook of the BuildConfig, and an image trigger restarts the site after the build |
build.builderImage |
string | registry.access.redhat.com/ubi9/python-312:latest |
|
build.runtimeImage |
string | registry.access.redhat.com/ubi9/nginx-124:latest |
|
build.registry |
string | image-registry.openshift-image-registry.svc:5000 |
registry of the cluster, where the build pushes and the pods pull |
build.resources.requests.cpu |
string | 100m |
|
build.resources.requests.memory |
string | 256Mi |
|
build.resources.limits.cpu |
string | 1 |
|
build.resources.limits.memory |
string | 1Gi |
|
replicaCount |
integer | 2 |
|
resources.requests.cpu |
string | 10m |
|
resources.requests.memory |
string | 32Mi |
|
resources.limits.cpu |
string | 200m |
|
resources.limits.memory |
string | 128Mi |
|
route.hostname |
string | "" |
empty: OpenShift assigns a host under the default application domain |
route.labels |
object | {} |
extra labels and annotations on the Route, for example to select it for a router shard or a policy |
route.annotations |
object | {} |
|
oauth.enabled |
boolean | false |
true: only users who log in at the issuer see the site |
oauth.image |
string | quay.io/oauth2-proxy/oauth2-proxy:latest |
|
oauth.issuerUrl |
string | "" |
OIDC issuer, for example https://login.example.com/realms/example |
oauth.clientId |
string | "" |
|
oauth.scope |
string | openid email profile |
|
oauth.groupsClaim |
string | groups |
token claim that lists the groups of the user |
oauth.allowedGroups |
array | [] |
empty: every user of the issuer |
oauth.emailDomains |
array | ["*"] |
|
oauth.extraArgs |
array | [] |
further oauth2-proxy flags, for an issuer that needs them |
oauth.resources.requests.cpu |
string | 10m |
|
oauth.resources.requests.memory |
string | 32Mi |
|
oauth.resources.limits.cpu |
string | 100m |
|
oauth.resources.limits.memory |
string | 128Mi |
|
secrets.type |
string | kubernetes |
kubernetes: Secrets from the values below. externalSecret: from a secret store One of: kubernetes, externalSecret. |
secrets.gitPassword |
string | "" |
|
secrets.clientSecret |
string | "" |
|
secrets.cookieSecret |
string | "" |
empty: generated once and kept on upgrade. A value that is not 16, 24 or 32 characters long is hashed to 32 |
secrets.webhookSecret |
string | "" |
part of the webhook address. Empty: generated once and kept on upgrade |
secrets.externalSecret.storeKind |
string | ClusterSecretStore |
|
secrets.externalSecret.storeName |
string | "" |
|
secrets.externalSecret.refreshInterval |
string | 1h |
|
secrets.externalSecret.items |
object | one vault item per secret; the value is read from the item's password | |
secrets.externalSecret.items.gitPassword |
string | mkdocs-git-password |
|
secrets.externalSecret.items.clientSecret |
string | mkdocs-client-secret |
|
secrets.externalSecret.items.cookieSecret |
string | mkdocs-cookie-secret |
|
secrets.externalSecret.items.webhookSecret |
string | mkdocs-webhook-secret |