Getting started with your Kong Enterprise trial!
Welcome to Kong Enterprise! This guide provides an overview of using Kong Enterprise, and quickly gets you up and running using a full-featured 15-day free trial of Kong Enterprise in the cloud.
The first part of this guide gets you started using Kong Enterprise. If you have any questions, please contact us at firstname.lastname@example.org at any time.
Get started using Kong Enterprise
Get started with Kong Enterprise using the steps in this section to proxy API traffic and enable a Plugin.
• Your Kong Enterprise trial email
• A web browser
• A terminal with cURL installed
Step 1: Connect to your trial
From the Welcome to your Kong Enterprise trial! email, click the Log in now button. You are connected directly to your Kong Enterprise trial.
Step 2: Proxy API traffic
Start to proxy API traffic using a Workspace to set up a Service and a Route.
1. Use a Workspace. A Workspace is a segmented part of Kong Enterprise that allows a team to access its own entities separately from other teams. The default Workspace comes with your Kong Enterprise instance, and we’ll use this for your trial.
a. From the Workspaces tab, click the default Workspace. The default Workspace Dashboard displays.
2. Create a Service. A Service is the Admin API entity representing an external upstream API or microservice. For this trial, we’ll name the Service trial-service and use the URL https://httpbin.org. httpbin is a simple HTTP Request & Response Service that allows you to test traffic.
a. Click Add a Service in the Services tile. The Create Service page displays.
b. Enter trial-service in the Name field.
c. Enter http://httpbin.org in the URL field. The Add using URL is selected by default.
d. Click Create. The Services details page displays for your new trial-service. This page has information about the Service and any related Routes and Plugins that are connected to the Service.
3. Create a Route. A Route is the entity that defines rules to match client requests.
a. Click Add a Route in the Route tile. The Create Route page displays.
b. Enter trial-route in the Name field.
c. Click Add a Path under Path(s) and enter / in the Path field.
d. Click Create. The Route details page displays for your new trial-route. This page has information about the Route.
Step 3: Add a Plugin on the Service
Add a Kong Plugin to extend the functionality of Kong Enterprise. Kong’s Plugin architecture supports a broad range of functionality, such as logging, rate-limiting, authentication, and more.
For this trial, set up Kong’s Rate Limiting Advanced Plugin to rate-limit how many HTTP requests a developer can make in a given period of seconds, minutes, hours, days, months or years. Plugins come pre-installed on Kong Enterprise, so all you need to do is enable and configure the Plugin.
1. Enable the Rate Limiting Advanced Plugin.
a. On the Plugins tab at the bottom of the page, click Add Plugin. The Add New Plugin page displays.
b. Scroll down to the Traffic Control section and find the Rate Limiting Advanced plugin. Click Enable. The Create new rate-limiting-advanced plugin page displays with fields partially pre-populated. While there are many configuration parameters you can add to this Plugin, as defined in the Rate Limiting Advanced Plugin documentation, in this trial we’ll use the following to configure the Plugin:
c. Scroll to config.limit and enter 10, 100
d. Scroll to config.sync_rate and enter 10
e. Scroll to config.window_size and enter 60, 3600
f. Click Create. The Plugin is configured and enabled.
Step 4: Test your setup
Test your new Service by issuing the following cURL request to verify Kong is properly forwarding requests to the Service. A successful response means Kong is now forwarding requests made to the Service URL and is forwarding the response back. Kong knows to do this through the header defined in the cURL request below.
1. For the cURL request, enter the following into a terminal window. Be sure to replace <your_trial_ID> with the ID of your trial instance. For example, if the URL of your trial is https://manager-company123.kong-cloud.com, you will replace <your_trial_ID> with company123.
2. A successful response should look like this:
Date: Wed, 13 Nov 2019 18:05:28 GMT
X-XSS-Protection: 1; mode=block
"origin": "127.0.0.1, 22.214.171.124, 127.0.0.1",
Congratulations! You have just managed your first API using Kong Enterprise.
Explore full features of Kong Enterprise
Moving beyond Kong Manager, explore other areas of Kong Enterprise.
Kong Proxy evaluates any incoming HTTP request against the Routes you have configured to find a matching one. If a given request matches the rules of a specific Route, Kong processes proxying the request. Because each Route is linked to a Service, Kong runs the plugins you have configured on your Route and its associated Service and then proxies the request upstream.
Kong Admin API provides a RESTful interface for administration and configuration of Services, Routes, Plugins, Consumers, and Credentials. All of the tasks you performed in the Kong Manager can be automated using the Kong Admin API.
Kong Developer Portal (Kong Dev Portal) is used to onboard new developers and to generate API documentation, create custom pages, manage API versions, and secure developer access.
Kong Developer Portal API has a feature-rich API reference editor, automatic API explorer, and code generation. All of the tasks you performed in the Kong Manager can be automated using the Kong Developer Portal API.
Navigating Kong Manager
The Kong Manager is a graphical user interface used to manage and configure Kong Enterprise. You can create and manage Workspaces, Services and Routes, activate or deactivate Plugins, and monitor the health of your deployment.
The Workspaces tab gives an overview of all the Workspaces in your organization. Workspaces enable you to segment traffic so that teams are only able to interact with entities from their groups. You can use the default Workspace or create a new Workspace, use the tile or list view to access available Workspaces, and drilldown to a Workspace dashboard.
From a Workspace Dashboard, you can create Services and Routes to proxy API traffic, enable Plugins to extend functionality, and access more features available on Kong Enterprise.
From the Teams tab, you can invite and manage admins and users, as well as assign Workspace roles and permissions.