apigeectl command reference

The apigeectl command is the command-line interface (CLI) for managing Apigee Hybrid in your Kubernetes cluster.

For more information, see Managing the runtime plane.

apigeectl syntax

apigeectl [command] [flags]

Where:

  • command: Specifies the operation you want to perform; for example apply, delete , and check-ready.

    For a complete list of commands, see apigeectl commands.

  • flags: Specifies command parameters. For example, you can use the -c or --component flag to specify a single component to delete or apply, such as cassandra or mart.

    For a complete list of flags, see apigeectl flags.

apigeectl commands

The following table lists the apigeectl commands:

Command Description
apply

Applies all of the Hybrid components or a specific component to the cluster.

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

delete

Deletes the all of the Hybrid components or a specific component from the cluster.

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

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 or -component flag, then the check-ready command applies to all components in the cluster.

apigeectl flags

The following table lists the apigeectl flags:

Flag Description
-c, --component

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
  • cassandra-role (creates Cassandra related users)
  • cps-setup
  • encrypt-config
  • gateways (used by Message Processors for setting up Ingress)
  • logger
  • mart
  • metrics
  • namespace
  • routes (used by MART for setting up traffic routing logic)
  • runtime
  • synchronizer
  • udca

For example, -c cassandra

--dry-run Executes the specified command without changing the cluster. Use with ‑‑print-yaml to output the rendered object spec to a file.
‑f, ‑‑file‑override‑config (Required for apply and delete) Specifies a YAML file containing custom configuration properties for the Hybrid deployment. The default value is ./overrides.yaml.

You must specify the full path with this flag. For more information, see Managing runtime plane components.

--print-yaml Prints the configuration template output to stdout. For an example that uses this flag, see Print the configuration to a file.
-v, --version (Required) Specifies the Hybrid release version and determines which directory to use for the Kubernetes configuration templates. For example, beta2.
-h, --help Displays help for the command.

Examples

Apply the cluster configuration

To apply Hybrid for the Beta 2 version to your Kubernetes cluster, use the apply command. The first time you run apply all of the components are created in your cluster. If you make configuration changes, rerun apply to apply only the changes.

The following example applies the configuration for all Hybrid Beta 2 components to your cluster:

apigeectl apply -v beta2 -f my_overrides.yaml

Apply the configuration for a single component

To restrict the apply command to a particular component, use the -c or -component flag, as described in apigeectl flags.

The following example only applies the configuration for the Synchronizer component:

apigeectl apply -c synchronizer -v beta2 -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 -v beta2 -f my_overrides.yaml --dry-run --print-yaml > apigee-hybrid.yaml

Check pod status

The following example checks all Hybrid components for the Beta 2 version on your cluster:

apigeectl check-ready -v beta2
All containers ready in namespace 'my-namespace'

Delete Hybrid from the cluster

The following example deletes all Hybrid components for the Beta 2 version from your Kubernetes cluster.

apigeectl delete -v beta2 -f my_overrides.yaml