apigeectl

Applies configurations for Apigee hybrid runtime components to your Kubernetes cluster.

apigeectl apply without flags will apply changes to all components in the cluster.

apigeectl flags: ‑‑all‑envs, ‑‑datastore, ‑‑dry‑run, ‑‑env, ‑f, ‑‑file‑override‑config, ‑‑help, ‑‑org, ‑‑print‑yaml, ‑‑redis, ‑‑settings virtualhosts, ‑‑telemetry, ‑‑v

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: ‑f, ‑‑file‑override‑config, ‑‑help, ‑‑v

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 with apigeectl init are not deleted). Apigee‑specific components are the components that are installed with the apply command.

apigeectl delete without any optional flags applies the delete command to all of the components deployed in the cluster.

apigeectl diagnostic delete ‑f OVERRIDES_FILE deletes the apigee‑diagnostic namespace created by apigeectl diagnostic. The ‑f / ‑‑file‑override‑config flag is required with apigeectl diagnostic delete

apigeectl flags: ‑‑all, ‑‑all‑envs, ‑‑datastore, ‑‑env, ‑f, ‑‑file‑override‑config, ‑‑help, ‑‑org, ‑‑redis, ‑‑telemetry, ‑‑v

Invokes the Diagnostic collector, which captures diagnostic data on the Kubernetes components of an Apigee hybrid instance on demand and stores them in Google Cloud storage buckets.

Diagnostic collector requires a named Google Cloud storage bucket, a service account with the Storage Admin role, and a diagnostic: stanza added to your overrides file. See:

• Using the Diagnostic collector
• Configuration property reference: diagnostic

When you invoke Diagnostic collector, it creates an "apigee‑diagnostic" Kubernetes namespace. You must delete this with apigeectl diagnostic delete before invoking Diagnostic collector again.

Invoke Diagnostic collector:

apigeectl diagnostic ‑f OVERRIDES_FILE

Delete Diagnostic collector:

apigeectl diagnostic delete ‑f OVERRIDES_FILE

apigeectl flags: ‑‑file‑override‑config

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 ‑‑env flag, a hashed name of the environment. Apigee hybrid creates hashed names of organizations and environments to be able to avoid namespace collisions.

You must use either the ‑‑org org‑name or both the ‑‑org org‑name with the ‑‑env env‑name flags with encode. For example:

./apigeectl encode ‑‑org hybrid‑example
List 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‑env
List 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: ‑‑env, ‑‑org

Installs Apigee Operators and CRDs in the apigee‑system namespace.

Run apigeectl init after a fresh install or upgrade before running apigeectl apply.

apigeectl flags: ‑f, ‑‑file‑override‑config, ‑‑help, ‑‑v

apigeectl flag: ‑‑help

Applies the apigeectl command to all environments under the organization specified in your overrides config file.

Applies the configuration to the datastore scope (Cassandra).

‑‑dry‑run must be used with one of the two following values, depending on the version of kubectl you are running. Use gcloud version to check your kubectl version:

• kubectl version 1.17.x or older: ‑‑dry‑run=true
• kubectl version 1.18.x or newer: ‑‑dry‑run=client

Applies the configuration to the specified environment. This flag will apply configuration to environment scope components apigee‑runtime, apigee‑synchronizer and apigee‑udca.

‑‑env must be used with the ‑‑org flag. For example:

apigeectl apply ‑‑org hybrid‑example ‑‑env example‑env \
      ‑f overrides/overrides.yaml

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

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.

Applies the configuration to the in‑memory data storage scope (Redis).

Restores Cassandra to a previously saved snapshot specified by the snapshotTimestamp property in restore configuration of the overrides.yaml file. The backup is restored either from the Cloud Storage bucket or a remote server based on the backup configuration in the overrides.yaml file. For more information, see Restoring a region from a backup.

Specifies a configuration to which the command applies. Currently, this flag is only supported for the virtualhosts configuration, which is part of the runtime component. Use this flag if you make changes to the virtualhosts property, and nothing else.

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

apigeectl apply ‑f my‑overrides.yaml ‑‑settings virtualhosts \
    ‑‑org example‑org ‑‑env example‑env

Applies the configuration for telemetry components like apigee‑logger and apigee‑metrics.

Prints verbose logs to std err. int is an integer that sets the level of verbosity. int is required with ‑‑v. This option behaves identically to the kubectl ‑‑v option.