Helm Chart Reference

This reference provides detailed documentation on the Upbound Space Helm chart. This Helm chart contains configuration values for installation, configuration, and management of an Upbound Space deployment.

Version: 0.1.0 Type: application AppVersion: 0.1.0

KeyTypeDefaultDescription
accountstring"notdemo"
apiobjectConfigurations for the space api deployment.
api.prometheusobjectNone
api.prometheus.podMonitorobjectNone
api.prometheus.podMonitor.enabledboolfalseNone
api.prometheus.podMonitor.intervalstring"30s"None
api.proxyobjectNone
api.proxy.extraArgslist[]None
api.proxy.extraEnvlist[]None
api.proxy.imageobjectNone
api.proxy.image.pullPolicystring"IfNotPresent"None
api.proxy.image.repositorystring"mxe-api"None
api.proxy.image.tagstring"0.1.0"None
api.proxy.resourcesobjectNone
api.proxy.resources.limitsobjectNone
api.proxy.resources.limits.cpustring"1000m"None
api.proxy.resources.limits.memorystring"200Mi"None
api.proxy.resources.requestsobjectNone
api.proxy.resources.requests.cpustring"100m"None
api.proxy.resources.requests.memorystring"50Mi"None
api.proxy.serviceobjectNone
api.proxy.service.apiobjectNone
api.proxy.service.api.portint8443None
api.proxy.service.metricsobjectNone
api.proxy.service.metrics.portint8085None
api.secretRefsobjectNone
api.secretRefs.tlsSecretNamestring"mxp-hostcluster-certs"None
api.secretRefs.tokenSigningstring"cert-token-signing-gateway"None
api.serviceAccountobjectNone
api.serviceAccount.annotationsobject{}None
api.serviceAccount.createbooltrueNone
api.serviceAccount.namestring"mxe-api"None
apolloobjectConfigurations for the space api deployment.
apollo.apiserverobjectNone
apollo.apiserver.extraArgslist[]None
apollo.apiserver.extraEnvlist[]None
apollo.apiserver.imageobjectNone
apollo.apiserver.image.pullPolicystring"IfNotPresent"None
apollo.apiserver.image.repositorystring"mxe-apollo"None
apollo.apiserver.image.tagstring"0.1.0"None
apollo.apiserver.resourcesobjectNone
apollo.apiserver.resources.limitsobjectNone
apollo.apiserver.resources.limits.cpustring"1000m"None
apollo.apiserver.resources.limits.memorystring"500Mi"None
apollo.apiserver.resources.requestsobjectNone
apollo.apiserver.resources.requests.cpustring"100m"None
apollo.apiserver.resources.requests.memorystring"200Mi"None
apollo.apiserver.serviceobjectNone
apollo.apiserver.service.apiobjectNone
apollo.apiserver.service.api.portint8443None
apollo.apiserver.service.metricsobjectNone
apollo.apiserver.service.metrics.portint8085None
apollo.apiserver.service.typestring"ClusterIP"None
apollo.prometheusobjectNone
apollo.prometheus.podMonitorobjectNone
apollo.prometheus.podMonitor.enabledboolfalseNone
apollo.prometheus.podMonitor.intervalstring"30s"None
apollo.secretRefsobjectNone
apollo.secretRefs.tlsClientSecretNamestring"mxe-apollo-client-certs"None
apollo.secretRefs.tlsSecretNamestring"mxp-hostcluster-certs"None
apollo.secretRefs.tokenSigningstring"cert-token-signing-gateway"None
apollo.serviceAccountobjectNone
apollo.serviceAccount.annotationsobject{}None
apollo.serviceAccount.createbooltrueNone
apollo.serviceAccount.namestring"mxe-apollo"None
billingobjectConfigurations for space billing.
billing.enabledboolfalseNone
billing.storageobjectNone
billing.storage.aws.bucketstring""See billing.storage.secretRef for authentication. Required if billing.storage.provider=aws.
billing.storage.aws.endpointstring""None
billing.storage.aws.regionstring""Required if billing.storage.provider=aws.
billing.storage.aws.tlsobjectNone
billing.storage.aws.tls.“ca.crt”boolfalseSee billing.storage.secretRef. Set to true if the corresponding key is defined in the secret referenced by billing.storage.secretRef.name.
billing.storage.aws.tls.alpnProtocolslist[]None
billing.storage.aws.tls.verifyCertificatebooltrueNone
billing.storage.aws.tls.verifyHostnamebooltrueNone
billing.storage.azureobjectNone
billing.storage.azure.connectionStringstring""None
billing.storage.azure.containerstring""Required if billing.storage.provider=azure.
billing.storage.azure.endpointstring""None
billing.storage.azure.storageAccountstring""None
billing.storage.gcp.bucketstring""Required if billing.storage.provider=gcp.
billing.storage.gcp.tlsobjectSee billing.storage.secretRef for authentication.
billing.storage.gcp.tls.“ca.crt”boolfalseSee billing.storage.secretRef. Set to true if the corresponding key is defined in the secret referenced by billing.storage.secretRef.name.
billing.storage.gcp.tls.alpnProtocolslist[]None
billing.storage.gcp.tls.verifyCertificatebooltrueNone
billing.storage.gcp.tls.verifyHostnamebooltrueNone
billing.storage.namestring"billing-storage"Required if billing.enabled=true. The secret may contain any of these keys for configuring authentication:
AWS_ACCESS_KEY_ID: AWS access key ID. Used when provider is aws.
AWS_SECRET_ACCESS_KEY: AWS secret access key. Used when provider is aws.
AZURE_TENANT_ID: Azure tenant ID. Used when provider is azure.
AZURE_CLIENT_ID: Azure client ID. Used when provider is azure.
AZURE_CLIENT_SECRET: Azure client secret. Used when provider is azure.
AZURE_USERNAME: Azure username. Used when provider is azure.
AZURE_PASSWORD: Azure username. Used when provider is azure.
google_application_credentials: GCP service account key JSON. Used when provider is gcp.
The secret may also contain any of the following keys for configuring TLS. The corresponding value at billing.storage..tls. must also be set to true.
“ca.crt”: Custom CA certificate. Used when provider is aws or gcp.
“tls.crt”: Custom TLS certificate. Used when provider is aws or gcp.
“tls.key”: Custom TLS key. Used when provider is aws or gcp.
billing.storage.providerstring""Required if billing.enabled=true. Must be one of aws, gcp, azure
billing.storage.secretRefstringnilNone
certificatesobject{"clusterResourceNamespace":"cert-manager","provision":true,"space":{"clusterIssuer":"spaces-selfsigned"}}Given cert-manager is a requirement for installation, certificates specifies the general configurations for the certificates required for the installation to function.
certificates.provisionbooltrueSpecifies if the chart should provision the certificate resources inclused in this chart. Operators can opt to provision their own certificates instead, however care should be made to ensure the certificates match the expected:
* Shared Certificate Authority
* Algorithm. (ECDSA)
certificates.space.clusterIssuerstring"spaces-selfsigned"The clusterIssuer for the space. Most certificates used at the space level are derived from this issuer.
clusterTypestring"kind"Specifies the cluster type that this installation is being installed into.
Valid options are: aks, eks, gke, kind.
controlPlanesobjectConfigurations applied consistently across all ControlPlanes.
controlPlanes.containerobjectNone
controlPlanes.container.mxpAccountGateobjectNone
controlPlanes.container.mxpAccountGate.tagstring"0.1.0"None
controlPlanes.container.mxpAccountGateInitobjectNone
controlPlanes.container.mxpAccountGateInit.repositorystring"mxp-account-gate/initialize"None
controlPlanes.container.mxpAccountGateInit.tagstring"0.1.0"None
controlPlanes.container.mxpAuthzWebhookobjectNone
controlPlanes.container.mxpAuthzWebhook.tagstring"0.1.0"None
controlPlanes.container.mxpChartsobjectNone
controlPlanes.container.mxpCharts.tagstring"0.1.0"None
controlPlanes.container.mxpGatewayobjectNone
controlPlanes.container.mxpGateway.repositorystring"mxp-gateway"None
controlPlanes.container.mxpGateway.tagstring"0.1.0"None
controlPlanes.container.mxpHealthCheckobjectNone
controlPlanes.container.mxpHealthCheck.repositorystring"mxp-healthcheck"None
controlPlanes.container.mxpHealthCheck.tagstring"0.1.0"None
controlPlanes.container.mxpKsmConfigobjectNone
controlPlanes.container.mxpKsmConfig.tagstring"0.1.0"None
controlPlanes.etcdobjectNone
controlPlanes.etcd.persistencestringnilNone
controlPlanes.ingressobjectNone
controlPlanes.ingress.annotationsobject{}None
controlPlanes.otelcollectorobjectNone
controlPlanes.otelcollector.enabledbooltrueNone
controlPlanes.policiesobjectNone
controlPlanes.policies.limitRange.enabledbooltrueNone
controlPlanes.uxpobjectNone
controlPlanes.uxp.enableCompositionFunctionsbooltrueNone
controlPlanes.uxp.enableEnvironmentConfigsbooltrueNone
controlPlanes.uxp.enableProviderIdentityboolfalseNone
controlPlanes.uxp.metricsobjectNone
controlPlanes.uxp.metrics.enabledbooltrueNone
controlPlanes.uxp.repositorystring"https://charts.upbound.io/stable"None
controlPlanes.uxp.resourcesCrossplaneobjectUXP explicitly sets a few limits. We adjust down to what we’ve observed that we need.
controlPlanes.uxp.resourcesCrossplane.limitsobjectNone
controlPlanes.uxp.resourcesCrossplane.limits.cpustring"400m"None
controlPlanes.uxp.resourcesCrossplane.limits.memorystring"500Mi"None
controlPlanes.uxp.resourcesCrossplane.requestsobjectNone
controlPlanes.uxp.resourcesCrossplane.requests.cpustring"370m"None
controlPlanes.uxp.resourcesCrossplane.requests.memorystring"400Mi"None
controlPlanes.uxp.resourcesRBACManagerobjectNone
controlPlanes.uxp.resourcesRBACManager.limitsobjectNone
controlPlanes.uxp.resourcesRBACManager.limits.cpustring"50m"None
controlPlanes.uxp.resourcesRBACManager.limits.memorystring"300Mi"None
controlPlanes.uxp.resourcesRBACManager.requestsobjectNone
controlPlanes.uxp.resourcesRBACManager.requests.cpustring"25m"None
controlPlanes.uxp.resourcesRBACManager.requests.memorystring"256Mi"None
controlPlanes.uxp.versionstring"1.14.5-up.1"None
controlPlanes.uxp.xfnobjectNone
controlPlanes.uxp.xfn.resourcesobjectNone
controlPlanes.uxp.xfn.resources.limitsobjectNone
controlPlanes.uxp.xfn.resources.limits.cpustring"400m"None
controlPlanes.uxp.xfn.resources.limits.memorystring"500Mi"None
controlPlanes.uxp.xfn.resources.requestsobjectNone
controlPlanes.uxp.xfn.resources.requests.cpustring"370m"None
controlPlanes.uxp.xfn.resources.requests.memorystring"400Mi"None
controlPlanes.uxp.xgqlobjectNone
controlPlanes.uxp.xgql.enabledstring"true"None
controlPlanes.uxp.xgql.replicasint1None
controlPlanes.uxp.xgql.resourcesobjectNone
controlPlanes.uxp.xgql.resources.limitsobjectNone
controlPlanes.uxp.xgql.resources.limits.cpustring"500m"None
controlPlanes.uxp.xgql.resources.limits.memorystring"1Gi"None
controlPlanes.uxp.xgql.resources.requestsobjectNone
controlPlanes.uxp.xgql.resources.requests.cpustring"50m"None
controlPlanes.uxp.xgql.resources.requests.memorystring"50Mi"None
controlPlanes.uxp.xgql.versionstring"v0.2.0-rc.0.153.g0a1d4ae"None
controlPlanes.vectorobjectNone
controlPlanes.vector.debugboolfalseNone
controlPlanes.vector.enabledbooltrueNone
controlPlanes.vector.otelcollectorobjectNone
controlPlanes.vector.otelcollector.enabledbooltrueNone
controlPlanes.vector.persistenceobjectNone
controlPlanes.vector.persistence.enabledboolfalseSet enabled to true to run Vector as a statefulset with each replica backed by a persistent volume and enable disk buffers for selected sinks. When set to false, Vector is run as a deployment with memory buffers.
controlPlanes.vector.persistence.sizestring"1Gi"size must be at least the sum of all buffer.maxSize values with overhead for other Vector data. If you define this you should also define all sink buffer.maxSize values.
controlPlanes.vector.replicasint1None
controlPlanes.vector.resourcesobjectNone
controlPlanes.vector.resources.limitsobject{}None
controlPlanes.vector.resources.requestsobjectNone
controlPlanes.vector.resources.requests.cpustring"200m"None
controlPlanes.vector.resources.requests.memorystring"256Mi"None
controlPlanes.vector.sinks.usageobjectNone
controlPlanes.vector.sinks.usage.bufferobjectNone
controlPlanes.vector.sinks.usage.buffer.maxEventsstring"500"String containing max number of events to buffer in memory.
Relevant when mxp.vector.persistence.enabled=false.
controlPlanes.vector.sinks.usage.buffer.maxSizestring"268435488"String containing max size of disk buffer in bytes. Must fit with other buffer.maxSize values in mxp.vector.persistence.size.
Relevant when mxp.vector.persistence.enabled=true.
controlPlanes.vector.versionstring"0.22.1"None
controlPlanes.veleroobjectNone
controlPlanes.velero.chartVersionstring"5.2.0"None
controlPlanes.velero.prometheusobjectNone
controlPlanes.velero.prometheus.serviceMonitorobjectNone
controlPlanes.velero.prometheus.serviceMonitor.enabledboolfalseNone
controlPlanes.velero.resourcesobjectNone
controlPlanes.velero.resources.limitsobject{}None
controlPlanes.velero.resources.requestsobjectNone
controlPlanes.velero.resources.requests.cpustring"100m"None
controlPlanes.velero.resources.requests.memorystring"75Mi"None
controllerobjectConfigurations for the space controller deployment.
controller.controllerobjectNone
controller.controller.extraArgslist[]None
controller.controller.extraEnvlist[]None
controller.controller.imageobjectNone
controller.controller.image.pullPolicystring"IfNotPresent"None
controller.controller.image.repositorystring"mxe-controller"None
controller.controller.image.tagstring"0.1.0"None
controller.controller.resourcesobjectNone
controller.controller.resources.limitsobjectNone
controller.controller.resources.limits.cpustring"1000m"None
controller.controller.resources.limits.memorystring"200Mi"None
controller.controller.resources.requestsobjectNone
controller.controller.resources.requests.cpustring"100m"None
controller.controller.resources.requests.memorystring"50Mi"None
controller.controller.serviceobjectNone
controller.controller.service.metricsobjectNone
controller.controller.service.metrics.portint8085None
controller.controller.service.webhookobjectNone
controller.controller.service.webhook.portint9443None
controller.gcobjectNone
controller.gc.extraArgslist[]None
controller.gc.failedJobsHistoryLimitint1None
controller.gc.imageobjectNone
controller.gc.image.repositorystring"mxe-hostcluster-gc"None
controller.gc.image.tagstring"0.1.0"None
controller.gc.schedulestring"*/15 * * * *"None
controller.gc.successfulJobsHistoryLimitint0None
controller.mxeInitobjectNone
controller.mxeInit.imageobjectNone
controller.mxeInit.image.pullPolicystring"IfNotPresent"None
controller.mxeInit.image.repositorystring"mxe-apis"None
controller.mxeInit.image.tagstring"0.1.0"None
controller.prometheusobjectNone
controller.prometheus.podMonitorobjectNone
controller.prometheus.podMonitor.enabledboolfalseNone
controller.prometheus.podMonitor.intervalstring"30s"None
controller.secretRefsobjectNone
controller.secretRefs.adminSigningstring"cert-admin-signing"None
controller.secretRefs.ingressCAstring"mxe-router-tls"None
controller.serviceAccountobjectNone
controller.serviceAccount.annotationsobject{}None
controller.serviceAccount.createbooltrueNone
controller.serviceAccount.namestring""None
controller.webhookInitobjectNone
controller.webhookInit.imageobjectNone
controller.webhookInit.image.pullPolicystring"IfNotPresent"None
controller.webhookInit.image.repositorystring"mxe-controller/initialize"None
controller.webhookInit.image.tagstring"0.1.0"None
deletionPolicystring"Delete"Specifies if the supporting APIs for the Spaces deployment should be handled on a deletion request. Possible options are “Delete” or “Orphan”. If “Delete” is specified, on performing a ‘helm uninstall’, the Crossplane configurations that support the installation will also be deleted along with the resources that make the spaces installation.
features.alphaobjectNOTE: Alpha features are subject to removal or breaking changes without notice, and generally not considered ready for use in production. They have to be optional even if they are enabled.
features.alpha.argocdPluginobjectNone
features.alpha.argocdPlugin.enabledboolfalseNone
features.alpha.argocdPlugin.targetobjectNone
features.alpha.argocdPlugin.target.externalClusterobjectThe secret name and key for the kubeconfig of the external cluster. This is used by the argocd plugin to connect to the external cluster in case ArgoCD does not run in the same cluster as Spaces. If not specified, defaults to in-cluster credentials.
features.alpha.argocdPlugin.target.externalCluster.enabledboolfalseNone
features.alpha.argocdPlugin.target.externalCluster.secretobjectNone
features.alpha.argocdPlugin.target.externalCluster.secret.keystring"kubeconfig"None
features.alpha.argocdPlugin.target.externalCluster.secret.namestring"kubeconfig"None
features.alpha.argocdPlugin.target.secretNamespacestring"argocd"None
features.alpha.controlPlaneBackupobjectNone
features.alpha.controlPlaneBackup.enabledboolfalseThis enables backup and restore of control planes.
features.alpha.featuresAnnotationobjectNone
features.alpha.featuresAnnotation.enabledboolfalseNone
features.alpha.gitSourceobjectNone
features.alpha.gitSource.enabledbooltrueNone
features.alpha.kineobjectNone
features.alpha.kine.enabledboolfalseNone
features.alpha.sharedBackupobjectNone
features.alpha.sharedBackup.enabledboolfalseThis enables backup and restore of control planes using Shared resources.
features.alpha.sharedSecretsobjectSharedSecrets enables the ability to use the SharedSecrets feature within this space.
features.alpha.sharedSecrets.enabledboolfalseNone
features.alpha.upboundPolicy.enabledboolfalseThis enables the SharedUpboundPolicy API within this space.
features.betaobject{}Beta features are on by default, but may be disabled. Beta features are considered to be well tested, and will not be removed completely without being marked deprecated for at least two releases.
hostClusterobjectConfigurations applied consistently across all XHostClusters.
hostCluster.providerobjectNone
hostCluster.provider.helmobjectNone
hostCluster.provider.helm.versionstring"v0.17.0"None
hostCluster.provider.kubernetesobjectNone
hostCluster.provider.kubernetes.versionstring"v0.12.1"None
hostCluster.uxpobjectNone
hostCluster.uxp.metricsobjectNone
hostCluster.uxp.metrics.enabledbooltrueNone
hostCluster.uxp.versionstring"1.14.6-up.1"None
imagePullSecretslist[{"name":"upbound-pull-secret"}]NOTE: only an imagePullSecret of “upbound-pull-secret” is currently supported.
ingressobjectConfigurations for external requests coming into the space.
ingress.annotationsobject{}Allows setting ingress annotations for the external facing Ingress that terminates at the mxe-router deployment.
ingress.hoststring"proxy.upbound-127.0.0.1.nip.io"Specifies the externally routable hostname used for routing requests to individual control planes.
ingress.provisionbooltrueSpecifies whether the helm chart should create an Ingress resource for routing requests to the spaces-router.
registrystring"us-west1-docker.pkg.dev/orchestration-build/upbound-environments"Specifies the registry the containers used in the spaces deployment are served from.
routerobjectConfigurations for the space router deployment.
router.controlPlaneobjectNone
router.controlPlane.extraArgslist["--service-node","mxe-router","--debug"]None
router.controlPlane.imageobjectNone
router.controlPlane.image.pullPolicystring"IfNotPresent"None
router.controlPlane.image.repositorystring"mxe-router"None
router.controlPlane.image.tagstring"0.1.0"None
router.controlPlane.resourcesobjectNone
router.controlPlane.resources.limitsobjectNone
router.controlPlane.resources.limits.cpustring"1000m"None
router.controlPlane.resources.limits.memorystring"1000Mi"None
router.controlPlane.resources.requestsobjectNone
router.controlPlane.resources.requests.cpustring"100m"None
router.controlPlane.resources.requests.memorystring"100Mi"None
router.controlPlane.serviceobjectNone
router.controlPlane.service.authobjectNone
router.controlPlane.service.auth.portint9000None
router.controlPlane.service.grpcobjectNone
router.controlPlane.service.grpc.portint8081None
router.controlPlane.service.httpobjectNone
router.controlPlane.service.http.portint9091None
router.controlPlane.service.metricsobjectNone
router.controlPlane.service.metrics.portint8085None
router.controlPlane.service.privateHttpobjectNone
router.controlPlane.service.privateHttp.portint9092None
router.hpaobjectNone
router.hpa.enabledboolfalseNone
router.hpa.maxReplicasint5None
router.hpa.minReplicasint1None
router.hpa.targetCPUUtilizationPercentageint80None
router.prometheusobjectNone
router.prometheus.podMonitorobjectNone
router.prometheus.podMonitor.enabledboolfalseNone
router.prometheus.podMonitor.intervalstring"30s"None
router.proxyobjectNone
router.proxy.extraArgslist["--service-node","mxe-router","--service-cluster","mxe-router"]None
router.proxy.extraEnvlist[]None
router.proxy.imageobjectNone
router.proxy.image.pullPolicystring"IfNotPresent"None
router.proxy.image.repositorystring"envoy"None
router.proxy.image.tagstring"v1.26-latest"None
router.proxy.resourcesobjectNone
router.proxy.resources.limitsobjectNone
router.proxy.resources.limits.cpustring"1000m"None
router.proxy.resources.limits.memorystring"200Mi"None
router.proxy.resources.requestsobjectNone
router.proxy.resources.requests.cpustring"100m"None
router.proxy.resources.requests.memorystring"50Mi"None
router.proxy.serviceobjectNone
router.proxy.service.adminobjectNone
router.proxy.service.admin.portint9091None
router.proxy.service.annotationsobject{}None
router.proxy.service.httpobjectNone
router.proxy.service.http.portint8443None
router.proxy.service.typestring"ClusterIP"None
router.replicaCountint1None
router.secretRefsobjectNone
router.secretRefs.adminValidatingstring"cert-admin-signing"None
router.secretRefs.gatewaySigningstring"cert-token-signing-gateway"None
router.secretRefs.tlsSecretNamestring"mxp-hostcluster-certs"None
router.serviceAccountobjectNone
router.serviceAccount.annotationsobject{}None
router.serviceAccount.createbooltrueNone
router.serviceAccount.namestring""None
spaceobject{"labels":{}}Configurations that are applied consistently across the space.
space.labelsobject{}Labels that are applied to all Deployments, Pods, Services, and StatefulSets managed by the Space.
versionstring"0.1.0"Overall artifact version that affects xpkgs and related components.
xpkgobjectxpkg repository and tag references.
xpkg.mxeCompositionTemplatesobjectNone
xpkg.mxeCompositionTemplates.repositorystring"mxe-composition-templates"None
xpkg.mxeCompositionTemplates.tagstring"0.1.0"None
xpkg.mxeIngressobjectNone
xpkg.mxeIngress.repositorystring"mxe-ingress"None
xpkg.mxeIngress.tagstring"0.1.0"None
xpkg.mxpControlPlaneobjectNone
xpkg.mxpControlPlane.repositorystring"mxp-control-plane"None
xpkg.mxpControlPlane.tagstring"0.1.0"None
xpkg.mxpHostClusterobjectNone
xpkg.mxpHostCluster.repositorystring"mxp-host-cluster"None
xpkg.mxpHostCluster.tagstring"0.1.0"None
xpkg.providerHostClusterobjectNone
xpkg.providerHostCluster.repositorystring"provider-host-cluster"None
xpkg.providerHostCluster.tagstring"0.1.0"None
xpkg.pullPolicystring"IfNotPresent"None