You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Supported configuration variables are listed in the table below. All variables can also be specified on the command line. Values specified on the command line will override all values in configuration defaults files.
Tool uses the jump server to interact with rwx filestore, that needs to be pre-mounted to JUMP_SVR_RWX_FILESTORE_PATH, when V4_CFG_MANAGE_STORAGE is set true.
Name
Description
Type
Default
Required
Notes
Tasks
JUMP_SVR_HOST
ip/fqn to the jump host
string
true
baseline, viya
JUMP_SVR_USER
ssh user to access the jump host
string
true
baseline, viya
JUMP_SVR_PRIVATE_KEY
Path to ssh user private key to access the jump host
string
true
baseline, viya
JUMP_SVR_RWX_FILESTORE_PATH
Path on jump server to nfs mount
string
/viya-share
false
viya
Storage
Name
Description
Type
Default
Required
Notes
Tasks
V4_CFG_MANAGE_STORAGE
Should the tool manage the storageclass
bool
true
false
Set to false if you wish to manage the storage class
all
V4_CFG_STORAGECLASS
Storageclass name
string
"sas"
false
When V4_CFG_MANAGE_STORAGE is false, set to the name of your preexisting storage class that supports ReadWriteMany
baseline, viya
RWX Filestore
Name
Description
Type
Default
Required
Notes
Tasks
V4_CFG_RWX_FILESTORE_ENDPOINT
NFS ip/host
string
false
baseline, viya
V4_CFG_RWX_FILESTORE_PATH
NFS export path
string
/export
false
baseline, viya
V4_CFG_RWX_FILESTORE_ASTORES_PATH
NFS path to astores dir
string
<V4_CFG_RWX_FILESTORE_PATH>/<NAMESPACE>/astores
false
viya
V4_CFG_RWX_FILESTORE_BIN_PATH
NFS path to bin dir
string
<V4_CFG_RWX_FILESTORE_PATH>/<NAMESPACE>/bin
false
viya
V4_CFG_RWX_FILESTORE_DATA_PATH
NFS path to data dir
string
<V4_CFG_RWX_FILESTORE_PATH>/<NAMESPACE>/data
false
viya
V4_CFG_RWX_FILESTORE_HOMES_PATH
NFS path to homes dir
string
<V4_CFG_RWX_FILESTORE_PATH>/<NAMESPACE>/homes
false
viya
Azure
When setting V4_CFG_MANAGE_STORAGE to true, A new storage classes will be created: sas (Azure Netapp or NFS)
AWS
When setting V4_CFG_MANAGE_STORAGE to true, the efs-provisioner will be deployed. A new storage classes will be created: sas (EFS or NFS)
GCP
When setting V4_CFG_MANAGE_STORAGE to true, A new storage classes will be created: sas (Google Filestore or NFS)
Order
Name
Description
Type
Default
Required
Notes
Tasks
V4_CFG_ORDER_NUMBER
SAS order number
string
true
viya
V4_CFG_CADENCE_NAME
Cadence name
string
lts
false
[stable,lts]
viya
V4_CFG_CADENCE_VERSION
Cadence version
string
"2020.1"
true
This value must be surrounded by quotation marks to accommodate the updated SAS Cadence Version format. If the value is not quoted the deployment will fail.
Possible values: "public", "private". Setting this option to "private" adds options to the Ingress Controller that create a LoadBalancer with private IP(s) only.
Supported values: [full-stack,front-door,disabled.] When deploying full-stack you must set V4_CFG_TLS_TRUSTED_CA_CERTS to trust external postgres server ca.
all
V4_CFG_TLS_CERT
Path to ingress certificate file
string
false
If specified, used instead of cert-manager issued certificates
viya
V4_CFG_TLS_KEY
Path to ingress key file
string
false
Required when V4_CFG_TLS_CERT is specified
viya
V4_CFG_TLS_TRUSTED_CA_CERTS
Path to directory containing only PEM encoded trusted CA certificates files
string
false
Required when using an external database and TLS is enabled and the deployment target is an IAC created AWS or Open Source Kubernetes cluster. See the Trusted CA Certs for AWS and Open Source Kubernetes cert information. Required when V4_CFG_TLS_CERT is specified. Must include all the CAs in the trust chain for V4_CFG_TLS_CERT. Can be used with or without V4_CFG_TLS_CERT to specify any additionally trusted CAs
viya
V4_CFG_TLS_DURATION
Certificate time to expiry in hours
int
17531
false
See note below
viya
V4_CFG_TLS_ADDITIONAL_SAN_DNS
A space separated list of additional SAN DNS entries that you want added to generated certificates.
string
false
See note below
viya
V4_CFG_TLS_ADDITIONAL_SAN_IP
A space separated list of additional SAN IP addresses that you want added to generated certificates.
string
false
See note below
viya
Notes:
Values can be used to configure the tls generator when V4_CFG_TLS_MODE is not set to disabled and one of the following conditions is met.
V4_CFG_TLS_GENERATOR is set to cert-manager and no V4_CFG_TLS_CERT/V4_CFG_TLS_KEY are defined
V4_CFG_TLS_GENERATOR is set to openssl and no V4_CFG_TLS_CERT/V4_CFG_TLS_KEY are defined
Postgres
Postgres servers can be defined with the postgres_servers variable which is a map of objects. The variable has the following format:
Numeric value followed by the units, such as 32Gi for 32 gigabytes. In Kubernetes, the units for gigabytes is Gi. Leave empty to enable auto-resource assignment
viya
V4_CFG_CAS_CORES
Amount of cpu cores to allocate per CAS node
string
false
Either a whole number, representing that number of cores, or a number followed by m, indicating that number of milli-cores. Leave empty to enable auto-resource assignment
viya
V4_CFG_CAS_WORKER_COUNT
Number of CAS workers
int
1
false
Setting to more than one triggers MPP deployment
viya
V4_CFG_CAS_ENABLE_BACKUP_CONTROLLER
Enable backup cas controller
bool
false
false
viya
V4_CFG_CAS_ENABLE_LOADBALANCER
Setup LB to access CAS binary ports
bool
false
false
viya
CONNECT
Name
Description
Type
Default
Required
Notes
Tasks
V4_CFG_CONNECT_ENABLE_LOADBALANCER
Setup LB to access SAS/CONNECT
bool
false
false
viya
V4_CFG_CONNECT_FQDN
FQDN that will be assigned to access SAS/CONNECT
string
false
Required when V4_CFG_TLS_MODE is not disabled and cert-manager is used to issue TLS certificates. This FQDN will be added to the SAN DNS list of the issued certificates.
viya
Miscellaneous
Name
Description
Type
Default
Required
Notes
Tasks
V4_CFG_CLUSTER_NODE_POOL_MODE
What mode of cluster node pool to use
string
"standard"
false
[standard, minimal]
viya
V4_CFG_EMBEDDED_LDAP_ENABLE
Deploy openldap in the namespace for authentication
With the two Viya scheduling variables, V4_CFG_VIYA_START_SCHEDULE and V4_CFG_VIYA_STOP_SCHEDULE. If you define one and not the other, it will result in a suspended cronjob for the variable that was not defined.
For example, defining V4_CFG_VIYA_STOP_SCHEDULE and not V4_CFG_VIYA_START_SCHEDULE will result in a Viya stop job that runs on a schedule and a suspended Viya start job that you will be able to manually trigger.
Defining both V4_CFG_VIYA_START_SCHEDULE and V4_CFG_VIYA_STOP_SCHEDULE will result in a non-suspended Viya start and stop job that runs on the schedule you defined.
If left as "" (empty string), version 3.40.0 will be used for K8s clusters whose version is <= 1.21.X and version 4.2.3 will be used for K8s clusters whose version is >= 1.22.X
baseline
INGRESS_NGINX_CONFIG
ingress-nginx helm values
string
see here Altering this value will affect the cluster
false
baseline
Metrics Server
Metric server is currently only used for AWS EKS clusters. GCP GKE and Azure AKS already have a metric server provided by default.
Two modes of data isolation (schemaPerApplicationTenant, databasePerTenant) for tenant data. schemaPerApplicationTenant is default.
viya, multi-tenancy
V4MT_TENANT_IDS
Maps to SAS_TENANT_IDS. One or more tenant IDs to onboard or offboard
string
false
Example: Single tenant ID: "acme" or Multiple tenant IDs: "acme, cyberdyne, intech". Tenant IDs have a few naming restrictions, See the details here
viya, multi-tenancy
V4MT_PROVIDER_PASSWORD
Optional: The password that is applied to the tenant administrator on each onboarded tenant
string
false
Maps to SAS_PROVIDER_PASSWORD. When V4MT_PROVIDER_PASSWORD is specified V4MT_PROVIDER_PASSWORD_{{TENANT-ID}} can not be used. See details here
multi-tenancy
V4MT_PROVIDER_PASSWORD_{{TENANT-ID}}
Optional: Unique sasprovider password for each tenant being onboarded. {{TENANT-ID}} must be in uppercase
string
false
Maps to SAS_PROVIDER_PASSWORD_{{TENANT-ID}}. When V4MT_PROVIDER_PASSWORD_{{TENANT-ID}} is specified V4MT_PROVIDER_PASSWORD can not be used. See details here
multi-tenancy
V4MT_TENANT_CAS_CUSTOMIZATION
Map of objects with all tenant CAS customization variables. See the format below
false
multi-tenancy
Tenant CAS Customization
Some of the tenant CAS customizations can be defined with the V4MT_TENANT_CAS_CUSTOMIZATION variable which is a map of objects. The variable has the following format: