Edit the configuration file to define the values the installer uses during the installation process.
- Container registry settings
- Specify the container registry details the installer uses to upload images.
-
# ───────────────────────────────────────────── # CONTAINER REGISTRY [REQUIRED] # ───────────────────────────────────────────── # Registry endpoint (no trailing slash) # Examples: registry.example.com | registry.example.com:5000 REGISTRY_ENDPOINT="registry.example.com" # Registry username (write access to the 'iqstudio' organisation required) REGISTRY_USER="admin" # Registry password REGISTRY_PASSWORD="changeme"
-
Field Description Options REGISTRY_ENDPOINT Hostname of the container registry. Do not include a trailing slash. Yes REGISTRY_USER Username for registry authentication. The account must have write access to the iQ Studio organization. Yes REGISTRY_PASSWORD Password for registry authentication. Yes
- Certificate file paths
- Provide the file paths for required CA and TLS certificates.
-
# ───────────────────────────────────────────── # CERTIFICATE FILES [REQUIRED] # ───────────────────────────────────────────── # Absolute path to the Root CA certificate for your registry SSL connection CA_CERT_FILE="/path/to/ca.crt" # Absolute path to the TLS certificate and key for Istio ingress TLS_CERT_FILE="/path/to/tls.crt" TLS_KEY_FILE="/path/to/tls.key"
-
Field Description Options CA_CERT_FILE Absolute path to the root CA certificate used for the registry SSL connection. Yes TLS_CERT_FILE Absolute path to the TLS certificate for Istio ingress. Yes TLS_KEY_FILE Absolute path to the TLS private key for Istio ingress. Yes
- Application configuration
- Define application‑specific values such as the base FQDN and load balancer IP address.
-
# ───────────────────────────────────────────── # APPLICATION CONFIGURATION [REQUIRED] # ───────────────────────────────────────────── # Base FQDN — all services are exposed as subdomains of this domain # Example: iqstudio.example.com DEFAULT_FQDN="iqstudio.example.com" # External IP of the LoadBalancer that fronts Istio ingress LOADBALANCER_IP="192.168.1.100"
-
Field Description Options DEFAULT_FQDN Base fully qualified domain name for iQ Studio. All services are exposed as subdomains of this value. Yes LOADBALANCER_IP External IP address of the load balancer that fronts the Istio ingress gateway. Yes
- Storage class settings
- Specify the storage classes used for persistent and non‑persistent workloads.
-
# ───────────────────────────────────────────── # STORAGE CLASSES [REQUIRED] # ───────────────────────────────────────────── # Storage class with Delete reclaim policy (for non-persistent workloads) # Check available classes: kubectl get storageclass SC_DELETE="hcsf-dir-backed-studio" # Storage class with Retain reclaim policy (for persistent data) SC_RETAIN="hcsf-fs-backed-retain"
-
Field Description Options SC_DELETE Name of the storage class with a Delete reclaim policy. Used for non-persistent workloads. To list available storage classes, run kubectl get storageclass. Yes SC_RETAIN Name of the storage class with a Retain reclaim policy. Used for persistent data. Yes
- Kubernetes context
- Specify the Kubernetes context the installer targets, if required.
-
# ───────────────────────────────────────────── # KUBERNETES CONTEXT [OPTIONAL] # ───────────────────────────────────────────── # Target Kubernetes context name (leave empty to use the current active context) # List available contexts: kubectl config get-contexts KUBE_CONTEXT=""
-
Field Description Options KUBE_CONTEXT Name of the target Kubernetes context. Leave empty to use the current active context. To list available contexts, run kubectl config get-contexts. No
- Configure these values based on your environment and deployment requirements.
-
============================================================================= # BUNDLE CHECKSUM VALIDATION [optional] # ============================================================================= # Expected SHA-256 checksum of the installer bundle tar.gz. # If set, the installer will verify the bundle integrity before proceeding. # Obtain this value from the "Bundle Details" section of the sign-off document. # Leave empty to skip checksum validation. BUNDLE_EXPECTED_CHECKSUM="c5e17e8e32a8c7efa224a0fab82d8d1a9ef49245fa4228fd9faef8174ff9b4e3" # ============================================================================= # GITEA REGISTRY [optional — only needed when REGISTRY_ENDPOINT contains "gitea"] # ============================================================================= # IP address of the Gitea registry service (separate from the Istio LB IP). # Only required when the registry endpoint hostname contains "gitea". # Leave empty if not using Gitea. GITEA_LB_IP="192.168.23.40" # ============================================================================= # DNS CONFIGURATION [optional] # ============================================================================= # Set to "yes" if a wildcard DNS record (*.DEFAULT_FQDN -> LOADBALANCER_IP) # is already configured externally (e.g., in your corporate DNS server). # Set to "no" (default) to have the installer patch CoreDNS automatically. DNS_CONFIGURED_EXTERNALLY="yes" # If DNS verification fails after CoreDNS patching, should the installer # automatically attempt to patch CoreDNS? ("yes" / "no") PATCH_DNS_ON_FAILURE="yes" -
Field Description Options BUNDLE_EXPECTED_CHECKSUM SHA-256 checksum of the installer bundle, obtained from the release sign-off document. Yes GITEA_LB_IP IP address of the Gitea load balancer. Set this value only (when REGISTRY_ENDPOINT contains gitea).
Example value: 192.168.23.40. Leave it empty if not using Gitea DNS_CONFIGURED_EXTERNALLY Specifies whether a wildcard DNS record (*.DEFAULT_FQDN mapped to the load balancer IP) is already configured externally. When set to yes, the installer skips CoreDNS configuration; when set to no, the installer configures CoreDNS automatically. Yes or No PATCH_DNS_ON_FAILURE Specifies whether the installer attempts to patch CoreDNS automatically if DNS verification fails after configuration. Yes or No