Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat: Kong Manager OSS documentation #5864

Merged
merged 14 commits into from
Aug 7, 2023
Merged
Show file tree
Hide file tree
Changes from 9 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added app/_assets/images/docs/gateway/km_oss.png
cloudjumpercat marked this conversation as resolved.
Show resolved Hide resolved
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions app/_data/docs_nav_gateway_3.4.x.yml
Original file line number Diff line number Diff line change
Expand Up @@ -431,6 +431,11 @@ items:
url: /kong-manager/consumer-groups
- text: Sending Email
url: /kong-manager/configuring-to-send-email
- title: Kong Manager Open Source
icon:
items:
- text: Overview
url: /kong-manager-oss/

- title: Develop Custom Plugins
icon: /assets/images/icons/documentation/icn-dev-portal-color.svg
Expand Down
2 changes: 1 addition & 1 deletion app/_data/tables/features/gateway.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ features:
enterprise: true
- name: "Kong Manager: Admin GUI"
tooltip: Visually manage Kong cluster, plugins, APIs, and consumers
oss: false
oss: true
enterprise: true
- name: Traffic Management and Transformations
items:
Expand Down
5 changes: 5 additions & 0 deletions app/_src/gateway/get-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,11 @@ This script uses Docker to run {{site.base_gateway}} and a [PostgreSQL](https://

While the rest of this guide demonstrates configuring {{site.base_gateway}} using the Admin API, you can also use Kong Manager to manage your Services, Routes, Plugins, and more. To access Kong Manager, go to the following URL: [http://localhost:8002](http://localhost:8002)

{% if_version gte:3.4.x %}
{:.note}
> **Note:** If you install {{site.ce_product_name}}, you will use [Kong Manager Open Source](/gateway/{{page.kong_version}}/kong-manager-oss/). All other {{site.base_gateway}} installations use [Kong Manager Enterprise](/gateway/{{page.kong_version}}/kong-manager/).
{% endif_version %}

Every step in this tutorial requires a running {{site.base_gateway}}, so leave
everything running and proceed to the next steps in this tutorial.

8 changes: 4 additions & 4 deletions app/_src/gateway/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ the [PDK reference](/gateway/{{page.kong_version}}/plugin-development/pdk/), and
## Packages and modes

There are two ways to deploy {{site.base_gateway}}: cloud-hosted with {{ site.konnect_saas }}, and on-premises. If you're trying
out {{site.base_gateway}} for the first time we, recommend starting with [{{ site.konnect_saas }}](https://konghq.com/products/kong-konnect/register?utm_medium=referral&utm_source=docs&utm_campaign=gateway-konnect&utm_content=gateway-mode-overview).
out {{site.base_gateway}} for the first time, Kong recommends starting with [{{ site.konnect_saas }}](https://konghq.com/products/kong-konnect/register?utm_medium=referral&utm_source=docs&utm_campaign=gateway-konnect&utm_content=gateway-mode-overview).

### Cloud-hosted with Konnect

Expand All @@ -115,7 +115,7 @@ See the [Konnect documentation](/konnect/) and the

**{{site.base_gateway}} (OSS)**: an open-source package containing the basic API gateway
functionality and open-source plugins. You can manage the open-source Gateway
with Kong's [Admin API](#kong-admin-api) or with [declarative configuration](#deck).
with Kong's [Admin API](#kong-admin-api){% if_version gte:3.4.x %}, [Kong Manager Open Source](/gateway/{{page.kong_version}}/kong-manager-oss/),{% endif_version %} or with [declarative configuration](#deck).

**{{site.base_gateway}}** (available in
[Free or Enterprise mode](https://konghq.com/pricing)): Kong's API gateway
Expand Down Expand Up @@ -212,7 +212,7 @@ the Kong Admin API.
To test it out, you can choose either the open-source package, or
run {{site.base_gateway}} in free mode and also try out Kong Manager.

After installation, get started with our introductory [quickstart guide](/gateway/{{page.kong_version}}/get-started/)
After installation, get started with the introductory [quickstart guide](/gateway/{{page.kong_version}}/get-started/)

### Try in {{site.konnect_short_name}}

Expand All @@ -233,4 +233,4 @@ Kong primarily follows a [semantic versioning](https://semver.org/) (SemVer)
model for its products.

For the latest version support information for {{site.ee_product_name}} and
{{site.mesh_product_name}}, see our [version support policy](/gateway/{{page.kong_version}}/support-policy/).
{{site.mesh_product_name}}, see the [version support policy](/gateway/{{page.kong_version}}/support-policy/).
38 changes: 38 additions & 0 deletions app/_src/gateway/kong-manager-oss/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: About Kong Manager Open Source
badge: oss
---

Kong Manager Open Source (OSS) is the graphical user interface (GUI) for {{site.ce_product_name}}. It uses the Kong Admin API under the hood to administer and control {{site.ce_product_name}}. To access Kong Manager OSS, go to the following URL after installing {{site.ce_product_name}}: [http://localhost:8002](http://localhost:8002)

Here are some of the things you can do with Kong Manager OSS:

* Create new routes and services
* Activate or deactivate plugins
* Group your services, plugins, consumer management, and everything else exactly how you want them
* Manage certificates
* Centrally store and easily access key sets and keys.

{:.note}
> **Note:** If you are using the Enterprise image of {{site.base_gateway}}, you can use the [Kong Manager Enterprise](/gateway/{{page.kong_version}}/kong-manager/).

## Kong Manager OSS interface

![Kong Manager OSS interface](/assets/images/docs/gateway/km_oss.png)

> Figure 1: Kong Manager OSS overview

Item | Description
cloudjumpercat marked this conversation as resolved.
Show resolved Hide resolved
------|------------
**Overview** | Dashboard that contains information about your {{site.ce_product_name}}.
**Gateway Services** | Overview of all services associated with your {{site.ce_product_name}}. From this dashboard, you can add new services, manage existing services, and see all services at a glance.
**Routes** | Overview of all routes associated with your {{site.ce_product_name}}. From this dashboard, you can add new routes, manage existing routes, and see all routes at a glance.
**Consumers** | Overview of all consumers associated with your {{site.ce_product_name}}. From this dashboard, you can add new consumers, manage existing consumers, and see all consumers at a glance.
**Plugins** | Overview of all plugins associated with your {{site.ce_product_name}}. From this dashboard, you can enable or disable plugins.
**Upstreams** | Overview of all upstreams associated with your {{site.ce_product_name}}. From this dashboard, you can add new upstreams, manage existing upstreams, and see all upstreams at a glance.
**Certificates** | Manage your certificates for SSL/TLS termination for encrypted requests.
**CA Certificates** | Manage your CA certificates for client and server certificate validation.
**SNIs** | Manage SNI object one-to-many mappings of hostnames to a certificate.
**Vaults** | Manage the security of {{site.ce_product_name}} with centralized secrets.
**Keys** | Manage your asymmetric keys by adding a key object.
**Key Sets** | Manage your asymmetric key collections by adding a key set object.
8 changes: 8 additions & 0 deletions app/_src/gateway/production/networking/default-ports.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,16 @@ By default, {{site.base_gateway}} listens on the following ports:
| [`:8444`](/gateway/{{page.kong_version}}/reference/configuration/#admin_api_uri) | HTTPS | Admin API. Listens for calls from the command line over HTTPS. | All tiers and modes |
| [`:8005`](/gateway/{{page.kong_version}}/production/deployment-topologies/hybrid-mode/setup/) | TCP | Hybrid mode only. Control Plane listens for traffic from Data Planes. | All tiers and modes |
| [`:8006`](/gateway/{{page.kong_version}}/production/deployment-topologies/hybrid-mode/setup/) | TCP | Hybrid mode only. Control Plane listens for Vitals telemetry data from Data Planes. | {{site.base_gateway}} Enterprise tier |
{% if_version lte:3.3.x %}

| [`:8002`](/gateway/{{page.kong_version}}/reference/configuration/#admin_gui_listen) | HTTP | Kong Manager (GUI). Listens for HTTP traffic. | {{site.base_gateway}} free mode |
| [`:8445`](/gateway/{{page.kong_version}}/reference/configuration/#admin_gui_listen) | HTTPS | Kong Manager (GUI). Listens for HTTPS traffic. | {{site.base_gateway}} free mode |
{% endif_version %}
{% if_version gte:3.4.x %}

| [`:8002`](/gateway/{{page.kong_version}}/reference/configuration/#admin_gui_listen) | HTTP | Kong Manager (GUI). Listens for HTTP traffic. | All tiers and modes |
| [`:8445`](/gateway/{{page.kong_version}}/reference/configuration/#admin_gui_listen) | HTTPS | Kong Manager (GUI). Listens for HTTPS traffic. | All tiers and modes |
{% endif_version %}
| [`:8003`](/gateway/{{page.kong_version}}/reference/configuration/#portal_gui_listen) | HTTP | Dev Portal. Listens for HTTP traffic, assuming Dev Portal is **enabled**. | {{site.base_gateway}} Enterprise tier |
| [`:8446`](/gateway/{{page.kong_version}}/reference/configuration/#portal_gui_listen) | HTTPS | Dev Portal. Listens for HTTPS traffic, assuming Dev Portal is **enabled**. | {{site.base_gateway}} Enterprise tier |
| [`:8004`](/gateway/{{page.kong_version}}/reference/configuration/#portal_api_listen) | HTTP | Dev Portal `/files` traffic over HTTP, assuming the Dev Portal is **enabled**. | {{site.base_gateway}} Enterprise tier |
Expand Down
16 changes: 7 additions & 9 deletions app/_src/gateway/reference/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -2554,9 +2554,8 @@ Turn on FIPS mode; this mode is only available on a FIPS build.

The Admin GUI for Kong Enterprise.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove the badge changes from this file (configuration.md). The badges have been added in #5881, along with the script update that'll make sure the right badges get picked up in subsequent versions.



### admin_gui_listen
{:.badge .free}
{% if_version lte:3.3.x %}{:.badge .free}{% endif_version %}

Kong Manager Listeners

Expand All @@ -2571,7 +2570,7 @@ directive.


### admin_gui_url
{:.badge .free}
{% if_version lte:3.3.x %}{:.badge .free}{% endif_version %}

Kong Manager URL

Expand All @@ -2592,11 +2591,10 @@ resolved listener port depending on the requested protocol.

**Default:** none


{% if_version gte:3.1.x %}

### admin_gui_path
{:.badge .free}
{% if_version lte:3.3.x %}{:.badge .free}{% endif_version %}

Kong Manager base path

Expand Down Expand Up @@ -2626,7 +2624,7 @@ Examples:
{% endif_version %}

### admin_gui_ssl_cert
{:.badge .free}
{% if_version lte:3.3.x %}{:.badge .free}{% endif_version %}

{% if_version lte:3.0.x %}
The absolute path to the SSL certificate for `admin_gui_listen` values with SSL
Expand All @@ -2646,7 +2644,7 @@ Values:


### admin_gui_ssl_cert_key
{:.badge .free}
{% if_version lte:3.3.x %}{:.badge .free}{% endif_version %}

{% if_version lte:3.0.x %}
The absolute path to the SSL key for `admin_gui_listen` values with SSL
Expand Down Expand Up @@ -2676,7 +2674,7 @@ Alters the layout Admin GUI (JSON) The only supported value is `{


### admin_gui_access_log
{:.badge .free}
{% if_version lte:3.3.x %}{:.badge .free}{% endif_version %}

Kong Manager Access Logs

Expand All @@ -2689,7 +2687,7 @@ Setting this value to `off` disables access logs for Kong Manager.


### admin_gui_error_log
{:.badge .free}
{% if_version lte:3.3.x %}{:.badge .free}{% endif_version %}

Kong Manager Error Logs

Expand Down