Skip to content
Kong Summit 2022: Where API Innovation Runs Wild  —Learn More →
|
search
Konnect Cloud

(Legacy) Set up a Kong Gateway Runtime on Linux

This documentation is for the legacy Konnect environment at konnect.konghq.com. For the cloud.konghq.com environment, see the current Konnect documentation.

Using kong.conf, set up a runtime through the Konnect Runtime Manager and configure your Kong Gateway instance to accept configuration from Konnect. The Runtime Manager keeps track of all runtimes associated with the Konnect Cloud account.

Note: Kong does not host runtimes. You must install and host your own runtime instances.

Prerequisites

  • You have Runtime Admin or Organization Admin permissions in Konnect Cloud.

Generate certificates

  1. In Konnect, select runtimes icon Runtime Manager.

  2. Select a runtime group.

  3. Click New Runtime Instance.

  4. Open the tab for either Linux or Kubernetes.

    For an advanced Docker setup using custom configuration values, use either tab. Do not use the Quick Setup tab.

  5. Click Generate Certificate.

    Two new fields appear: a certificate and a private key. The contents of these fields are unique to each runtime configuration.

  6. Save the contents of each field into a separate file in a safe location:

    • Certificate: tls.crt
    • Private key: tls.key

    If you navigate away from this page before saving all of the certificate and key files, you will need to regenerate them.

  7. Store the files on the local filesystem of the runtime instance.

Note: The certificates generated by Konnect have a ten year expiration date by default. If you bring your own certificates, make sure to monitor the expiration date. To rotate certificates, see Renew Certificates.

Configure the runtime

Next, configure a Kong Gateway runtime using the certificate, the private key, and the remaining configuration details on the Configure Runtime page.

  1. Find the documentation for your platform, and follow the instructions in Steps 1 and 2 only to download and install Kong Gateway .

    Do not start or create a database on this node.

  2. Return to Konnect and copy the code block in the Step 2. Configuration Parameters section.

    Konnect Runtime Parameters

  3. Open your instance’s kong.conf file. Add the parameters you just copied to the file.

    The result should look something like this, replacing placeholder values with your own from Konnect:

     role = data_plane
 database = off
 vitals_ttl_days = 732
 cluster_mtls = pki
 cluster_control_plane = {EXAMPLE.CP.KONNECT.FOO}:443
 cluster_server_name = {KONG-CPOUTLET-EXAMPLE.SERVICE}
 cluster_telemetry_endpoint = {EXAMPLE.TP.KONNECT.FOO}:443
 cluster_telemetry_server_name = {KONG-TELEMETRY-EXAMPLE.SERVICE}
 cluster_cert = /{PATH_TO_FILE}/tls.crt
 cluster_ca_cert = /{PATH_TO_FILE}/ca.crt
 cluster_cert_key = /{PATH_TO_FILE}/tls.key

    See Parameters for descriptions and the matching fields in Konnect.

  4. Replace the values in cluster_cert, cluster_ca_cert, and cluster_cert_key with the paths to your certificate and key files.

  5. Restart Kong Gateway for the settings to take effect:

     $ kong restart

  6. On the Configure New Runtime page, click Done to go to the Runtime Manager overview.

    The Runtime Manager will include a new entry for your instance.

Access services using the proxy URL

Kong Gateway uses port 8000 for the proxy, taking incoming traffic from consumers, and forwarding it to upstream services.

The default proxy URL is http://localhost:8000. If you configured a different host, replace localhost with your hostname. Use this URL, along with any routes you set, to access your services.

For example, to access a service with the route /mock, use http://localhost:8000/mock, or http://example-host:8000/mock.