apigeectl

You are currently viewing version 1.2 of the Apigee hybrid documentation.This version is end of life. You should upgrade to a newer version. For more information, seeSupported versions.

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.

NOTE: You must havekubectlinstalled and set up on your Kubernetes administration machine to use theapigeectl command.

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:

CommandDescription
apply

Applies configurations for Apigee hybridruntime components to your Kubenetes cluster. Use the-c flag to specify one or more (comma-separated) components.

If you do not specify the-c flag, then theapply command applies all of the components to the cluster.

NOTE: You must callapigeectl 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.

If you do not specify the-c flag, then thecheck-ready command applies to all components in the cluster.

delete

Deletes hybrid components from the cluster. Use the--all flag to remove ALL of the components. If you omit--all, only the Apigee-specific components are removed (the components installed withapigeectl init are not deleted). Apigee-specific components are the components that are installed with theapply command.

If you do not specify the-c flag, then thedelete command applies to all of the components deployed in the cluster.

helpPrints online help.
init

Applies configurations for prerequisite components, such as Istio and Apigee Deployment, to the cluster. Use the-c flag to specify one or more (comma-separated) components.

versionPrints the CLI version information.

apigeectl flags

The following table lists theapigeectl flags:

FlagDescription
-c, --components

Specifies a single component to which the command applies.

If you do not specify this flag, then the command applies to all components (the entire deployment) in the cluster. Possible values include:

  • cassandra
  • logger
  • mart
  • metrics
  • runtime
  • synchronizer
  • udca

For example,-c cassandra

Or, to specify multiple components add comma-separated values:-c cassandra, runtime

--dry-runExecutes the specified command without changing the cluster. Use with‑‑print-yaml to output the rendered object spec to a file.
‑f, ‑‑file‑override‑configSpecifies 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, --helpDisplays help for the command.
--print-yamlPrints the configuration template output to stdout. For an example that uses this flag, seePrint the configuration to a file.
-s, --settings

Specifies a configuration to which the command applies. Currently, this flag is only supported for thevirtualhosts configuration, which is part of theruntime component. Use this flag if you make changes to thevirtualhosts property, and nothing else. (Added v1.2.0)

For example, if you make a change to thevirtualhosts configuration in your overrides file, apply it to the cluster with this command:

apigeectl apply -fmy-overrides.yaml --settings virtualhosts -c runtime

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-c to apply a specificcomponent 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-c flag, as described inapigeectl flags.

The following example only applies the configuration for the Synchronizercomponent:

apigeectl apply -c synchronizer -f my_overrides.yaml

The following example only applies the configuration for the Cassandra and runtimecomponents:

apigeectl apply -c cassandra,runtime -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 --print-yaml > apigee-hybrid.yaml
NOTE: It is a good practice to save a copy ofthe YAML output in source control for future reference. But be aware that the output file containspasswords and secrets that you may not want to store.

Check pod status

The following example checks the status of pods deployed to your cluster:

apigeectl check-readyAll 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.

NOTE: To uninstall successfully, you must havekubectl 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.