files/arthur-docs-markdown/platform-management/reference/config_template.md.txt

# Configuration File Template

The Configuration template for Arthur version `3.2.1` is below:

```yaml
apiVersion: kots.io/v1beta1
kind: ConfigValues
metadata:
  creationTimestamp: null
  name: arthur
spec:
  values:
    IAM_permission_type:
      default: access_keys
    advanced_cache_options:
      default: "0"
    advanced_messaging_connect_cpu_limits:
      default: "2"
    advanced_messaging_connect_cpu_limits_not_validate: {}
    advanced_messaging_connect_cpu_requests:
      default: "1"
    advanced_messaging_connect_cpu_requests_not_validate: {}
    advanced_messaging_connect_heap_options:
      default: -Xms1g -Xmx3g
    advanced_messaging_connect_memory_limits:
      default: 4Gi
    advanced_messaging_connect_memory_limits_not_validate: {}
    advanced_messaging_connect_memory_requests:
      default: 2Gi
    advanced_messaging_connect_memory_requests_not_validate: {}
    advanced_olap_options:
      default: "0"
    advanced_other:
      default: "0"
      value: "1"
    alert_service_update_rule_metrics:
      default: "0"
    api_token_ttl:
      default: "24"
    arthur_user_id:
      default: "1000"
    audit_log_event_bridge_bus_name: {}
    audit_log_event_bridge_bus_region: {}
    audit_log_event_bridge_detail_type:
      default: events.arthur.ai
    audit_log_event_bridge_source:
      default: arthur-audit-log
    audit_log_sink_destination:
      default: none
    batch_workflow_parallelism:
      default: "120"
    beta_ui:
      default: "0"
    beta_ui_alternate_site:
      default: "0"
    beta_ui_hostname: {}
    bootstrap_job_backoff_limit:
      default: "100"
    bootstrap_job_ttl:
      default: "86400"
    cache_cpu_limits: {}
    cache_cpu_limits_not_validate: {}
    cache_cpu_requests: {}
    cache_cpu_requests_not_validate: {}
    cache_memory_limits: {}
    cache_memory_limits_not_validate: {}
    cache_memory_requests: {}
    cache_memory_requests_not_validate: {}
    cache_password:
      default: SuperSecret
      value: VwC3tnE9cpzObSxIhTx9U/34Ky+mA6p8veb9bCk+iqcAEaOarGzGEFf7ozoGxO3m05QY5YTuIx3ezMI694TUX0gj7RHSyHoK
    cache_replicas:
      default: "0"
    cicd_credentials:
      default: "0"
    cluster_nodes:
      # Only Relevant for "fixed" cluster sizes.  Enter the number of nodes in the cluster. This number cannot be decreased from the current value unless it's greater than `6`.
      default: "1"
      value: "3"
    config_job_and_workflow_retention:
      default: "0"
    database_admin_password:
      default: SuperSecret
      value: VwC3tnE9cpzObSxIhTx9U/34Ky+mA6p8veb9bCk+iqcAEaOarGzGEFf7ozoGxO3m05QY5YTuIx3ezMI694TUX0gj7RHSyHoK
    database_hostname:
      # Leave the default configuration to use the embedded database. If you would like to use an external Postgres instance, provide the hostname here and follow this guide: https://docs.arthur.ai/platform-management/installation/externalize_postgres.html.
      default: database-primary
    database_password:
      default: SuperSecret
      value: VwC3tnE9cpzObSxIhTx9U/34Ky+mA6p8veb9bCk+iqcAEaOarGzGEFf7ozoGxO3m05QY5YTuIx3ezMI694TUX0gj7RHSyHoK
    database_port:
      value: "5432"
    database_ssl_mode:
      # This option allows you to enable SSL communication between services and the postgres database.  See https://www.postgresql.org/docs/10/libpq-ssl.html for full descriptions of each option.  By default, the postgres database has ssl disabled.
      default: disable
    database_username:
      default: arthurai
    default_messaging_partition_count:
      default: "3"
      value: "1"
    disable_ssl_redirect_on_ingress:
      default: "0"
    email_selection:
      default: none
    enable_audit_log:
      default: "0"
    enable_olap_backup:
      default: '"0"'
    enable_olap_backup_user:
      default: "0"
    enable_password_rotation_cache:
      default: "0"
    enable_password_rotation_olap:
      default: "0"
    existing_database_primary_pvc: {}
    existing_or_vm:
      default: existing_cluster
    fixed_or_autoscale:
      # The `fixed` mode is recommended for clusters with a fixed number of nodes. The `autoscale` mode is used for clusters that can autoscale and automatically expand their node count.
      value: fixed
    full_name_override:
      default: arthurai
    global_identity_provider:
      default: none
    global_model_limit_Count:
      default: "500"
    global_model_limits:
      default: "0"
    global_workflow_parallelism:
      default: "150"
    http_proxy: {} # Relevant if you are using Explainability and your organization is behind a proxy server.  If PIP and/or Conda need to route through the proxy server to pull down public packages this will set the environment variable HTTP_PROXY to the supplied value. Ex. http://sysproxy.my-company.com:port
    http_proxy_user: {}
    https_proxy: {}
    https_proxy_user: {}
    ingestion_service_cpu_limits: {}
    ingestion_service_cpu_limits_not_validate: {}
    ingestion_service_cpu_requests: {}
    ingestion_service_cpu_requests_not_validate: {}
    ingestion_service_memory_limits: {}
    ingestion_service_memory_limits_not_validate: {}
    ingestion_service_memory_requests: {}
    ingestion_service_memory_requests_not_validate: {}
    ingress_ambassador_enabled:
      default: "false"
    ingress_class:
      default: nginx
    ingress_hostname:
      value: arthur.mydomain.ai
    ingress_namespace_label_key:
      value: name
    ingress_namespace_label_value:
      value: ingress-system
    ingress_nginx_additional_hostname:
      value: ""
    irsa_annotations: {}
    irsa_annotations_user:
      default: |
        eks.amazonaws.com/role-arn: arn:aws:iam::111122223333:role/my-role
    k8_storageclass:
    # Provide Kubernetes StorageClass profile. Use 'gp2' for Amazon EKS, 'default' if you're using embedded Kubernetes provided by the installer
      value: default
    kafka_ecosystem_common_replication_calc:
      default: "1"
    max_arthur_replicas:
      default: "1"
    max_messaging_partition_count:
      default: "3"
    max_model_server_replicas:
      default: "2"
    messaging_cpu_limit:
      default: "1"
    messaging_heap:
      default: -Xmx2G -Xms1G
    messaging_memory_limit_and_request:
      default: 2560Mi
    messaging_rack_aware_enabled:
      default: "0"
    messaging_rack_label:
      default: topology.kubernetes.io/zone
    messaging_replicas:
      default: "3"
    messaging_sa_create:
      default: "0"
    messaging_sa_fullnameoverride: {}
    messaging_zookeeper_timeout:
      default: "20000"
    meta_replicas:
      default: "0"
    metric_service_update_default_metrics:
      default: "0"
    min_arthur_replicas:
      default: "1"
    model_servers_always_on:
      # For use with what-if and on-demand explainability. See https://docs.arthur.ai/user-guide/explainability.html  If set to "true", then on-demand and what-if explanations are available, but uses additional cluster resources, 1 CPU and 1 GB memory per model with explainability enabled. If set to "false", on-demand and what-if explanations are unavailable, but less cluster usage when there is no data being sent. Regardless of the setting here, streaming explainability will be available if enabled. This only effects what-if and on-demand explanations.
      default: "true"
    network_policy_enabled:
      default: "0"
    no_proxy: {} # Relevant if you are using Explainability and your organization is behind a proxy server.  If PIP and/or Conda need to route through the proxy server to pull down public packages this will set the environment variable NO_PROXY to the supplied value. Ex. localhost,127.0.0.1,.my-company.com
    no_proxy_user: {}
    number_of_olap_backups_to_keep:
      default: "7"
    oidc_identity_provider_config_yaml: {}
    oidc_identity_provider_config_yaml_user: {}
    olap_backup_s3_bucket:
      default: arthurai
    olap_backup_s3_bucket_region:
      default: us-east-1
    olap_backup_s3_endpoint:
      default: s3.us-east-1.amazonaws.com
    olap_backup_s3_path:
      default: olap_backups
    olap_backup_service_account:
      default: arthurai-arthurai
    olap_cpu_limits: {}
    olap_cpu_limits_not_validate: {}
    olap_cpu_requests:
      default: 1000m
    olap_cpu_requests_not_validate: {}
    olap_database_operator_password:
      # The OLAP database is installed along with a Kubernetes Operator to manage it.  This operator needs credentials to access the database.  We recommend overwriting the default password below.
      default: 5ugYLDJ2uLhRdEgz5t
      value: ch/0gntnboTNbQpxmzx4GuPCRnjqSNwTpOT6FwgQ9q4iY7CHiQLeFQ3snnZgxYnFt4gSyInce3KhYiMR7eebBtGbe5sIuY/aBPAySrSjExfO+1VYPBp176bP+zQ=
    olap_database_user_password:
      # Password used internally in our application to query the olap database, currently only supports alpha-numeric characters.
      default: eQ3iBo8UGh5zqJKQWuEEySrR
      value: ch/0gntnboTNbQppnGJgGvCjSmPlS/l8orO+UggQ/rstcryCj2r/GRXR8UNr+u3plPIj+uLMdXGGFiRtko6pTsClBoQkoeLXqDVr1jeqsThCZI/bTfovlA==
    olap_memory_limits: {}
    olap_memory_limits_not_validate: {}
    olap_memory_requests:
      default: 1Gi
    olap_memory_requests_not_validate: {}
    olap_node_label_key: {}
    olap_node_label_value: {}
    olap_replicas:
      default: "1"
    olap_zookeeper_cpu_limits: {}
    olap_zookeeper_cpu_limits_not_validate: {}
    olap_zookeeper_cpu_requests:
      default: 500m
    olap_zookeeper_cpu_requests_not_validate: {}
    olap_zookeeper_heap_options:
      default: -Xms4G -Xmx4G
    olap_zookeeper_memory_limits: {}
    olap_zookeeper_memory_limits_not_validate: {}
    olap_zookeeper_memory_requests:
      default: 1Gi
    olap_zookeeper_memory_requests_not_validate: {}
    password_rotation_cron_schedule:
      default: 0 0 1 */6 *
    pending_batch_workflows_limit:
      default: "100"
    prometheus_host:
    # Leave the default configuration if you're using the embedded K8s. Provide your Prometheus hostname if you're running your own K8s.
      default: http://kube-prometheus-stack-prometheus.monitoring.svc.cluster.local
    prometheus_labels:
      # If your prometheus installation requires labels to identify ServiceMonitors and PrometheusRules, add them here. They should be in yaml format just as you would specify inside the "metadata.labels" block. Do not indent.
      default: |
        prometheus: monitor
        app: prometheus
    prometheus_namespace:
      default: monitoring
    prometheus_port:
      # Leave the default configuration if you're using the embedded K8s. Provide your Prometheus hostname if you're running your own K8s.
      default: "9090"
    pypi_registry_conda: {} # This is set as a channel in the '.condarc' file. Do not include 'https://' prefix (e.g. repository.arthur.ai/repository/conda-proxy/main).
    pypi_registry_conda_user: {}
    pypi_registry_index: {} # This maps to the 'index key' in the 'pip.conf' file. Do not include 'https://' prefix (e.g repository.arthur.ai/repository/pypi-virtual/pypi).
    pypi_registry_index_url: {} # This maps to the 'index-url' key in the 'pip.conf' file. Do not include 'https://' prefix (e.g. repository.arthur.ai/repository/pypi-virtual/simple).
    pypi_registry_index_url_user: {}
    pypi_registry_index_user: {}
    pypi_registry_password:
      default: bO4Mxhdaevso/029YtUgz98Wk7qPcxEpa1P/uVqG4cy4UY1B3+YN5Q==
      value: VwC3tnE9cpzObSxIhTx9U/34Ky+mA6p8veb9bCk+iqcAEaOarGzGEFf7ozoGxO3m05QY5YTuIx3ezMI694TUX0gj7RHSyHoK
    pypi_registry_password_user:
      value: VwC3tnE9cpzObSxIhTx9U/34Ky+mA6p8veb9bCk+iqcAEaOarGzGEFf7ozoGxO3m05QY5YTuIx3ezMI694TUX0gj7RHSyHoK
    pypi_registry_username: {}
    pypi_registry_username_user: {}
    raw_anaconda_config: {}
    raw_anaconda_config_user: {}
    raw_pypi_config: {}
    raw_pypi_config_user: {}
    rbac_privileges:
      # Change to "cluster_scope" to install CRDs too
      default: namespace_scope
    run_as_root:
      default: "0"
      value: "0"
    s3_access_key_id:
      default: access_key
      value: VwC3tnE9cpzObSxIhTx9U/34Ky+mA6p8veb9bCk+iqcAEaOarGzGEFf7ozoGxO3m05QY5YTuIx3ezMI694TUX0gj7RHSyHoK
    s3_access_key_id_user:
      default: access_key
      value: VwC3tnE9cpzObSxIhTx9U/34Ky+mA6p8veb9bCk+iqcAEaOarGzGEFf7ozoGxO3m05QY5YTuIx3ezMI694TUX0gj7RHSyHoK
    s3_bucket:
      default: arthurai
    s3_bucket_user:
      default: arthurai
    s3_region:
      default: us-east-1
    s3_region_user:
      default: us-east-1
    s3_secret_access_key:
      default: secret_key
      value: VwC3tnE9cpzObSxIhTx9U/34Ky+mA6p8veb9bCk+iqcAEaOarGzGEFf7ozoGxO3m05QY5YTuIx3ezMI694TUX0gj7RHSyHoK
    s3_secret_access_key_user:
      default: secret_key
      value: VwC3tnE9cpzObSxIhTx9U/34Ky+mA6p8veb9bCk+iqcAEaOarGzGEFf7ozoGxO3m05QY5YTuIx3ezMI694TUX0gj7RHSyHoK
    s3_url:
      default: http://minio:9000
    s3_url_user:
      default: http://minio:9000
    saml_identity_provider_config_yaml: {}
    saml_identity_provider_config_yaml_user: {}
    secondary_token_validation_key:
      value: Aj3ziCI/YcnTT3QR3WAtMNDNEzzqTa8W9iJCoHjNFMteiO6lrcnUKw==
    ses_region: {}
    ses_role: {}
    show_advanced_arthur_microservice_options:
      default: "0"
    show_advanced_messaging:
      default: "0"
      value: "1"
    show_hidden_variables:
      default: "0"
      value: "0"
    show_token_signing_and_validation_options:
      default: "0"
    signing_cert: {}
    signing_cert_user: {}
    signing_private_key: {}
    signing_private_key_user: {}
    single_or_ha:
      # The `single` configuration is a minimal deployment suitable for non-production environments. For production deployment, select `ha`.
      value: single
    smtp_from: {} # Provide the email address to send alerts from (e.g. [email protected])
    smtp_host: {} # Provide the address of the SMTP server (e.g. smtp.arthur.ai)
    smtp_password:
      value: VwC3tnE9cpzObSxIhTx9U/34Ky+mA6p8veb9bCk+iqcAEaOarGzGEFf7ozoGxO3m05QY5YTuIx3ezMI694TUX0gj7RHSyHoK
    smtp_port: {}
    smtp_user: {}
    superadmin_email:
      default: [email protected]
    superadmin_firstname:
      default: Super
    superadmin_lastname:
      default: Admin
    superadmin_password:
      default: SuperSecret
      value: VwC3tnE9cpzObSxIhTx9U/34Ky+mA6p8veb9bCk+iqcAEaOarGzGEFf7ozoGxO3m05QY5YTuIx3ezMI694TUX0gj7RHSyHoK
    superadmin_username:
      value: superadmin
    token_signing_primary_key:
      value: YSDFzjg5I83KMBJ+wHQmU/ejDQ7tTthIpaDcCRM+iqcDTofiul7DZzTblFkb0e2U0+UJ74TuIx28oGnxPM+pkmKlc1yx2uvj
    use_external_blob_storage:
      # Select "Yes" if and only if you are supplying your own S3 compatible storage, otherwise select "No" to use the embedded blob storage.
      default: "no"
    use_external_postgres:
      default: "no"
    use_raw_python_repository_configs:
      # The PyPi registry section is only relevant when using the explainability enrichment (https://docs.arthur.ai/user-guide/enrichments.html#explainability). 
      # Provide your private PyPi registry if you have an airgapped enrivonment or your model requirements file includes packages only hosted in a private repository. 
      # Leaving this section blank will cause the public PyPi to be used. If the public PyPi is inaccessible from the cluster, the explainability feature will not work.
      default: "no"
    use_smtp:
      default: "0"
    workflow_ttl_seconds:
      default: "3600"
    workflow_ttl_seconds_after_success:
      default: "60"
status: {}
```