Create an overrides.yaml file

For each Apigee Hybrid component, the Hybrid installer applies multiple Kubernetes resources to your cluster. For example the apigee-mart component has a Service resource and a Deployment resource.

The Hybrid installer applies default configurations that handle most of the installation requirements; however, you must provide some configuration information for which no defaults exist. You can also override certain default values.

In this step, you will create a custom YAML configuration override file. This file is where you override default configuration properties and provide required properties specific to your account. In the steps that follow, you will add properties to this file to configure your environment, secure the Cassandra database, enable logging, and more.

Copy an overrides sample

The best way to start is to copy one of the sample override files and modify it:

  1. If you haven't done so, extract the contents of the Hybrid installer software that you downloaded previously.
  2. Change to the root directory of the unzipped distribution. For example:
    cd apigeectl_beta_c37c097_mac_64
  3. Copy one of the example configuration files located in ./examples into the current directory. The following table describes the example configuration files:
    Example file Description
    gke-non-production.yaml Configuration override for a GKE installation. Recommended for testing only.
    gke-production.yaml Configuration override for an advanced GKE installation. Recommended for production deployments.
    ossk8s‑non‑production.yaml Configuration override for a CNCF-conformant Kubernetes installation. Recommended for testing only.
    ossk8s-production.yaml Configuration override for a CNCF-conformant Kubernetes installation. Recommended for production deployments.
  4. Rename the file to overrides.yaml. You don't have to rename it, but in all the following steps, it is called overrides.yaml.
  5. Open the file.
  6. (Recommended) Add a namespace property at the top of the file. If you omit the namespace, the default is apigee.

    Example:

    namespace: my-namespace
  7. (Required) Add your Apigee organization name to the file. This must be the same name you used when you requested your org to be provisioned. An organization name must contain only lower-case letters, numbers, and hyphens.
    namespace: my-namespace
    org: your-org-name
    ...
    For example:
    namespace: my-namespace
    org: my-organization
    ...
      
  8. Save the file.
  9. Go to the next step, Configure an environment.
  10. Next Step

    1 NEXT: 2: ENVIRONMENT 3 4 5 6 7 8 9 10 11