Step 5: Create TLS certificates

You are currently viewing version 1.11 of the Apigee hybrid documentation. For more information, see Supported versions.

Version 1.11 

   Supported versions:

• v1.13 (latest)                        
• v1.12                         
• v1.11                         
• List of supported versions

   Unsupported versions:

• v1.10                                      
• v1.9                                         
• v1.8                                         
• v1.7                                         
• v1.6                                         
• v1.5                                         
• v1.4                                         
• v1.3                                         
• v1.2                                         
• v1.1                                         

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.

Note: In a production environment, you will need to use signed certificates. You can use either a certificate and key pair or a Kubernetes secret. For an example on how to obtain a TLS certificate from the Lets Encrypt certificate authority (CA), see Obtain TLS credentials: An example.

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

1. Execute the following command to create the credential files and store them in your $HYBRID_FILES/certs directory:

   openssl req  -nodes -new -x509 -keyout $HYBRID_FILES/certs/keystore_$ENV_GROUP.key -out \
       $HYBRID_FILES/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.

2. Check to make sure the files are in the $HYBRID_FILES/certs directory using the following command:

   ls $HYBRID_FILES/certs

    keystore_ENV_GROUP.key
    keystore_ENV_GROUP.pem

   Where keystore_ENV_GROUP.pem is the self-signed TLS certificate file and 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 a file that is used by Kubernetes to deploy the hybrid runtime components to the cluster.

1 2 3 4 5 (NEXT) Step 6: Configure the cluster 7 8 9 10