(Legacy) Manage Services through ServiceHub

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

Services

Add a Service to the Catalog

1. From the left navigation menu, click Services to open ServiceHub.

2. Click Add New Service.

3. Enter a Service Name.

   A Service name can be any string containing letters, numbers, or characters; for example, service_name, Service Name, or Service-name.

4. Enter a Version Name.

   A version name can be any string containing letters, numbers, or characters; for example, 1.0.0, v.1, or version#1. A Service can have multiple versions.

5. (Optional) Enter a Description.

6. Click Create.

   A new Service is created and Konnect automatically redirects to the Service’s overview page.

Update a Service

1. From the left navigation menu, click Services.

2. Select a Service from the list.

3. Edit the Service name and description directly on this page: click on either element to reveal a text box, enter the new text, then click outside of the text box to save.

Delete a Service

1. From the left navigation menu, click Services.

2. Select a Service from the list.

3. In the top right of the overview page, click the Actions menu and select Delete Service.

4. In the dialog that appears, confirm that you want to delete this service.

Service Versions and Implementations

Create a New Service Version

1. From the left navigation menu, click Services.

2. Select a Service from the dropdown menu.

3. Navigate to Versions, and click + New Version.

4. Enter a version name and click Create to save.

Delete a Service Version

1. From the left navigation menu, click Services.

2. Select a Service from the dropdown menu.

3. Navigate to Versions.

4. Click on the version you want to delete, and you’ll be taken to the version detail page.

5. Click on the Actions dropdown menu.

6. Click Delete Version to permanently delete the Service version.

Implement a Service Version (Kong Gateway)

1. From the left navigation menu, click Services, then select a Service version.

2. Click New Implementation.

3. In the Create Implementation dialog, in step 1, enter the connection details for the upstream service.

   1. Enter a URL in the default Add using URL field, or switch to Add using Protocol, Host and Path and enter each piece separately.

   2. (Optional) Expand to View 6 Advanced Fields and further customize your implementation.

      See the Service Object documentation for parameter descriptions.

   3. Click Next.

4. In step 2, Add a Route to your Service Implementation.

   1. Enter any name.

      This Route name must be unique in the account. Variations on capitalization are considered unique, for example, foo and Foo.

   2. For Method, enter an HTTP method or a comma-separated list of methods that match this Route.

      For example, GET or GET, POST.

   3. For Path(s), click Add Path and enter a path in the format /<path>.

   4. (Optional) Click View 4 Advanced Fields to see all options. You can accept the defaults, or further customize your Route.

      See the Route Object documentation for parameter descriptions.

   5. Click Create.

   The Service version overview displays.

   If you want to view the configuration, edit or delete the implementation, or delete the version, click the Actions menu.

Add a Route to a Version

When creating an implementation, you only create one Route. If the Service version needs more Routes, you can add them to the version after creating the first one.

1. From the left navigation menu, click Services, then select a Service version.

2. In the Routes section, click New Route.

3. Fill in the fields as described in Implement a Service Version, then click Create.

Verify an Implementation

For any runtime instance created with the provided Docker script (see Setting up a Kong Gateway Runtime), the default proxy URL is localhost:8000.

Enter the proxy URL into your browser’s address bar and append any route path. The final URL should look something like this:

http://localhost:8000/foo

If successful, you’ll be able to access your upstream service. The Service version’s overview page will also update with a new record for status code 200. This might take a few moments.