Apigee hybrid Helm reference

You are currently viewing version 1.14 of the Apigee hybrid documentation. For more information, seeSupported versions.

Helm supported version

Apigee hybrid supports Helm v3.14.2+.

Helm charts for Apigee hybrid components

The hybrid components are installed and managed by the following Helm charts. The table isarranged in the order you will typically install them in during a fresh installation.

ScopeComponentsHelm chart
Apigee operatorApigee operatorapigee-operator
StorageCassandraapigee-datastore
In‑memory storageRedisapigee-redis
ReportingLogger
Metrics		apigee-telemetry
IngressApigee Ingress gatewayapigee-ingress-manager
OrganizationApigee Connect Agent
MART
UDCA
Watcher		apigee-org
EnvironmentRuntime
Synchronizer		apigee-env
Environment groupvirtualhostapigee-virtualhost
Note: The hybrid Helm charts depend on the Apigee hybrid Custom Resource Definitions (CRDs) being installed. SeeInstall theApigee hybrid CRDs in the Installation guide.

apigeectl / Helm command cross reference

The following table lists the Helm equivalents for commonapigeectl commands:

apigeectl commandHelm command
apigeectl initThe following commands mimicapigeectl init:
  • kubectl apply -k apigee-operator/etc/crds/default/
  • helm install operator apigee-operator/ or
    helm upgrade operator apigee-operator/
  • helm install ingress-manager apigee-ingress-manager/ or
    helm upgrade ingress-manager apigee-ingress-manager/

For example:

kubectl apply -k  apigee-operator/etc/crds/default/helm install operator apigee-operator/  --namespaceAPIGEE_NAMESPACE \  --atomic \  -foverrides.yamlhelm install ingress-manager apigee-ingress-manager/  --namespaceAPIGEE_NAMESPACE \  --atomic \  -foverrides.yaml
apigeectl init when used to install or apply changes to istiod.
  • helm install ingress-manager apigee-ingress-manager/
  • helm upgrade ingress-manager apigee-ingress-manager/

For example:

helm upgrade ingress-manager apigee-ingress-manager/ \  --install \  --namespaceAPIGEE_NAMESPACE \  --atomic \  -foverrides.yaml
apigeectl applyThere is no single command to manage all hybrid components. Because each component hasa specific chart, you must install or upgrade each chart individually.
apigeectl apply --datastore
  • helm install datastore apigee-datastore/
  • helm upgrade datastore apigee-datastore/

For example:

helm upgrade datastore apigee-datastore/ \  --install \  --namespaceAPIGEE_NAMESPACE \  --atomic \  -foverrides.yaml
apigeectl apply --redis
  • helm install redis apigee-redis/
  • helm upgrade redis apigee-redis/

For example:

helm upgrade redis apigee-redis/ \  --install \  --namespaceAPIGEE_NAMESPACE \  --atomic \  -foverrides.yaml
apigeectl apply --org
  • helm installORG_NAME apigee-org/
  • helm upgradeORG_NAME apigee-org/

For example:

helm upgrade$ORG_NAME apigee-org/ \  --install \  --namespaceAPIGEE_NAMESPACE \  --atomic \  -foverrides.yaml
apigeectl apply --envENV_NAME
  • helm installENV_NAME apigee-env/
  • helm upgradeENV_NAME apigee-env/

For example:

helm upgrade$ENV_NAME apigee-env/ \  --install \  --namespaceAPIGEE_NAMESPACE \  --set env=ENV_NAME \--atomic \  -foverrides.yaml
apigeectl apply --all-envsThere is no single command to manage all environments at once. You must install or upgrade eachenvironment individually.
apigeectl apply --settings virtualhosts
  • helm installENV_GROUP apigee-virtualhosts/
  • helm upgradeENV_GROUP apigee-virtualhosts/

For example:

helm upgrade$ENV_GROUP apigee-virtualhosts/ \  --install \  --namespaceAPIGEE_NAMESPACE \--set envgroup=$ENV_GROUP \  --atomic \  -foverrides.yaml
Note: You must install or upgrade each environment group individually.
apigeectl deleteCOMPONENT
  • helm deleteRELEASE_NAME

For example:

helm delete datastore -nAPIGEE_NAMESPACE
apigeectl delete or
apigeectl delete --all		There is no single Helm command to delete all components at once. You must delete eachcomponent individually.
apigeectlCOMMAND --dry-run=client
  • helmCOMMAND --dry-run

For example:

helm upgrade datastore apigee-datastore/ \  --install \  --namespaceAPIGEE_NAMESPACE \  --atomic \  -foverrides.yaml \  --dry-run=server
apigeectl check-readyThere is no equivalent Helm command.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-02-19 UTC.