K8s/Openshift - Appendix A: Configuration Reference

imagePullSecrets.name

Secret containing credentials used for pulling images from private docker registry

cassandraHost

Comma-separated list of hostname(s) or IP(s) of Cassandra.
This value is constructed by appending the following values from k8ssandra-deployment.yaml:
"metadata.name-spec.cassandra.datacenters[].metadata.name-service"

zookeeperHost

Comma-separated list of hostname(s) or IP(s) of Zookeeper. Should be: "<NAMESPACE>-zookeeper-client"

elasticsearchHost

Comma-separated list of hostname(s) or IP(s) of Elasticsearch. Should be: "<NAMESPACE>-elasticsearch-es-http"

elasticsearchUser

Secret name where Elasticsearch keeps the username/password. Should be: "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 leve as defined in the Cassandra cluster (default "LOCAL_QUORUM")

domainName

Domain where this installation will be accessible

environmentName

Name of this installation. This will be the subdomain. So this installation will expect ingress traffic at "environmentName.domainName"

sniEnabled

If true, the services will be exposed under dedicated server names, (e.g. admin-my-env.domain.com, ssp-my-env.domain.com)
If false, the services will be exposed under a single name (e.g. my-env.domain.com), but dedicated ports

ssl.generateCert

If true, a self-signed certificate will be generated
if false, the defaultCert and defaultKey will be used

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>

activeProfile

Which database to use: “cassandra” or “rdbms”

oracle.host

Oracle DB hostname

oracle.port

Oracle DB port

Default: 1521

oracle.service

Oracle service name

oracle.username

Oracle user name

oracle.password

Oracle password

oracle.driverClass

The driver to use for connecting to Oracle

Default: “oracle.jdbc.driver.OracleDriver”

reaper.autoScheduling.enabled

Enable or disable the reaper to scheduling the repair/compact

Default: true

medusa.enable

If true, Medusa container will be launched.

false

medusa.storageProperties.podStorage.storageClassName

The type of storage to be provisioned for storing Medusa data

<STORAGECLASS_PERSISTENCE>

medusa.storageProperties.podStorage.size

The size of the disks where Medusa data will be stored

100Gi

medusa.storageProperties.maxBackupCount

Maximum number of backups to keep (used by the purge process).

2

medusa.storageProperties.maxBackupAge

Maximum backup age that the purge process should observe.

0

medusa_backup.enable

Enable or disable backup Cassandra using medusa

Default: true

medusa_backup.MedusaBackupSchedule.cronSchedule

Schedule when Medusa Backup will run

Default: 0 0 * * *

medusa_backup.MedusaBackupSchedulePurge.schedule

Schedule when purge job will run

Default: 0 1 * * *

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 type of storage to be provisioned for storing Cassandra data

<STORAGECLASS_PERSISTENCE>

cassandra.storageConfig.cassandraDataVolumeClaimSpec.resources.requests.storage

The size of the disks where Cassandra data will be stored

40Gi

elasticsearch.storageClassName

The type of storage to be provisioned for storing Elasticsearch data

<STORAGECLASS_PERSISTENCE>

elasticsearch.diskSize

The size of the disks where Elasticsearch data will be stored

20Gi

elasticsearch.replicaCount

Number of Elasticsearch nodes in cluster

3

persistence.storageClassName

The type of storage to be provisioned for storing Zookeeper data

<STORAGECLASS_PERSISTENCE>

persistence.volumeSize

The size of the disks where Zookeeper data will be stored

1Gi

persistence.reclaimPolicy

The reclaim Policy of the disks where Zookeeper data will be stored

Retain

replicas

Number of Zookeeper nodes in cluster

3

logrotate_conf.*.size

The size in MB for the app log when will be rotated

logrotate_conf.*.rotate

How many copy of log rotation to keep

*.replicaCount

Number of pods for that particular subsystem. This can be easily changed at a later time.
If you don't need a particular subsystem, set the replicaCount to 0. (Default value: 2)

vid-haproxy.service.nodePort

The designated port for HAProxy to listen on. This will need to be within the 30000-32767 range, considering it is being exposed as NodePort.

vid-haproxy.service.additionalNodePorts

For "ports"-type installation, the designated port for each subsystem. Default values are:

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

vid-shibboleth.sessionTimeout

Expressed in seconds. Default: 5

vid-maintenance.backup.zookeeper.enable

Enable the Zookeeper backup using VeridiumID script

vid-maintenance.backup.zookeeper.keep

How many backups to keep

vid-maintenance.backup.zookeeper.schedule

When the cron will run to perform backup for zookeeper

vid-maintenance.backup.elasticsearch.enable

Enable the ElasticSearch backup using VeridiumID script

vid-maintenance.backup.elasticsearch.keep

How many backups of ElasticSearch to keep

vid-maintenance.backup.elasticsearch.schedule

When the cron will run to perform backup for zookeeper

vid-maintenance.backup.backup.elasticsearch_backup_with_policy.enable

Enable ElasticSearch backup with Policy

vid-maintenance.backup.backup.elasticsearch_backup_with_policy.schedule

When to take Elasticsearch snapshots. For example: cron schedule that triggers every day at noon: 0 0 12 * * ?

vid-maintenance.backup.backup.elasticsearch_backup_with_policy.expire_after

How many days to keep the Elasticsearch snaphots. Be default is 30 days.

vid-maintenance.backup.backup.elasticsearch_backup_with_policy.min_count

Minim Elasticsearch snapshots retention regardless of age. By default is 5.

vid-maintenance.backup.backup.elasticsearch_backup_with_policy.max_count

Maxim Elasticsearch snapshots retention regardless of age. By default is 50.

vid-maintenance.backup.cassandraHost

Comma-separated list of hostname(s) or IP(s) of Cassandra.
This value is constructed by appending the following values from k8ssandra-deployment.yaml:
"metadata.name-spec.cassandra.datacenters[].metadata.name-service"

vid-maintenance.backup.zookeeperHost

Comma-separated list of hostname(s) or IP(s) of Zookeeper. Should be: "<NAMESPACE>-zookeeper-client"

vid-maintenance.backup.elasticsearchHost

Comma-separated list of hostname(s) or IP(s) of Elasticsearch. Should be: "<NAMESPACE>-elasticsearch-es-http"

vid-maintenance.backup.elasticsearchUser

Secret name where Elasticsearch keeps the username/password. Should be: "elasticsearch-<ENV_NO>-es-elastic-user"