Skip to content

Configuration Template Files and Parameters

The following section outlines the configuration template files and parameters available with CAS Manager.

Configuration Template Files

The following section outlines how to generate template files that can be used to fill in various CAS Manager configurations:

  1. SSH to your machine where you installed CAS Manager.
  2. Run one of the following commands listed in the code block below to generate configuration template files:
    # Generate the following config templates: mongo-template.json
    sudo /usr/local/bin/cas-manager generate --mongo
    
    # Generate the following config templates: tls-template.json
    sudo /usr/local/bin/cas-manager generate --tls
    
    # Generate the following config templates: vault-template.json
    sudo /usr/local/bin/cas-manager generate --vault
    
    # Generate the following config templates: all-templates.json, mongo-template.json, tls-template.json, vault-template.json
    sudo /usr/local/bin/cas-manager generate --all-templates
    

Configuration Parameters

The following table contains all of the parameters that can be used in a configuration file to update a CAS Manager configuration.

Parameter                               Type Description Required                         
vault-type  string Specifies the type of secret store that CAS Manager should use. Currently, "vault" is the only supported value for this parameter. Required for updating Vault configuration.
vault-url string URL of the Vault server. Required for updating Vault configuration.
vault-secret-path string Vault secret path where secrets are stored. Required for updating Vault configuration.
vault-token string Token used to authenticate requests to the Vault server. Required for updating Vault configuration.
vault-ca-cert-file string Path to the file containing a PEM-formatted CA certificate that will be used to validate the Vault server's certificate. Required if the Vault server is using self-signed certificates.
vault-skip-verify-cert boolean If true, CAS Manager will not validate the Vault server's TLS certificate. This is not secure and is not recommended for production deployments. Not required. Defaults to "false".
db-connection-string string URL of the MongoDB server. Required for updating MongoDB configuration.
db-enable-tls boolean If false, requests to MongoDB will not be encrypted. Setting this parameter to false is not secure and is not recommended for production deployments. Not required. Defaults to "true".
db-skip-verify-cert boolean If true, CAS Manager will not validate the MongoDB server's TLS certificate. This is not secure and is not recommended for production deployments. Not required. Defaults to "false".
db-ca-cert-file string Path to the file containing a PEM-formatted CA certificate that will be used to validate the MongoDB server's certificate. Required if the MongoDB server is using self-signed certificates.
tls-key-file string Path to the file containing a PEM-formatted TLS key that will be used by CAS Manager. Required for updating TLS certificates used by CAS Manager.
tls-cert-file string Path to the file containing PEM-formatted TLS certificate that will be used by CAS Manager. Required for updating TLS certificates used by CAS Manager.
skip-validate-reg-code boolean If true, skip validating PCoIP registration code when creating or updating a deployment. Not required unless CAS Manager is blocking all internet traffic. Defaults to "false".