Configuration
This page provides an overview of key variables used during the deployment process. These variables allow for customization based on your specific environment. For detailed descriptions and advanced configuration options, please refer to the values.yaml file within the Vectice Helm chart.
Global Values
Global values in Helm deployments with subcharts allow you to define variables accessible by all charts (main and sub) for consistent configuration across your application.
Variable
Description
Default Value
baseURL
Repository base URL
gcr.io
projectId
Project ID of the Container Repository
vectice-public
secrets
Secret that will be used to pull images
vectice-gcr-secrets
cloudProvider
Your Cloud provider, set value to gcp, aws or azure
gcp
database.host
Your SQL Instance Private IP address or name
database.username
Your SQL Instance Username
database.password
Your SQL Instance Password
database.name
Your Vectice SQL database name
vectice
database.nameKeycloak
Your Keycloak SQL database name
keycloak
database.sslEnabled
SSL communication with the SQL instance
true
appUrl
Your future Vectice url
keycloak.admin.user
Your Keycloak Admin User
keycloak.admin.password
Your Keycloak Admin Password
keycloak.config.session_idle_timeout
In seconds, session expiration after inactivity
keycloak.config.session_max_lifespan
In seconds, session expiration regardless of activity
keycloak.config.access_token_lifespan
In seconds, validity of acces token
Database connection configuration
GCP
Fill in the 3 values with the certificates from your SQL instance:
Variable
Description
Default Value
database.ssl.key
Your SQL Instance private SSL Key, encoded in base64
database.ssl.cert
Your SQL Instance private SSL Certificate, encoded in base64
database.ssl.cacert
Your SQL Instance private SSL Root Certificate, encoded in base64
AWS
Leave these 3 values empty:
Variable
Description
Default Value
database.ssl.key
Your SQL Instance private SSL Key, encoded in base64
database.ssl.cert
Your SQL Instance private SSL Certificate, encoded in base64
database.ssl.cacert
Your SQL Instance private SSL Root Certificate, encoded in base64
Azure
Leave ssl.key and ssl.cert empty.
Retrieve cacert value from Digicert website as documented in this Azure official documentation
Variable
Description
Default Value
database.ssl.key
Your SQL Instance private SSL Key, encoded in base64
database.ssl.cert
Your SQL Instance private SSL Certificate, encoded in base64
database.ssl.cacert
Your SQL Instance private SSL Root Certificate, encoded in base64
Backend values
General configurations
Variable
Description
Default Value
defaultPassword
Your initial Admin password
internalSupportEmail
Email shown at the bottom of the UI, to get help
support@vectice.com
adminEmail
Your initial Admin user
SMTP configurations
Variable
Description
Default Value
smtpTransporter
Enable email notifications or not, set to true or false
smtpOptions.host
Your SMTP host. eg. smtp.google.com
smtpOptions.port
Your SMTP port. eg. 2525
smtpOptions.secure
Set to true to enable HTTPS protocol, or false for HTTP protocol
smtpOptions.user
Your SMTP user. eg. admin
smtpOptions.password
Your SMTP password. eg. MySuperPassword123!
Storage configurations
Variable
Description
Default Value
projectStorage.bucket
Your Vectice Bucket/Container to store attachments
GCP
Variable
Description
Default Value
projectStorage.gcp.jsonkey
Your JSON key to access your Vectice GCS Bucket, encoded in base64
AWS
Variable
Description
Default Value
projectStorage.aws.region
Your AWS region
projectStorage.aws.secretAccessKey
Your IAM User Secret Key to access your Vectice S3 Bucket
projectStorage.aws.accessKeyId
Your IAM User Key ID to access your Vectice S3 Bucket
Azure
Variable
Description
Default Value
projectStorage.azure.accountName
Your Storage Account Name that stores your Blob Container
projectStorage.azure.clientid
Your Client ID
projectStorage.azure.tenantid
Your Tenant ID
projectStorage.azure.clientsecret
Your Client Secret
OpenAI configurations
Variable
Description
Default Value
api_endpoint
Endpoint to generate auto doc through OpenAI API
api_key
API Key used to communicate with the OpenAI API
api_summarize_generate_documentation_parameters
JSON parameters to fine tune the OpenAI API call (temperature etc.)
api_chat_completion_generate_documentation_parameters
JSON parameters to fine tune the OpenAI API call (temperature etc.)
prompts
Override prompts for iteration templates
system_contents
Override system contents for prompt generation
Ingress values
GCP & Azure
Variable
Description
Default Value
annotations
tls.hosts
Your future Vectice url (same as global value appUrl)
hosts.host
Your future Vectice url (same as global value appUrl)
AWS
Variable
Description
Default Value
annotations
certificatearn
arn reference of your certificate imported in Amazone Certificate Manager
tls.hosts
Your future Vectice url (same as global value appUrl)
hosts.host
Your future Vectice url (same as global value appUrl)