Skip to content

Commit

Permalink
Add default value for identity.krbKeysOperator.namespaces to values.y…
Browse files Browse the repository at this point in the history
…aml (#23)
  • Loading branch information
AlexGodbehere authored Jul 3, 2023
1 parent 41be8a6 commit 657e870
Show file tree
Hide file tree
Showing 2 changed files with 58 additions and 54 deletions.
109 changes: 55 additions & 54 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,60 +119,61 @@ Production deployment does not differ greatly from development deployment, howev
| https://operator.min.io | tenant | 5.0.3 |

## Values
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| acs.baseUrl | string | `"localhost"` | The base URL that services will be served from |
| acs.organisation | string | `"AMRC"` | The organisation where ACS is being deployed |
| acs.secure | bool | `true` | Whether or not services should be served over HTTPS |
| acs.tlsSecretName | string | `"factoryplus-tls"` | The name of the secret holding the wildcard certificate for the above domain. |
| auth.enabled | bool | `true` | Whether or not to enable the Authorisation component |
| auth.image.registry | string | `"ghcr.io/amrc-factoryplus"` | The registry of the Authorisation component |
| auth.image.repository | string | `"acs-auth"` | The repository of the Authorisation component |
| auth.image.tag | string | `"latest"` | The tag of the Authorisation component |
| cmdesc.enabled | bool | `true` | Whether or not to enable the Commands component |
| cmdesc.image.registry | string | `"ghcr.io/amrc-factoryplus"` | The registry of the Commands component |
| cmdesc.image.repository | string | `"acs-cmdesc"` | The repository of the Commands component |
| cmdesc.image.tag | string | `"latest"` | The tag of the Commands component |
| cmdesc.verbosity | int | `1` | Possible values are either 1 to enable all possible debugging, or a comma-separated list of debug tags (the tags printed before the log lines). No logging is specified as an empty string. |
| configdb.enabled | bool | `true` | Whether or not to enable the Configuration Store component |
| configdb.image.registry | string | `"ghcr.io/amrc-factoryplus"` | The registry of the Configuration Store component |
| configdb.image.repository | string | `"acs-configdb"` | The repository of the Configuration Store component |
| configdb.image.tag | string | `"latest"` | The tag of the Configuration Store component |
| directory.enabled | bool | `true` | Whether or not to enable the Directory component |
| directory.image.registry | string | `"ghcr.io/amrc-factoryplus"` | The registry of the Directory component |
| directory.image.repository | string | `"acs-directory"` | The repository of the Directory component |
| directory.image.tag | string | `"latest"` | The tag of the Directory component |
| identity.crossRealm | array | `[]` | Enable support for cross-realm authentication |
| identity.enabled | bool | `true` | Whether or not to enable the Identity component |
| identity.identity.image.registry | string | `"ghcr.io/amrc-factoryplus"` | The registry of the Identity component |
| identity.identity.image.repository | string | `"acs-identity"` | The repository of the Identity component |
| identity.identity.image.tag | string | `"latest"` | The tag of the Identity component |
| identity.krbKeysOperator.image.registry | string | `"ghcr.io/amrc-factoryplus"` | The registry of the KerberosKey Operator |
| Key | Type | Default | Description |
|-------------------------------------------|--------|---------|-------------|
| acs.baseUrl | string | `"localhost"` | The base URL that services will be served from |
| acs.organisation | string | `"AMRC"` | The organisation where ACS is being deployed |
| acs.secure | bool | `true` | Whether or not services should be served over HTTPS |
| acs.tlsSecretName | string | `"factoryplus-tls"` | The name of the secret holding the wildcard certificate for the above domain. |
| auth.enabled | bool | `true` | Whether or not to enable the Authorisation component |
| auth.image.registry | string | `"ghcr.io/amrc-factoryplus"` | The registry of the Authorisation component |
| auth.image.repository | string | `"acs-auth"` | The repository of the Authorisation component |
| auth.image.tag | string | `"latest"` | The tag of the Authorisation component |
| cmdesc.enabled | bool | `true` | Whether or not to enable the Commands component |
| cmdesc.image.registry | string | `"ghcr.io/amrc-factoryplus"` | The registry of the Commands component |
| cmdesc.image.repository | string | `"acs-cmdesc"` | The repository of the Commands component |
| cmdesc.image.tag | string | `"latest"` | The tag of the Commands component |
| cmdesc.verbosity | int | `1` | Possible values are either 1 to enable all possible debugging, or a comma-separated list of debug tags (the tags printed before the log lines). No logging is specified as an empty string. |
| configdb.enabled | bool | `true` | Whether or not to enable the Configuration Store component |
| configdb.image.registry | string | `"ghcr.io/amrc-factoryplus"` | The registry of the Configuration Store component |
| configdb.image.repository | string | `"acs-configdb"` | The repository of the Configuration Store component |
| configdb.image.tag | string | `"latest"` | The tag of the Configuration Store component |
| directory.enabled | bool | `true` | Whether or not to enable the Directory component |
| directory.image.registry | string | `"ghcr.io/amrc-factoryplus"` | The registry of the Directory component |
| directory.image.repository | string | `"acs-directory"` | The repository of the Directory component |
| directory.image.tag | string | `"latest"` | The tag of the Directory component |
| identity.enabled | bool | `true` | Whether or not to enable the Identity component |
| identity.identity.image.registry | string | `"ghcr.io/amrc-factoryplus"` | The registry of the Identity component |
| identity.identity.image.repository | string | `"acs-identity"` | The repository of the Identity component |
| identity.identity.image.tag | string | `"latest"` | The tag of the Identity component |
| identity.krbKeysOperator.namespaces | string | `""` | A comma-separated list of namespaces that the KerberosKey Operator should watch for KerberosKey resources in. Defaults to the release namespace if not specified |
| identity.krbKeysOperator.image.registry | string | `"ghcr.io/amrc-factoryplus"` | The registry of the KerberosKey Operator |
| identity.crossRealm | array | `[]` | Enable support for cross-realm authentication |
| identity.krbKeysOperator.image.repository | string | `"acs-krb-keys-operator"` | The repository of the KerberosKey Operator |
| identity.krbKeysOperator.image.tag | string | `"latest"` | The tag of the KerberosKey Operator |
| identity.realm | string | `"LOCALHOST"` | The Kerberos realm for this Factory+ deployment. |
| manager.debug | bool | `false` | Whether debug mode is enabled. DO NOT USE THIS IN PRODUCTION. |
| manager.edge.registry | string | `"ghcr.io/amrc-factoryplus"` | The registry of the Edge Agent component |
| manager.edge.repository | string | `"acs-edge"` | The repository of the Edge Agent component |
| manager.edge.tag | string | `"latest"` | The tag of the Edge Agent component |
| manager.enabled | bool | `true` | Whether or not to enable the Manager component |
| manager.env | string | `"production"` | The environment that the manager is running in |
| manager.image.registry | string | `"ghcr.io/amrc-factoryplus"` | The registry of the Manager component |
| manager.image.repository | string | `"acs-manager"` | The repository of the Manager component |
| manager.image.tag | string | `"latest"` | The tag of the Manager component |
| manager.logLevel | string | `"warning"` | The minimum log level that the manager will log messages at |
| manager.meilisearch.key | string | `"masterKey"` | The key that the manager uses to connect to the Meilisearch search engine |
| manager.name | string | `"Factory+ Manager"` | A string used to customise the branding of the manager |
| minio.enabled | bool | `true` | Whether or not to enable MinIO |
| minio.exposeConsole | bool | `false` | Whether or not to expose the MinIO console outside of the cluster |
| mqtt.enabled | bool | `true` | Whether or not to enable the MQTT component |
| mqtt.image.registry | string | `"ghcr.io/amrc-factoryplus"` | The registry of the MQTT component |
| mqtt.image.repository | string | `"acs-mqtt"` | The repository of the MQTT component |
| mqtt.image.tag | string | `"latest"` | The tag of the MQTT component |
| postgres.enabled | bool | `true` | Whether or not to enable Postgres |
| warehouse.ingester | object | `{"enabled":true,"image":{"registry":"ghcr.io/amrc-factoryplus","repository":"influxdb-sparkplug-ingester","tag":"latest"}}` | Whether or not to enable the Warehouse component |
| warehouse.ingester.image.registry | string | `"ghcr.io/amrc-factoryplus"` | The registry of the Warehouse component |
| warehouse.ingester.image.repository | string | `"influxdb-sparkplug-ingester"` | The repository of the Warehouse component |
| warehouse.ingester.image.tag | string | `"latest"` | The tag of the Warehouse component |
| identity.krbKeysOperator.image.tag | string | `"latest"` | The tag of the KerberosKey Operator |
| identity.realm | string | `"LOCALHOST"` | The Kerberos realm for this Factory+ deployment. |
| manager.debug | bool | `false` | Whether debug mode is enabled. DO NOT USE THIS IN PRODUCTION. |
| manager.edge.registry | string | `"ghcr.io/amrc-factoryplus"` | The registry of the Edge Agent component |
| manager.edge.repository | string | `"acs-edge"` | The repository of the Edge Agent component |
| manager.edge.tag | string | `"latest"` | The tag of the Edge Agent component |
| manager.enabled | bool | `true` | Whether or not to enable the Manager component |
| manager.env | string | `"production"` | The environment that the manager is running in |
| manager.image.registry | string | `"ghcr.io/amrc-factoryplus"` | The registry of the Manager component |
| manager.image.repository | string | `"acs-manager"` | The repository of the Manager component |
| manager.image.tag | string | `"latest"` | The tag of the Manager component |
| manager.logLevel | string | `"warning"` | The minimum log level that the manager will log messages at |
| manager.meilisearch.key | string | `"masterKey"` | The key that the manager uses to connect to the Meilisearch search engine |
| manager.name | string | `"Factory+ Manager"` | A string used to customise the branding of the manager |
| minio.enabled | bool | `true` | Whether or not to enable MinIO |
| minio.exposeConsole | bool | `false` | Whether or not to expose the MinIO console outside of the cluster |
| mqtt.enabled | bool | `true` | Whether or not to enable the MQTT component |
| mqtt.image.registry | string | `"ghcr.io/amrc-factoryplus"` | The registry of the MQTT component |
| mqtt.image.repository | string | `"acs-mqtt"` | The repository of the MQTT component |
| mqtt.image.tag | string | `"latest"` | The tag of the MQTT component |
| postgres.enabled | bool | `true` | Whether or not to enable Postgres |
| warehouse.ingester | object | `{"enabled":true,"image":{"registry":"ghcr.io/amrc-factoryplus","repository":"influxdb-sparkplug-ingester","tag":"latest"}}` | Whether or not to enable the Warehouse component |
| warehouse.ingester.image.registry | string | `"ghcr.io/amrc-factoryplus"` | The registry of the Warehouse component |
| warehouse.ingester.image.repository | string | `"influxdb-sparkplug-ingester"` | The repository of the Warehouse component |
| warehouse.ingester.image.tag | string | `"latest"` | The tag of the Warehouse component |

----------------------------------------------
3 changes: 3 additions & 0 deletions values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@ identity:
# @ignore
pullPolicy: IfNotPresent
krbKeysOperator:
# -- A comma-separated list of namespaces that the KerberosKey Operator should watch for KerberosKey resources in. Defaults to the release namespace if not specified
namespaces: ""

image:
# -- The registry of the KerberosKey Operator
registry: ghcr.io/amrc-factoryplus
Expand Down

0 comments on commit 657e870

Please sign in to comment.