This section describes how to customize your Apigee Hybrid runtime plane services.
Runtime plane services are configured using the following files:
values.yaml: A read-only file that lists the default configuration properties in YAML.
overrides.yaml: An editable file in which you specify configuration changes in YAML.
To override the default values, use a configuration overrides file (or more simply, an
overrides file. By default, hybrid looks for an overrides file named
overrides.yaml in the root installation directory.
overrides.yaml uses the same
values.yaml. You can only override
properties listed in the Configuration property reference. If you try to define a
property not listed there, the override value is ignored.
Override default values
To override default values, add configuration properties to the
overrides file in the same YAML format found in the
For example, to override the replica count for the MP, you can add the following
stanza to your
runtime: replicaCountMin: 2 replicaCountMax: 4
After you make changes to the
push your changes to the cluster with the
apigeectl command. You execute this
command with the
apply command, as the following example shows:
hybrid_root_dir/apigeectl [-f ./overrides.yaml] apply -v beta2
Note that the
--file-override-config) parameter is optional. By
apigeectl command looks for a file called
the root install directory. As a result, you do not need to specify a value for
-f unless you use a different name or location for your configuration overrides
Also note that by default, the target of the
apigeectl command is all services in
the cluster unless you specify a specific service with the
For more information, see
Sample override configurations
Apigee provides sample
overrides.yaml files to
help guide you in setting up your hybrid deployment. The
following samples are included in the hybrid download
|Example overrides files||Description||Use case|
||Sample override configurations for GKE clusters. This configuration assumes that Cassandra and other services will share the same Kubernetes worker nodes.||Testing only|
||Sample override configurations for open-source based clusters
that are CNCF-conformant. This configuration assumes that Cassandra
and other services will share the same Kubernetes worker nodes.
||A sample override configuration for GKE clusters. Suitable for production deployments. Includes dedicated node pools (one for Cassandra and another for all other services). See also Configure dedicated node pools.||Production deployments|
||A sample override configuration for open-source based clusters that are CNCF-conformant. Suitable for production deployments. Includes dedicated node pools (one for Cassandra and another for all other services). For more information, see Configure dedicated node pools.||Production deployments|
Print the deployment spec
A deployment spec is the complete configuration file for your hybrid services on the
runtime plane. It is the combination of default values from the
values.yaml file and
your custom settings in the
Apigee recommends that you save the deployment spec in source control, so that you have a reference of the resources installed and configured in the cluster.
To output your deployment spec to a file, execute the following command:
apigeectl apply -v beta2 --dry-run --print-yaml > apigee-hybrid.yaml