apigeectl
apigeectl is a command-line interface (CLI)for installing and managing Apigee hybrid in a Kubernetes cluster. Forinformation on downloading and installingapigeectl, seeDownload and install apigeectl.
kubectlinstalled and set up on your Kubernetes administration machine to use theapigeectl command. Scopes for applyingapigeectl
By usingapigeectl flags you control which scopes the command applies configuration changes to. For an overview of scopes within the Apigee hybrid runtime see theRuntime service configuration overview.
| Scope | Components | apigeectl flag |
|---|---|---|
| Storage | Cassandra | --datastore |
| Environment | Runtime Synchronizer UDCA | --all-envs--env |
| Organization | Apigee Connect Agent MART Watcher | --org |
| Reporting | Logger Metrics | --telemetry |
apigeectl syntax
apigeectl [command] [flags]
Where:
command: Specifies the operation you want to perform. For a complete list of commands, seeapigeectl commands.
flags: Specifies command parameters. For a complete list of flags, seeapigeectl flags.
apigeectl commands
The following table lists theapigeectl commands:
| Command | Description |
|---|---|
apply | Applies configurations for Apigee hybridruntime components to your Kubernetes cluster.
apigeectl flags: apigeectl init before callingapigeectl apply. |
check‑ready | Checks the status of the hybrid component pods. When all component pods are ready, the message "All containers ready" is output. For automated scripting, note that the command exits with a status of 0 when the containers are all ready. When there is at least one pod not ready, the command exits with a status of 1. apigeectl flags: |
delete | Deletes hybrid components from the cluster. Use the
apigeectl flags: |
encode | Returns a list of encoded names of all the ApigeeDeployments for the specified organization or the specified environment within the specified organization. The encoded names include the name of the component with a hashed name of the organization and if using the You must use either the ./apigeectl encode --org hybrid-exampleList of ApigeeDeployments are: apigee-connect-agent-hybrid-example-6a82f8a apigee-mart-hybrid-example-6a82f8a apigee-watcher-hybrid-example-6a82f8a ./apigeectl encode --org hybrid-example --env example-envList of ApigeeDeployments are: apigee-runtime-hybrid-example-example-env-9e87e2d apigee-synchronizer-hybrid-example-example-env-9e87e2d apigee-udca-hybrid-example-example-env-9e87e2d apigeectl flags: |
help | Prints online help. |
init | Installs Apigee Operators and CRDs in the apigee-system namespace. Run apigeectl flags: |
version | Prints the CLI version information. apigeectl flag: |
apigeectl flags
The following table lists theapigeectl flags:
| Flag | Description |
|---|---|
--all | delete only: Deletes the entire Apigee hybrid installation except ASM (Istio) and cert-manager from your cluster. |
--all-envs | Applies the |
--datastore | Applies the configuration to the datastore scope (cassandra). |
‑‑dry‑run | Executes the specified command without changing the cluster. Use with‑‑print-yaml to output the rendered object spec to a file.
|
--envenv-name | Applies the configuration to the specified environment. This flag will apply configuration to environment scope components apigee-runtime, apigee-synchronizer and apigee-udca.
apigeectl apply --org hybrid-example --env example-env \ -f overrides/overrides.yaml |
‑f, ‑‑file‑override‑config | Specifies a YAML file containing custom configuration properties for the hybrid deployment. The default value is./overrides.yaml. An overrides file is required for theapply,check-ready,delete, andinit commands.You must specify the full path with this flag. For more information, seeManaging runtime plane components. |
-h, --help | Displays help for the command. |
--org | Applies the configuration to the specified organization. This flag will apply configuration to the org scope components apigee-connect-agent, apigee-mart and apigee-watcher. Note: When using--org withencode you must include the organization ID. For example:apigeectl encode --org example-org |
--print-yaml | Prints the configuration template output to stdout. For an example that uses this flag, seePrint the configuration to a file. |
-s, --settingsvirtualhosts | Specifies a configuration to which the command applies. Currently, this flag is only supported for the For example, if you make a change to the apigeectl apply -fmy-overrides.yaml --settings virtualhosts \ --org example-org --env example-env |
--telemetry | Applies the configuration for telemetry components like apigee-logger and apigee-metrics. |
--verbose | Prints verbose logs to std err. |
Theapigeectl command useskubectl behind the scenes to do its work. Theapigeectl command options (apply anddelete, and the use of YAML configuration files, are similar to their kubectl counterparts. To learn more about how objects are managed in a Kubernetes cluster, see the following topics:
Examples
Initialize the cluster configuration
Apply prerequisite component configurations to your cluster withinit. You must run theinit command beforeapply.
apigeectl init -f my_overrides.yaml
Apply the cluster configuration
To apply hybrid configurations to your Kubernetes cluster, use theapply command. The first time you runapply all of thehybrid runtime components are created in your cluster. If you make configuration changes, rerunapply to apply only the changes or use flags to apply a changes to a specificscope only.
The following example applies the configuration for hybrid runtime plane components to your cluster:
apigeectl apply -f my_overrides.yaml
Apply the configuration for a single component
To restrict theapply command to a particular component, use the flags described inapigeectl flags.
The following example only applies the configuration for the Cassandra component:
apigeectl apply --datastore -f my_overrides.yaml
Print the configuration to a file
If you're debugging an installation problem, it's useful to print out the entire cluster configuration to a file so that you can inspect the configuration settings. The--print-yaml flag prints the hybrid configuration to stdout, and the--dry-run flag allows the command to run without making any changes to the cluster.
apigeectl apply -f my_overrides.yaml --dry-run=client --print-yaml > apigee-hybrid.yaml
Check pod status
The following example checks the status of pods deployed to your cluster:
apigeectl check-ready -f overrides/overrides.yamlAll containers ready in namespace 'my-namespace'
Delete hybrid from the cluster
The following example deletes only the hybrid runtime components to yourKubernetes cluster. To delete everything, use the--all flag.
kubectl version 1.11.x or later installed.apigeectl delete -f my_overrides.yaml
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-18 UTC.