v3.9.1 v3.9 v3.8.4 v3.8.3 v3.8.2 v3.8.1 v3.8 v3.7.2 v3.7.1 v3.7 v3.6
Auto Light Dark
Auto Light Dark
v3.9.1 v3.9 v3.8.4 v3.8.3 v3.8.2 v3.8.1 v3.8 v3.7.2 v3.7.1 v3.7 v3.6

K8s/Openshift - Appendix A: Configuration Reference

1. vid-installer-values.yaml

Variable

Description

activeProfile

cassandra or rdbms

oracle.host


oracle.port

Default: 1521

oracle.service


oracle.username


oracle.password


oracle.driverClass

Default: oracle.jdbc.driver.OracleDriver

cassandraHost

Comma-separated list of hostname(s) or IP(s) of Cassandra. Set to "cassandra.clusterName-cassandra.datacenters[].name-service" from k8ssandra-values.yaml

zookeeperHost

Comma-separated list of hostname(s) or IP(s) of Zookeeper. Set to "zookeeper-<ENV_NO>-client"

elasticsearchHost

Comma-separated list of hostname(s) or IP(s) of Elasticsearch. Set to "elasticsearch-<ENV_NO>-es-http"

elasticsearchUser

Secret name where Elasticsearch keeps the username/password. Set to "elasticsearch-<ENV_NO>-es-elastic-user"

cassandraDatacenter

Name of datacenter as defined in the Cassandra cluster (default "dc1")

cassandraReplicationType

Replication type as defined in the Cassandra cluster (default "NETWORK")

cassandraReplicationFactor

Replication factor as defined in the Cassandra cluster (default 3)

cassandraConsistencyLevel

Consistency level as defined in the Cassandra cluster (default "LOCAL_QUORUM")

domainName

The domain of this installation

environmentName

The name of this installation, also the subdomain. The installation receives ingress traffic at "environmentName.domainName"

imagePullSecrets.name

Secret containing credentials used for pulling images from private docker registry

sniEnabled

If true, VeridiumID exposes the services under dedicated server names (e.g. admin-my-env.domain.com, ssp-my-env.domain.com)
If false, VeridiumID exposes the services under a single name (e.g. my-env.domain.com), on dedicated ports

ssl.generateCert

If true, the installer generates a self-signed certificate
If false, it uses defaultCert and defaultKey

ssl.defaultCert

base64 encoded string of a PEM certificate.
To generate this string execute: base64 -w 0 <FULL_PATH_TO_PEM_CERTIFICATE>

ssl.defaultKey

base64 encoded string of a PEM key.
To generate this string execute: base64 -w 0 <FULL_PATH_TO_PEM_KEY>

ssl.defaultCN

Common name in the self-signed certificate. Set this to the value of "domainName"

2. k8ssandra-values.yaml

Property

Description

Recommended value

cassandra.clusterName

Cassandra ClusterName

cassandra-<ENV_NO>

cassandra.datacenters[].name

Name of the datacenter

dc1

cassandra.datacenters[].size

Number of Cassandra nodes in cluster

3

cassandra.storageConfig.cassandraDataVolumeClaimSpec.storageClassName

The storage class for the Cassandra data

<STORAGECLASS_PERSISTENCE>

cassandra.storageConfig.cassandraDataVolumeClaimSpec.resources.requests.storage

The disk size for the Cassandra data

10Gi

3. elasticsearch-values.yaml

Property

Description

Recommended value

elasticsearch.storageClassName

The storage class for the Elasticsearch data

<STORAGECLASS_PERSISTENCE>

elasticsearch.diskSize

The disk size for the Elasticsearch data

15Gi

elasticsearch.replicaCount

Number of Elasticsearch nodes in cluster

3

tlsCertificateSecretName

Secret that holds the CA the ECK Operator uses to issue the Elasticsearch and Kibana HTTP certificates. Remove this property to let the Operator use its own self-signed CA

vid-ca-cert

4. zookeeper-values.yaml

Property

Description

Recommended value

persistence.storageClassName

The storage class for the Zookeeper data

<STORAGECLASS_PERSISTENCE>

persistence.volumeSize

The disk size for the Zookeeper data

1Gi

persistence.reclaimPolicy

The reclaim policy of the Zookeeper disks

Retain

replicas

Number of Zookeeper nodes in cluster

3

5. veridiumid-values.yaml

Variable

Description

Default

global.activeProfile

cassandra or rdbms

cassandra

logrotate_conf.*.size

The log size in MB that starts a rotation

100M

logrotate_conf.*.rotate

The number of rotated log files to keep

3

*.replicaCount

The number of pods of the subsystem. Set 0 to disable the subsystem

1

vid-haproxy.service.nodePort

The NodePort of HAProxy, in the range 30000-32767

32100

vid-haproxy.service.additionalNodePorts

For "ports"-type installation, the designated port for each subsystem

websecadmin: 32102
ssp: 32103
shibboleth-ext: 32104
shibboleth-int: 32105

vid-shibboleth.sessionTimeout

Expressed in seconds

5

vid-maintenance.backup.zookeeper.enable

Enable the Zookeeper backup using VeridiumID script

false

vid-maintenance.backup.zookeeper.keep

How many backups to keep

10

vid-maintenance.backup.zookeeper.schedule

The schedule of the Zookeeper backup, in crontab format

0 23 * * *

vid-maintenance.backup.elasticsearch.enable

Enable the ElasticSearch backup using VeridiumID script

false

vid-maintenance.backup.elasticsearch.keep

How many backups of ElasticSearch to keep

10

vid-maintenance.backup.elasticsearch.schedule

The schedule of the Elasticsearch backup, in crontab format

0 22 * * *

vid-maintenance.backup.elasticsearch_backup_with_policy.enable

Enable ElasticSearch backup with Policy

false

vid-maintenance.backup.elasticsearch_backup_with_policy.schedule

When to take Elasticsearch snapshots. The default triggers every day at noon

0 0 12 * * ?

vid-maintenance.backup.elasticsearch_backup_with_policy.expire_after

How many days to keep the Elasticsearch snapshots

30d

vid-maintenance.backup.elasticsearch_backup_with_policy.min_count

Minimum Elasticsearch snapshots retention regardless of age

5

vid-maintenance.backup.elasticsearch_backup_with_policy.max_count

Maximum Elasticsearch snapshots retention regardless of age

50

vid-maintenance.cassandra.host

Comma-separated list of hostname(s) or IP(s) of Cassandra. Set to "cassandra.clusterName-cassandra.datacenters[].name-service" from k8ssandra-values.yaml

cassandra-service

vid-maintenance.backup.elasticsearchHost

Comma-separated list of hostname(s) or IP(s) of Elasticsearch. Set to "elasticsearch-<ENV_NO>-es-http"

elasticsearch-2-es-http

vid-maintenance.backup.elasticsearchUser

Secret name where Elasticsearch keeps the username/password. Set to "elasticsearch-<ENV_NO>-es-elastic-user"

elasticsearch-2-es-elastic-user

Last updated: