apigeectl command reference

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

The apigeectl command uses Apigee-provided default templates to generate a Kubernetes deployment spec. This spec deploys all of the hybrid services to your cluster. You can override the defaults by using the overrides.yaml file.

apigeectl syntax

apigeectl [command] [options]

Where:

  • command: Specifies the operation you want to perform; for example apply, delete , and check-ready.
  • options: Specifies optional command parameters. For example, you can use the -c or --component option to specify a single service to delete or apply, such as cassandra or mart.

Commands

The following table lists the apigeectl commands:

Command Description
apply

Applies the hybrid resource configuration to all services or for a specific service to the cluster.

If you do not specify the -c or -component option, then the apply command applies to all services in the entire cluster.

delete

Deletes the hybrid resource configuration for all services or for a specific service from the cluster.

If you do not specify the -c or -component option, then the delete command applies to all services in the entire cluster.

check‑ready

Checks the status of the hybrid pod deployments. When all pods are ready, the command exits with a status of 0. When there is at least one pod not ready, the command exits with a status of 1. This is primarily used for automation.

If you do not specify the -c or -component option, then the check-ready command applies to all services in the entire cluster.

apigeectl options

The following table lists the apigeectl options:

Option Description
-c, --component

Specifies a single service to which the command applies. Services generally match the default Kubernetes configuration name as it appears in the values.yaml file.

If you do not specify this option, then the command applies to all services (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
  • mp
  • namespace
  • routes (used by MART for setting up traffic routing logic)
  • synchronizer
  • udca

For example, -c cassandra

--dry-run Prints the rendered Kubernetes configuration template for all services or the specified service without applying it to the cluster.
‑f, ‑‑file‑override‑config Specifies a YAML file containing custom deployment configuration properties for the hybrid deployment.

The default value is ./overrides.yaml. If you edit the overrides.yaml file, you do not need to specify the -f option on the command line (because ./overrides.yaml is the default. If you specify custom properties in a file with a different name, you must specify its location with this option.

--print-yaml Prints the configuration template output to stdout.
-v, --version Specifies the hybrid release version and determines which directory to use for the Kubernetes configuration templates. For example: beta
-h, --help Display help for the command.

Examples

Apply Edge Hybrid to your cluster

To apply hybrid services for the Beta version into your Kubernetes cluster:

apigeectl apply -v beta

To print the hybrid configuration template to a YAML file without applying the configuration to the cluster. This command automatically appends --dry-run to the underlying kubectl command.

apigeectl apply -v beta --dry-run --print-yaml > apigee-hybrid.yaml

Apply configuration for a service

The following example applies the configuration template for the Synchronizer service only to the Beta version in your cluster:

apigeectl apply -c synchronizer -v beta

Check pod status

The following example checks all hybrid services for the Beta version on your cluster:

apigeectl check-ready -v beta
  All containers ready in namespace 'MyNamespace'

Delete hybrid from the cluster

The following example deletes all hybrid services for the Beta version from your Kubernetes cluster.

apigeectl delete -v beta