Apigee hybrid Helm reference

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 is arranged in the order you will typically install them in during a fresh installation.

ScopeComponentsHelm chart
Apigee operator Apigee operator apigee-operator
Storage Cassandra apigee-datastore
In‑memory storage Redis apigee-redis
Reporting Logger
Metrics		 apigee-telemetry
Ingress Apigee Ingress gateway apigee-ingress-manager
Organization Apigee Connect Agent
MART
UDCA
Watcher		 apigee-org
Environment Runtime
Synchronizer		 apigee-env
Environment group virtualhost apigee-virtualhost

apigeectl / Helm command cross reference

The following table lists the Helm equivalents for common apigeectl commands:

apigeectl command Helm command
apigeectl init The following commands mimic apigeectl 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/
  --namespace APIGEE_NAMESPACE \
  --atomic \
  -f overrides.yaml
helm install ingress-manager apigee-ingress-manager/
  --namespace APIGEE_NAMESPACE \
  --atomic \
  -f overrides.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 \
  --namespace APIGEE_NAMESPACE \
  --atomic \
  -f overrides.yaml
apigeectl apply There is no single command to manage all hybrid components. Because each component has a 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 \
  --namespace APIGEE_NAMESPACE \
  --atomic \
  -f overrides.yaml
apigeectl apply --redis
  • helm install redis apigee-redis/
  • helm upgrade redis apigee-redis/

For example:

helm upgrade redis apigee-redis/ \
  --install \
  --namespace APIGEE_NAMESPACE \
  --atomic \
  -f overrides.yaml
apigeectl apply --org
  • helm install ORG_NAME apigee-org/
  • helm upgrade ORG_NAME apigee-org/

For example:

helm upgrade $ORG_NAME apigee-org/ \
  --install \
  --namespace APIGEE_NAMESPACE \
  --atomic \
  -f overrides.yaml
apigeectl apply --env ENV_NAME
  • helm install ENV_NAME apigee-env/
  • helm upgrade ENV_NAME apigee-env/

For example:

helm upgrade $ENV_NAME apigee-env/ \
  --install \
  --namespace APIGEE_NAMESPACE \
  --set env=ENV_NAME \
	--atomic \
  -f overrides.yaml
apigeectl apply --all-envs There is no single command to manage all environments at once. You must install or upgrade each environment individually.
apigeectl apply --settings virtualhosts
  • helm install ENV_GROUP apigee-virtualhosts/
  • helm upgrade ENV_GROUP apigee-virtualhosts/

For example:

helm upgrade $ENV_GROUP apigee-virtualhosts/ \
  --install \
  --namespace APIGEE_NAMESPACE \
	--set envgroup=$ENV_GROUP \
  --atomic \
  -f overrides.yaml
apigeectl delete COMPONENT
  • helm delete RELEASE_NAME

For example:

helm delete datastore -n APIGEE_NAMESPACE
apigeectl delete or
apigeectl delete --all		 There is no single Helm command to delete all components at once. You must delete each component individually.
apigeectl COMMAND --dry-run=client
  • helm COMMAND --dry-run

For example:

helm upgrade datastore apigee-datastore/ \
  --install \
  --namespace APIGEE_NAMESPACE \
  --atomic \
  -f overrides.yaml \
  --dry-run=server
apigeectl check-ready While there is no no equivalent Helm command, during installation You can use the Check cluster readiness process to perform many of the same tasks.