3.0.0 Helm Chart
This page documents the configurable Helm parameters for the three charts that together form a Portworx Backup deployment:
- Portworx Backup — core backup service and monitoring stack; parameters prefixed
pxbackup.*,images.*,service.*,persistentStorage.*,proxy.*,istio.*,linkerd.*,telemetry.* - Portworx License Server — optional on-prem license server; parameters prefixed
pxlicenseserver.* - Portworx Central — umbrella chart for UI, auth (Keycloak), and API server; parameters include
oidc.*,caCertsSecretName,storkRequired, and sharedimages.*
For step-by-step installation, see Install Portworx Backup. To upgrade an existing deployment, see Upgrade.
note
The tables below show all available parameters. For the minimal set of values required for a production install, follow the install guide linked above — it specifies which parameters must be overridden.
Portworx Backup parameters
note
Parameter types for complex values: Parameters with a default of {} accept a structured YAML object. Parameters with a default of [] accept a list. For example:
securityContext({runAsUser: 1000, ...}) — a YAML object with individual fields such asrunAsUser,fsGroup,runAsNonRoot.tolerations([]) — a list of Kubernetes Toleration objects, each with fields such askey,operator,value,effect.images.pullSecrets([]) — a list of Kubernetes LocalObjectReference objects, each with anamefield referencing an existing Secret.
General configuration
| Parameter | Description | Default Value |
|---|---|---|
installCRDs | Deprecated | false |
isArgoCD | Configuration for ArgoCD environment | false |
isOpenshift | Configuration for Openshift environment | false |
isUpgrade | Enable upgrade path for helm deployment | false |
securityContext | Security context for the pod | {runAsUser: 1000, fsGroup: 1000, runAsNonRoot: true} |
pxbackup.skipValidations | Disable validations part of health-check prior to install/upgrade | false |
tolerations | Tolerations for PX deployments | [] |
pxbackup.alertmanager.replicas | Replicas of Alertmanager instance | 2 |
pxbackup.alertmanager.retention | Retention time for Alertmanager | 2208h |
pxbackup.alertmanagerEndpoint | Endpoint of existing alertmanager required for Portworx Backup | "" |
pxbackup.alertmanagerSecretName | Secret name of the kubernetes secret created to hold alertmanager credentials | "" |
pxbackup.callHome | Deprecated | "false" |
pxbackup.dashboardMetricsBackfillDays | Retention window (in days) for dashboard UI metric samples (pxbackup_backup_status, pxbackup_restore_status, pxbackup_cluster_status, pxbackup_backup_location_status). Accepts an integer between 30 and 90; values outside this range are clamped (warning logged); unset or non-numeric values fall back to the default. Value is read once at pod startup; a helm upgrade that updates this value triggers a rolling restart of the px-backup pod. | 90 |
pxbackup.backupInfoMetricsBackfillHours | Retention window (in hours) for pxbackup_backup_object_info and related info metrics (pxbackup_virtual_machine_info, pxbackup_backup_volume_info, pxbackup_virtual_machine_resource_info, pxbackup_namespace_resource_info). Set to 0 to disable these metrics entirely. Maximum is 720 (30 days). | 24 |
pxbackup.deployDedicatedMonitoringSystem | Deploy Portworx Backup monitoring stack | true |
pxbackup.enableMonitorBLHealth | Deprecated | "false" |
pxbackup.enabled | Enable Portworx Backup | false |
pxbackup.encryptMongoDB | Enable or disable encryption for MongoDB | false |
pxbackup.mongoMigration | Deprecated. Flag for mongo migration while upgrading Portworx Backup from 1.2.x to 2.x.x | complete |
pxbackup.monitorBLHealthFrequency | Deprecated | "210m" |
pxbackup.nfs.enabled | Deprecated | "true" |
pxbackup.prometheus.replicas | Replicas of Prometheus instance | 2 |
pxbackup.prometheus.retention | Retention time for Prometheus | 90d |
pxbackup.prometheusEndpoint | Endpoint of existing prometheus required for Portworx Backup | "" |
pxbackup.prometheusSecretName | Secret name of the kubernetes secret created to hold prometheus credentials | "" |
pxbackup.usePxBackupEmailAlertTemplate | Use Portworx Backup's email template | true |
pxbackup.backupDeleteWorker | Number of worker threads that will be working on deletion of backup objects concurrently | "5" |
pxbackup.volDeleteWorker | Number of worker threads that will be working on deletion of volumes present in the backup objects concurrently | "5" |
pxbackup.enableExternalMetricsScraping | Enable external Prometheus metrics scraping for Portworx Backup | false |
pxbackup.federated | Enable federated mode for Portworx Backup | false |
pxbackup.usePlatformRbac | Use platform RBAC for Portworx Backup access control | false |
Note: pxbackup.dashboardMetricsBackfillDays parameter does not affect pxbackup_backup_object_info and its related info metrics. Those metrics are controlled by pxbackup.backupInfoMetricsBackfillHours.
caution
Setting pxbackup.dashboardMetricsBackfillDays to a value greater than 90 (for example, 365) does not give you a year of retention — values above 90 are silently clamped to 90 days. The effective maximum retention for dashboard alerting metrics is always 90 days, regardless of the value set.
Service configuration
| Parameter | Description | Default Value |
|---|---|---|
service.pxBackupUIServiceAnnotations | Annotations for the Portworx Backup UI service | "{}" |
service.pxBackupUIServiceType | Service type of Portworx Backup UI | "LoadBalancer" |
Persistent storage
| Parameter | Description | Default Value |
|---|---|---|
persistentStorage.alertManager.storage | Alertmanager volume retention size | 2Gi |
persistentStorage.mongoCacheSize | MongoDB cache size in GB | "4" |
persistentStorage.mongodbVolumeSize | MongoDB volume size | "64Gi" |
persistentStorage.preInstallHookVolumeSize | Persistent storage for pre-install hook | 2Gi |
persistentStorage.preUpgradeHookVolumeSize | Pre-upgrade hook volume size | "65Gi" |
persistentStorage.prometheus.retentionSize | Prometheus volume retention size | 50Gi |
persistentStorage.prometheus.storage | Prometheus volume size | 64Gi |
persistentStorage.telemetryVolumeSize | Telemetry volume size | "10Gi" |
Proxy configuration
| Parameter | Description | Default Value |
|---|---|---|
proxy.azureProxyEnabled | Adds Azure proxy annotations for pods to bypass proxy | false |
proxy.configSecretName | Specifies the name of the Kubernetes Secret containing proxy settings for Portworx Backup components | "" |
proxy.excludeAzureProxyList | List of microservices to exclude from adding Azure proxy annotation | [] |
proxy.http | HTTP endpoint of proxy server | "" |
proxy.httpProxy.noProxy | Configurations to be applied in no_proxy/NO_PROXY ENV for pods to bypass proxy | "" |
proxy.https | HTTPS endpoint of proxy server | "" |
proxy.includeNoProxyList | List of microservices to include for adding no_proxy/NO_PROXY configuration | [] |
Container images
| Parameter | Description | Default Value |
|---|---|---|
images | Portworx Backup deployment images | "" |
images.registry | Global image registry override for all images | "" |
images.repo | Global image repository override for all images | "" |
images.insecureRegistry | Allow insecure image registry | false |
images.pullPolicy | Image pull policy | Always |
images.pullSecrets | Image pull secrets | [] |
images.mongodbImage.registry | Portworx Backup mongodb image registry | docker.io |
images.mongodbImage.repo | Portworx Backup mongodb image repo | portworx |
images.mongodbImage.imageName | Portworx Backup mongodb image name | mongodb |
images.mongodbImage.tag | Portworx Backup mongodb image tag | 8.0.20 |
images.mongodbImageMap.tags.mongodb5 | Portworx Backup mongodb version 5.x image tag | 5.0.24-debian-11-r20 |
images.mongodbImageMap.tags.mongodb6 | Portworx Backup mongodb version 6.x image tag | 6.0.13-debian-11-r21 |
images.mongodbImageMap.tags.mongodb7 | Portworx Backup mongodb version 7.x image tag | 7.0.15-debian-12-r2 |
images.mongodbImageMap.tags.mongodb8 | Portworx Backup mongodb version 8.x image tag | |
images.preSetupHookImage.registry | Portworx Backup pre-setup hook image registry | docker.io |
images.preSetupHookImage.repo | Portworx Backup pre-setup hook image repo | portworx |
images.preSetupHookImage.imageName | Portworx Backup pre-setup hook image name | pxcentral-onprem-hook |
images.preSetupHookImage.tag | Portworx Backup pre-setup hook image tag | 3.0.0 |
images.pxBackupAlertmanagerImage.registry | Portworx Backup alertmanager image registry | docker.io |
images.pxBackupAlertmanagerImage.repo | Portworx Backup alertmanager image repo | portworx |
images.pxBackupAlertmanagerImage.imageName | Portworx Backup alertmanager image name | alertmanager |
images.pxBackupAlertmanagerImage.tag | Portworx Backup alertmanager image tag | v0.32.1 |
images.pxBackupImage.registry | Portworx Backup image registry | docker.io |
images.pxBackupImage.repo | Portworx Backup image repo | portworx |
images.pxBackupImage.imageName | Portworx Backup image name | px-backup |
images.pxBackupImage.tag | Portworx Backup image tag | 3.0.0 |
images.pxBackupPrometheusConfigReloaderImage.registry | Portworx Backup prometheus config reloader image registry | docker.io |
images.pxBackupPrometheusConfigReloaderImage.repo | Portworx Backup prometheus config reloader image repo | portworx |
images.pxBackupPrometheusConfigReloaderImage.imageName | Portworx Backup prometheus config reloader image name | prometheus-config-reloader |
images.pxBackupPrometheusConfigReloaderImage.tag | Portworx Backup prometheus config reloader image tag | v0.91.0 |
images.pxBackupPrometheusImage.registry | Portworx Backup prometheus image registry | docker.io |
images.pxBackupPrometheusImage.repo | Portworx Backup prometheus image repo | portworx |
images.pxBackupPrometheusImage.imageName | Portworx Backup prometheus image name | prometheus |
images.pxBackupPrometheusImage.tag | Portworx Backup prometheus image tag | v2.35.0 |
images.pxBackupPrometheusOperatorImage.registry | Portworx Backup prometheus operator image registry | docker.io |
images.pxBackupPrometheusOperatorImage.repo | Portworx Backup prometheus operator image repo | portworx |
images.pxBackupPrometheusOperatorImage.imageName | Portworx Backup prometheus operator image name | prometheus-operator |
images.pxBackupPrometheusOperatorImage.tag | Portworx Backup prometheus operator image tag | v0.91.0 |
images.telemetryEnvoyImage.registry | Portworx Backup telemetry envoy image registry | pure-artifactory.dev.purestorage.com/px-docker-remote |
images.telemetryEnvoyImage.repo | Portworx Backup telemetry envoy image repo | portworx |
images.telemetryEnvoyImage.imageName | Portworx Backup telemetry envoy image name | telemetry-envoy |
images.telemetryEnvoyImage.tag | Portworx Backup telemetry envoy image tag | 1.1.18 |
images.telemetryRegistrationImage.registry | Portworx Backup telemetry registration image registry | pure-artifactory.dev.purestorage.com/px-docker-remote |
images.telemetryRegistrationImage.repo | Portworx Backup telemetry registration image repo | portworx |
images.telemetryRegistrationImage.imageName | Portworx Backup telemetry registration image name | ccm-go |
images.telemetryRegistrationImage.tag | Portworx Backup telemetry registration image tag | 1.4.42 |
images.telemetryMetricsCollectorImage.registry | Portworx Backup telemetry metrics collector image registry | pure-artifactory.dev.purestorage.com/px-docker-remote |
images.telemetryMetricsCollectorImage.repo | Portworx Backup telemetry metrics collector image repo | portworx |
images.telemetryMetricsCollectorImage.imageName | Portworx Backup telemetry metrics collector image name | realtime-metrics |
images.telemetryMetricsCollectorImage.tag | Portworx Backup telemetry metrics collector image tag | 1.0.36 |
images.telemetryDataCollectorImage.registry | Portworx Backup telemetry data collector image registry | pure-artifactory.dev.purestorage.com/px-docker-remote |
images.telemetryDataCollectorImage.repo | Portworx Backup telemetry data collector image repo | portworx |
images.telemetryDataCollectorImage.imageName | Portworx Backup telemetry data collector image name | px-backup-telemetry-collector-base |
images.telemetryDataCollectorImage.tag | Portworx Backup telemetry data collector image tag | 3.0.0 |
images.telemetryLogUploadImage.registry | Portworx Backup telemetry log upload image registry | pure-artifactory.dev.purestorage.com/px-docker-remote |
images.telemetryLogUploadImage.repo | Portworx Backup telemetry log upload image repo | portworx |
images.telemetryLogUploadImage.imageName | Portworx Backup telemetry log upload image name | log-upload |
images.telemetryLogUploadImage.tag | Portworx Backup telemetry log upload image tag | px-1.1.148 |
Istio parameters
| Parameter | Description | Default Value |
|---|---|---|
istio.enabled | Enable Istio service mesh integration | false |
istio.hostName | Istio hostname for ingress gateway | "" |
Linkerd parameters
| Parameter | Description | Default Value |
|---|---|---|
linkerd.enabled | Enable Linkerd service mesh integration | false |
Telemetry parameters
| Parameter | Description | Default Value |
|---|---|---|
telemetry.enabled | Enable telemetry for Portworx Backup | false |
telemetry.metricsCollector.enabled | Enable telemetry metrics collector | false |
telemetry.metricsCollector.scrapeInterval | Metrics scrape interval in seconds | 10 |
telemetry.logsCollector.enabled | Enable telemetry logs collector | true |
telemetry.logsCollector.collectionInterval | Log collection interval in seconds | 3600 |
telemetry.logsCollector.excludePodPatterns | Comma-separated list of pod name patterns to exclude from log collection | "alertmanager,prometheus,telemetry" |
Portworx License Server parameters
The following tables list the configurable parameters of the Portworx License Server chart and their default values.
License server configuration
| Parameter | Description | Default Value |
|---|---|---|
pxlicenseserver | Portworx license server deployment | see sub-keys |
pxlicenseserver.adminUserName | Portworx license server admin username | admin |
pxlicenseserver.adminUserPassword | Portworx license server admin user password | Adm1n!Ur |
pxlicenseserver.backupNodeIP | External license server backup node endpoints | `` |
pxlicenseserver.enabled | Portworx Central cluster enabled license server component | false |
pxlicenseserver.external.enabled | External license server enabled | false |
pxlicenseserver.internal | Portworx Central cluster license server | `` |
pxlicenseserver.internal.enabled | Portworx Central cluster license server enabled | true |
pxlicenseserver.internal.lsTypeAirgapped | Portworx license server deployment type [Air-gapped] | false |
pxlicenseserver.internal.lsTypeUAT | Portworx license server deployment type [UAT] | false |
pxlicenseserver.mainNodeIP | External license server main node endpoints | `` |
securityContext | Security context for the pod | {runAsUser: 1000, fsGroup: 1000, runAsNonRoot: true} |
tolerations | Tolerations for PX deployments | [] |
images.licenseServerImage | License server images | `` |
images.licenseServerImage.registry | License server image registry | docker.io |
images.licenseServerImage.repo | License server image repo | portworx |
images.licenseServerImage.imageName | License server image name | px-els |
images.licenseServerImage.tag | License server image tag | 2.8.0 |
Container images
| Parameter | Description | Default Value |
|---|---|---|
images | Portworx license server images | `` |
images.pullPolicy | Image pull policy | Always |
images.pullSecrets | Image pull secrets | [] |
Portworx Central parameters
General configuration
| Parameter | Description | Default Value |
|---|---|---|
caCertsSecretName | Name of the Kubernetes Secret, which contains the CA Certificates. | "" |
installCRDs | Deprecated | false |
nodeAffinityLabel | Label for node affinity for px-central components | "" |
operatorToChartUpgrade | Deprecated, Runs Postgresql db as user "1001" | false |
podAntiAffinity | PodAntiAffinity will make sure pods are distributed | false |
postInstallJob.sslEnabled | Kubernetes APIs with SSL enabled in post-install-job pod | true |
securityContext | Security context for the pod | {runAsUser: 1000, fsGroup: 1000, runAsNonRoot: true} |
storkRequired | Set to true to use Stork as the scheduler for PX-Central components. Stork must be installed separately before enabling this; see Install Stork. For compatible Stork versions, see the compatibility matrix. | false |
tolerations | Tolerations for PX deployments | [] |
Service configuration
| Parameter | Description | Default Value |
|---|---|---|
service.pxCentralUIServiceAnnotations | Annotations for PX-Central UI service | "{}" |
service.pxCentralUIServiceType | Service type of PX-Central UI | "LoadBalancer" |
Persistent storage
| Parameter | Description | Default Value |
|---|---|---|
persistentStorage | Persistent storage for all px-central components | "" |
persistentStorage.enabled | Enable persistent storage | true |
persistentStorage.keycloakBackendVolumeSize | Keycloak backend volume size | "10Gi" |
persistentStorage.keycloakThemeVolumeSize | Keycloak frontend theme volume size | "5Gi" |
persistentStorage.mysqlVolumeSize | MySQL volume size | "100Gi" |
persistentStorage.storageClassName | Provide storage class name which exists | "" |
OIDC authentication
| Parameter | Description | Default Value |
|---|---|---|
oidc | Enable OIDC for Portworx Central and Portworx Backup for RBAC | "" |
oidc.centralOIDC | Portworx Central OIDC | "" |
oidc.centralOIDC.clientId | PX-Central OIDC client id | pxcentral |
oidc.centralOIDC.defaultEmail | Portworx Central OIDC admin user email | admin@portworx.com |
oidc.centralOIDC.defaultUsername | Portworx Central OIDC username | admin |
oidc.centralOIDC.enabled | Portworx Central OIDC | true |
oidc.centralOIDC.keyCloakBackendUserName | Keycloak backend store username | keycloak |
oidc.centralOIDC.updateAdminProfile | Enable/Disable admin profile update action | true |
oidc.externalOIDC | Enable external OIDC provider | "" |
oidc.externalOIDC.clientID | External OIDC client ID | "" |
oidc.externalOIDC.clientSecret | External OIDC client secret | "" |
oidc.externalOIDC.enabled | Enable external OIDC provider | false |
oidc.externalOIDC.endpoint | External OIDC endpoint | "" |
Container images
| Parameter | Description | Default Value |
|---|---|---|
images.pullPolicy | Image pull policy | Always |
images.pullSecrets | Image pull secrets | [] |
images.keycloakBackendImage.registry | Portworx Backup keycloak backend image registry | docker.io |
images.keycloakBackendImage.repo | Portworx Backup keycloak backend image repo | portworx |
images.keycloakBackendImage.imageName | Portworx Backup keycloak backend image name | postgresql |
images.keycloakBackendImage.tag | Portworx Backup keycloak backend image tag | 18.4 |
images.keycloakFrontendImage.registry | Portworx Backup keycloak frontend image registry | docker.io |
images.keycloakFrontendImage.repo | Portworx Backup keycloak frontend image repo | portworx |
images.keycloakFrontendImage.imageName | Portworx Backup keycloak frontend image name | keycloak |
images.keycloakFrontendImage.tag | Portworx Backup keycloak frontend image tag | 26.5.7_v2 |
images.keycloakInitContainerImage.registry | Portworx Backup keycloak init container image registry | docker.io |
images.keycloakInitContainerImage.repo | Portworx Backup keycloak init container image repo | portworx |
images.keycloakInitContainerImage.imageName | Portworx Backup keycloak init container image name | busybox |
images.keycloakInitContainerImage.tag | Portworx Backup keycloak init container image tag | 1.35.0 |
images.keycloakLoginThemeImage.registry | Portworx Backup keycloak login theme image registry | docker.io |
images.keycloakLoginThemeImage.repo | Portworx Backup keycloak login theme image repo | portworx |
images.keycloakLoginThemeImage.imageName | Portworx Backup keycloak login theme image name | keycloak-login-theme |
images.keycloakLoginThemeImage.tag | Portworx Backup keycloak login theme image tag | 3.0.0 |
images.mysqlImage.registry | Portworx Central cluster store mysql image registry | docker.io |
images.mysqlImage.repo | Portworx Central cluster store mysql image repo | portworx |
images.mysqlImage.imageName | Portworx Central cluster store mysql image name | mysql |
images.mysqlImage.tag | Portworx Central cluster store mysql image tag | 8.4.9 |
images.mysqlInitImage.registry | Portworx Central mysql init container image registry | docker.io |
images.mysqlInitImage.repo | Portworx Central mysql init container image repo | portworx |
images.mysqlInitImage.imageName | Portworx Central mysql init container image name | busybox |
images.mysqlInitImage.tag | Portworx Central mysql init container image tag | 1.35.0 |
images.postInstallSetupImage.registry | Portworx Backup post install setup image registry | docker.io |
images.postInstallSetupImage.repo | Portworx Backup post install setup image repo | portworx |
images.postInstallSetupImage.imageName | Portworx Backup post install setup image name | pxcentral-onprem-post-setup |
images.postInstallSetupImage.tag | Portworx Backup post install setup image tag | 3.0.0 |
images.pxcentralApiServerImage.registry | API server image registry | docker.io |
images.pxcentralApiServerImage.repo | API server image repo | portworx |
images.pxcentralApiServerImage.imageName | API server image name | pxcentral-onprem-api |
images.pxcentralApiServerImage.tag | API server image tag | 3.0.0 |
images.pxcentralBackendImage.registry | Portworx Central backend image registry | docker.io |
images.pxcentralBackendImage.repo | Portworx Central backend image repo | portworx |
images.pxcentralBackendImage.imageName | Portworx Central backend image name | pxcentral-onprem-ui-backend |
images.pxcentralBackendImage.tag | Portworx Central backend image tag | 3.0.0 |
images.pxcentralFrontendImage.registry | Portworx Central frontend image registry | docker.io |
images.pxcentralFrontendImage.repo | Portworx Central frontend image repo | portworx |
images.pxcentralFrontendImage.imageName | Portworx Central frontend image name | pxcentral-onprem-ui-frontend |
images.pxcentralFrontendImage.tag | Portworx Central frontend image tag | 3.0.0 |
images.pxcentralMiddlewareImage.registry | Portworx Central middleware image registry | docker.io |
images.pxcentralMiddlewareImage.repo | Portworx Central middleware image repo | portworx |
images.pxcentralMiddlewareImage.imageName | Portworx Central middleware image name | pxcentral-onprem-ui-lhbackend |
images.pxcentralMiddlewareImage.tag | Portworx Central middleware image tag | 3.0.0 |