Step 5: Create TLS certificates

This step explains how to create the TLS credentials that are required for Apigee hybrid to operate.

Create TLS certificates

You are required to provide TLS certificates for the runtime ingress gateway in your Apigee hybrid configuration. For the purpose of this quickstart (a non-production trial installation), the runtime gateway can accept self-signed credentials. In the following steps, openssl is used to generate the self-signed credentials.

In this step, you will create the TLS credential files and add them to the $APIGEE_HELM_CHARTS_HOME/certs directory. In Step 6: Create the overrides, you will add the file paths to the cluster configuration file.

  1. Create a directory for the credential files. Helm charts cannot read files outside the chart directory, and the TLS credentials are managed with the apigee-virtualhost chart. therefore create your directory for the credential files within the $APIGEE_HELM_CHARTS_HOME/apigee-virtualhost/ directory.

    For example:

    mkdir $APIGEE_HELM_CHARTS_HOME/apigee-virtualhost/certs/
  2. Execute the following command to create the credential files and store them in your $APIGEE_HELM_CHARTS_HOME/apigee-virtualhost/certs directory: 
    openssl req  -nodes -new -x509 -keyout $APIGEE_HELM_CHARTS_HOME/apigee-virtualhost/certs/keystore_$ENV_GROUP.key -out \
    $APIGEE_HELM_CHARTS_HOME/apigee-virtualhost/certs/keystore_$ENV_GROUP.pem -subj '/CN='$DOMAIN'' -days 3650

    Where:

    • DOMAIN is the domain you provided as the hostname for the environment group you created in Create an environment group.
    • ENV_GROUP is the name of the environment group where the domain is specified as a hostname. It's a good practice to include the environment group name in the key and keystore name to avoid accidentally reusing the same domain value if you create keys for multiple environment groups.

    This command creates a self-signed certificate/key pair that you can use for the quickstart installation.

    If you have additional environment groups with unique domain names, repeat this step for each environment group. You will reference these groups and certificates in the cluster configuration step.

  3. Check to make sure the files are in the $APIGEE_HELM_CHARTS_HOME/apigee-virtualhost/certs directory using the following command: 
    ls $APIGEE_HELM_CHARTS_HOME/apigee-virtualhost/certs

    This you should see two files:

    • keystore_ENV_GROUP.pem or keystore_ENV_GROUP.crt is the self-signed TLS certificate file.
    • keystore_ENV_GROUP.key is the key file.

You now have the credentials needed to manage Apigee hybrid in your Kubernetes cluster. Next, you will create an overrides file that is used by Kubernetes to deploy the hybrid runtime components to the cluster.

Next step

1 2 3 4 5 (NEXT) Step 6: Create the overrides 7 8 9 10 11