Skip to content
|
You are browsing the Kong Gateway documentation archive. This documentation is no longer actively maintained.
See the latest Kong Gateway documentation.
Kong Gateway Enterprise [ARCHIVE]
1.3-x

PermalinkInstall Kong Enterprise on Ubuntu

PermalinkIntroduction

This guide walks through downloading, installing, and starting Kong Enterprise on Ubuntu.

The configuration shown in this guide is intended as an example. Depending on your environment, you may need to make modifications and take measures to properly conclude the installation and configuration.

Kong supports both PostgreSQL 9.5+ and Cassandra 3.11.* as its datastore. This guide provides steps to configure PostgreSQL. For assistance in setting up Cassandra, please contact your Kong Sales or Support representative.

PermalinkPrerequisites

To complete this installation you will need:

  • A supported Ubuntu system with root equivalent access.

  • You have signed up for a paid Enterprise subscription and received a license.json file from Kong.

PermalinkStep 1. Prepare to Install Kong Enterprise and Download the License File

PermalinkDownload the Debian package

  1. To install Kong Gateway versions 1.3.x and earlier, open a support case to request an authenticated time-sensitive URL.

  2. Click the URL to download your Kong Gateway installation package.

  3. Copy the .deb file to your home directory on the Ubuntu system.

PermalinkDownload your Kong Enterprise License

Kong Gateway requires a license to run.

If you have lost access to your license.json file but still have a valid license for Kong Gateway, open a support case to request the file.

  1. Download the license.json file you received from Kong Support.

  2. Open the file and ensure it’s in proper JSON format:

     {"license":{"signature":"91e6dd9716d12ffsn4a5ckkb16a556dbebdbc4d0a66d9b2c53f8c8d717eb93dd2bdbe2cb3ef51c20806f14345128907da35","payload":{"customer":"Kong Inc","license_creation_date":"2019-05-07","product_subscription":"Kong Enterprise Edition","admin_seats":"5","support_plan":"None","license_expiration_date":"2021-04-01","license_key":"00Q1K00000zuUAwUAM_a1V1K000005kRhuUAE"},"version":1}}

  3. Securely copy the license file to your home directory on the Ubuntu system:

     $ scp license.json <ubuntu_username>@<server>:~

PermalinkResult

You should now have two files in your home directory on the target system:

  • The Kong .deb package file
  • The license file license.json

PermalinkStep 2. Install Kong Enterprise

  1. Update APT and install dependencies

     $ sudo apt-get update
 $ sudo apt-get install openssl libpcre3 procps perl

  2. Install Kong Enterprise

     $ sudo dpkg -i kong-enterprise-edition-<VERSION_NUMBER>.deb

    Note: Your version may be different based on when you obtained the package

  3. Copy the license file to the /etc/kong directory

     $ sudo cp license.json /etc/kong/license.json

  4. Kong will look for a valid license in this location.

PermalinkStep 3. Set up PostgreSQL

PostgreSQL is available in all Ubuntu versions by default. However, Ubuntu “snapshots” a specific version of PostgreSQL that is then supported throughout the lifetime of that Ubuntu version. Other versions of PostgreSQL are available through the PostgreSQL apt repository. Kong supports version 9.5 and higher. Ensure the distribution of PostgreSQL for your version of Ubuntu is a supported version. More information about PostgreSQL on Ubuntu can be found here: https://www.postgresql.org/download/linux/ubuntu/.

  1. Install PostgreSQL. This command may not work on all version of Ubuntu.

     $ sudo apt-get install postgresql postgresql-contrib

  2. Switch to PostgreSQL user and launch PostgreSQL

     $ sudo -i -u postgres
 $ psql

  3. Create a Kong database with a username and password.

     $ psql> CREATE USER kong; CREATE DATABASE kong OWNER kong; ALTER USER kong WITH password 'kong';

    ⚠️ Note: Make sure the username and password for the Kong Database are kept safe. This example uses a simple username and password for illustration purposes only. Note the database name, username and password for later.

  4. Exit from PostgreSQL and return to your terminal account.

     $ psql> \q
 $ exit

PermalinkStep 4. Modify Kong’s Configuration File

  1. Make a copy of Kong’s default configuration file.

     $ sudo cp /etc/kong/kong.conf.default /etc/kong/kong.conf

  2. Uncomment and update the PostgreSQL database properties in /etc/kong/kong.conf using your preferred text editor. Replace pg_user, pg_password, and pg_database with the values:

     pg_user = kong
 pg_password = kong
 pg_database = kong

PermalinkStep 5. Seed the Super Admin’s Password and bootstrap Kong

Setting a password for the Super Admin before initial start-up is strongly recommended. This will permit the use of RBAC (Role Based Access Control) at a later time, if needed.

  1. Create an environment variable with the desired Super Admin password and store the password in a safe place. Run migrations to prepare the Kong database:

     $ sudo KONG_PASSWORD=<password-only-you-know> /usr/local/bin/kong migrations bootstrap -c /etc/kong/kong.conf

  2. Start Kong Enterprise:

     $ sudo /usr/local/bin/kong start -c /etc/kong/kong.conf

  3. Verify Kong Enterprise is working:

     $ curl -i -X GET --url http://localhost:8001/services

  4. You should receive a HTTP/1.1 200 OK message.

PermalinkStep 6. Finalize your Configuration and Verify Kong was Successfully installed:

PermalinkEnable and Configure Kong Manager

  1. To access Kong Enterprise’s Graphical User Interface, Kong Manager, update the admin_gui_url property in /etc/kong/kong.conf file the to the DNS or IP address of the system. For example:

     admin_gui_url = http://<DNSorIP>:8002

    This setting needs to resolve to a network path that will reach the host.

  2. It is necessary to update the administration API setting to listen on the needed network interfaces on the host. A setting of 0.0.0.0:8001 will listen on port 8001 on all available network interfaces.

     admin_listen = 0.0.0.0:8001, 0.0.0.0:8444 ssl

  3. You may also list network interfaces separately as in this example:

     admin_listen = 0.0.0.0:8001, 0.0.0.0:8444 ssl, 127.0.0.1:8001, 127.0.0.1:8444 ssl

  4. Restart Kong for the setting to take effect:

     $ sudo /usr/local/bin/kong restart

  5. You may now access Kong Manager on port 8002.

PermalinkEnable the Developer Portal

  1. Enable Kong Enterprise’s Developer Portal by updating /etc/kong/kong.conf to set the portal property to on and the portal_gui_host property to the DNS or IP address of the system. For example:

     portal = on
 portal_gui_host = <DNSorIP>:8003

  2. Restart Kong for the setting to take effect:

     $ sudo /usr/local/bin/kong restart

  3. The final step is to enable the Developer Portal. To do this, execute the following command, updating DNSorIP to reflect the IP or valid DNS for the system.

     $ curl -X PATCH http://<DNSorIP>:8001/workspaces/default --data "config.portal=true"

  4. You can now access the Developer Portal on the default workspace with a URL like:

     http://<DNSorIP>:8003/default

PermalinkTroubleshooting

If you did not receive an HTTP/1.1 200 OK message or need assistance completing your setup, reach out to your Kong Support contact or go to the Support Portal.

PermalinkNext Steps

Check out Kong Enterprise’s series of Getting Started guides to get the most out of Kong Enterprise.