Skip to content

Commit

Permalink
Merge branch 'release/gateway-3.5' into DOCU-3547
Browse files Browse the repository at this point in the history
  • Loading branch information
Guaris authored Oct 25, 2023
2 parents b4f60d0 + eaf1f19 commit 9f41373
Show file tree
Hide file tree
Showing 13 changed files with 84 additions and 103 deletions.
87 changes: 0 additions & 87 deletions app/_data/docs_nav_gateway_3.5.x.yml
Original file line number Diff line number Diff line change
Expand Up @@ -244,18 +244,6 @@ items:
items:
- text: Overview
url: /kong-enterprise/
- text: Kong Vitals
items:
- text: Overview
url: /kong-enterprise/analytics/
- text: Metrics
url: /kong-enterprise/analytics/metrics
- text: Analytics with InfluxDB
url: /kong-enterprise/analytics/influx-strategy
- text: Analytics with Prometheus
url: /kong-enterprise/analytics/prometheus-strategy
- text: Estimate Analytics Storage in PostgreSQL
url: /kong-enterprise/analytics/estimates
- text: Secrets Management
items:
- text: Overview
Expand Down Expand Up @@ -290,81 +278,6 @@ items:
url: /kong-enterprise/plugin-ordering/
- text: Get Started with Dynamic Plugin Ordering
url: /kong-enterprise/plugin-ordering/get-started
- text: Dev Portal
items:
- text: Overview
url: /kong-enterprise/dev-portal/
- text: Enable the Dev Portal
url: /kong-enterprise/dev-portal/enable
- text: Publish an OpenAPI Spec
url: /kong-enterprise/dev-portal/publish-spec
- text: Structure and File Types
url: /kong-enterprise/dev-portal/structure-and-file-types
- text: Themes Files
url: /kong-enterprise/dev-portal/themes
- text: Working with Templates
url: /kong-enterprise/dev-portal/working-with-templates
- text: Using the Editor
url: /kong-enterprise/dev-portal/using-the-editor
- text: Authentication and Authorization
items:
- text: Basic Auth
url: /kong-enterprise/dev-portal/authentication/basic-auth
- text: Key Auth
url: /kong-enterprise/dev-portal/authentication/key-auth
- text: OIDC
url: /kong-enterprise/dev-portal/authentication/oidc
- text: Sessions
url: /kong-enterprise/dev-portal/authentication/sessions
- text: Adding Custom Registration Fields
url: /kong-enterprise/dev-portal/authentication/adding-registration-fields
- text: Manage Developers
url: /kong-enterprise/dev-portal/authentication/managing-developers
- text: Developer Roles and Content Permissions
url: /kong-enterprise/dev-portal/authentication/developer-permissions
- text: Application Registration
items:
- text: Authorization Provider Strategy
url: /kong-enterprise/dev-portal/applications/auth-provider-strategy
- text: Enable Application Registration
url: /kong-enterprise/dev-portal/applications/enable-application-registration
- text: Enable Key Authentication for Application Registration
url: /kong-enterprise/dev-portal/applications/enable-key-auth-plugin
- text: Enable External Authentication
items:
- text: External OAuth2 Support
url: /kong-enterprise/dev-portal/authentication/3rd-party-oauth
- text: Set up Okta and Kong for External Oauth
url: /kong-enterprise/dev-portal/authentication/okta-config
- text: Set up Azure AD and Kong for External Authentication
url: /kong-enterprise/dev-portal/authentication/azure-oidc-config
- text: Manage Applications
url: /kong-enterprise/dev-portal/applications/managing-applications
- text: Customize Dev Portal
items:
- text: Theme Editing
url: /kong-enterprise/dev-portal/customize/theme-editing
- text: Migrating Templates Between Workspaces
url: /kong-enterprise/dev-portal/customize/migrating-templates
- text: Markdown Rendering Module
url: /kong-enterprise/dev-portal/customize/markdown-extended
- text: Customizing Portal Emails
url: /kong-enterprise/dev-portal/customize/emails
- text: Adding and Using JavaScript Assets
url: /kong-enterprise/dev-portal/customize/adding-javascript-assets
- text: Single Page App in Dev Portal
url: /kong-enterprise/dev-portal/customize/single-page-app
- text: Alternate OpenAPI Renderer
url: /kong-enterprise/dev-portal/customize/alternate-openapi-renderer
- text: SMTP
url: /kong-enterprise/dev-portal/smtp
- text: Workspaces
url: /kong-enterprise/dev-portal/workspaces
- text: Helpers CLI
url: /kong-enterprise/dev-portal/cli
- text: Portal API Documentation
url: https://developer.konghq.com/spec/3e65edbc-364d-4762-9d3e-f13083e1b534/33cd4595-e389-4c2b-80ee-5275f25e80e1
absolute_url: true
- text: Audit Logging
url: /kong-enterprise/audit-log
- text: Keyring and Data Encryption
Expand Down
10 changes: 6 additions & 4 deletions app/_hub/kong-inc/mocking/overview/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,12 @@ Benefits of service mocking with the Kong Mocking plugin:
- Conforms to a design-first approach since mock responses are within OAS.
- Accelerates development of services and APIs.
- Promotes parallel development of APIs across distributed teams.
- Easily enable and disable the Mocking plugin for flexibility when testing API behavior.
{% if_plugin_version lte:3.4.x %}
- Provides an enhanced full lifecycle API development experience with Dev Portal
integration.
- Easily enable and disable the Mocking plugin for flexibility when
testing API behavior.
{% endif_plugin_version %}


This plugin can mock `200`, `201`, and `204` responses.

Expand Down Expand Up @@ -121,7 +123,7 @@ HTTP/1.1 500 Internal Server Error
"message": "500"
}
```

{% if_plugin_version lte:3.4.x %}
## Tutorial Example

This example tutorial steps you through testing a mock response for
Expand Down Expand Up @@ -760,7 +762,7 @@ The service URL can be anything for purposes of mocking. After you disable the M
ensure you set the actual URL for your service so that the response can be received.

![Set Real Service URL](/assets/images/products/gateway/dev-portal/km-service-url.png)

{% endif_plugin_version %}
## See also
* [`inso` CLI documentation](https://support.insomnia.rest/collection/105-inso-cli)

2 changes: 2 additions & 0 deletions app/_hub/kong-inc/session/overview/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,11 @@ session data storage, encryption, renewal, expiry, and sending browser cookies.
It is built using
[lua-resty-session](https://github.com/bungle/lua-resty-session).

{% if_plugin_version lte:3.4.x %}
For information about configuring and using the Session plugin with the Dev
Portal, see [Sessions in the Dev Portal](/gateway/latest/developer-portal/configuration/authentication/sessions/#configuration-to-use-the-sessions-plugin-with-the-dev-portal).

{% endif_plugin_version %}
## How it works

The Session plugin can be configured globally or with an entity (for example, a service or a route)
Expand Down
2 changes: 2 additions & 0 deletions app/_includes/feature-table.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
</thead>
<tbody>
{% for f in include.config.features %}
{% if f.name != "Observability" %}
<tr>
<td class="header-row">
<span>{{ f.name }}</span>
Expand Down Expand Up @@ -58,6 +59,7 @@
{% endfor %}
</tr>
{% endfor %}
{% endif %}
{% endfor %}
</tbody>
</table>
8 changes: 7 additions & 1 deletion app/_redirects
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,13 @@
/konnect/getting-started/configure-runtime/ /konnect/getting-started/configure-data-plane-node/
/konnect/api/runtime-groups-config/overview/ /konnect/api/

#3.4

# 3.5
/gateway/latest/kong-enterprise/analytics/* /gateway/3.4.x/kong-enterprise/analytics/:splat
/gateway/latest/kong-enterprise/dev-portal/* /gateway/3.4.x/kong-enterprise/dev-portal/:splat


# 3.4

/gateway/latest/production/security-update-process /gateway/latest/support/vulnerability-patching-process
/gateway/latest/kong-enterprise/consumer-groups /gateway/latest/key-concepts/consumer-groups
Expand Down
7 changes: 5 additions & 2 deletions app/_src/gateway/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,8 +127,9 @@ with added functionality.
this package adds [Kong Manager](#kong-manager) to the basic open-source functionality.
* <span class="badge enterprise"></span> With an **Enterprise** subscription,
it also includes:
{% if_version lte:3.4.x %}
* [Dev Portal](#kong-dev-portal)
* [Vitals](#kong-vitals)
* [Vitals](#kong-vitals){% endif_version %}
* [RBAC](/gateway/{{page.kong_version}}/admin-api/rbac/reference/)
* [Enterprise plugins](/hub/)

Expand Down Expand Up @@ -173,6 +174,7 @@ Here are some of the things you can do with Kong Manager:
* Activate or deactivate plugins with a couple of clicks
* Group your teams, services, plugins, consumer management, and everything else
exactly how you want them
{% if_version lte:3.4.x %}
* Monitor performance: visualize cluster-wide, workspace-level, or
object-level health using intuitive, customizable dashboards

Expand All @@ -181,11 +183,12 @@ object-level health using intuitive, customizable dashboards

[Kong Dev Portal](/gateway/{{page.kong_version}}/kong-enterprise/dev-portal/) is used to onboard new developers and to generate API documentation, create custom pages, manage API versions, and secure developer access.


### Kong Vitals
{:.badge .enterprise}

[Kong Vitals](/gateway/{{page.kong_version}}/kong-enterprise/analytics/) provides useful metrics about the health and performance of your {{site.base_gateway}} nodes, as well as metrics about the usage of your proxied APIs. You can visually monitor vital signs and pinpoint anomalies in real-time, and use visual API analytics to see exactly how your APIs and Gateway are performing and access key statistics. Kong Vitals is part of the Kong Manager UI.

{% endif_version %}
### Kubernetes

{{site.base_gateway}} can run natively on Kubernetes with its custom [ingress controller](/kubernetes-ingress-controller/), Helm chart, and Operator. A Kubernetes ingress controller is a proxy that exposes Kubernetes services from applications (for example, Deployments, ReplicaSets) running on a Kubernetes cluster to client applications running outside of the cluster. The intent of an ingress controller is to provide a single point of control for all incoming traffic into the Kubernetes cluster.
Expand Down
8 changes: 6 additions & 2 deletions app/_src/gateway/install/kubernetes/deployment-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,17 +58,21 @@ available in DB-less deployments.

Some Enterprise features are not available in DB-less deployments.
Use a database-backed deployment if you want to use:

* Dev Portal
* Teams (RBAC)
* Workspaces
{% if_version lte:3.4.x %}
* Dev Portal
{% endif_version %}


The following features have support in DB-less mode, but
work differently than in DB-backed modes:

* Kong Manager (read-only)
{% if_version lte:3.4.x %}
* Vitals (using [Prometheus][vitals-prometheus] or [InfluxDB][vitals-influxdb]
strategies)
{% endif_version %}

When {{site.base_gateway}} is configured by the ingress controller, some
functionality in these features is different from traditional deployments:
Expand Down
3 changes: 2 additions & 1 deletion app/_src/gateway/kong-enterprise/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ It offers exclusive versions of OSS plugins like the [Rate Limiting Advanced plu
* [API product tiers](https://developer.konghq.com/spec/937dcdd7-4485-47dc-af5f-b805d562552f/be79b812-46d5-4cc1-b757-b5270bf4fa60#/consumer_groups/get-consumer_groups)
{% endif_version %}
[Get started with plugins &rarr;](/hub/)

{% if_version lte:3.4.x %}
## Dev Portal

The Dev Portal provides a single source of truth for all developers to locate, access and consume APIs, similar to a traditional API catalog.
Expand All @@ -45,6 +45,7 @@ The Vitals platform provides deep insights into services, routes, and applicatio

[Start monitoring with Vitals &rarr;](/gateway/{{page.kong_version}}/kong-enterprise/analytics/)

{% endif_version %}
## Role-based access control (RBAC)

{{site.ee_product_name}} lets you configure users, roles, and permissions with built-in role-based access control (RBAC). With RBAC, you can streamline developer onboarding, and create apply fine-grained security and traffic policies using the [Admin API](/gateway/{{page.kong_version}}/admin-api/rbac/reference/), or [Kong Manager](/gateway/{{page.kong_version}}/kong-manager/auth/rbac/).
Expand Down
32 changes: 29 additions & 3 deletions app/_src/gateway/kong-manager/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,28 @@ Here are some of the things you can do with Kong Manager:
![Kong Manager interface](/assets/images/products/gateway/km_workspace_3.0.png)
{% endif_version %}

{% if_version gte:3.1.x %}
{% if_version gte:3.1.x lte:3.4.x %}
![Kong Manager interface](/assets/images/products/gateway/km_workspace_3.1.png)
{% endif_version %}

{% if_version gte:3.5.x %}
![Kong Manager interface](/assets/images/products/gateway/km_workspace_3.5.png)
{% endif_version %}
> Figure 1: Kong Manager individual workspace dashboard
### Top menu

{% if_version gte:3.5.x %}

Item | Description
-----|------------
**Workspaces** | Dashboard for all the workspaces in the cluster.
**Teams** | Manage team roles and permissions with RBAC, or map groups to your IdP.

{% endif_version %}

{% if_version gte:3.1.x lte:3.4.x %}

Number | Item | Description
-------|------|------------
1 | **Workspaces** | Dashboard for all the workspaces in the cluster.
Expand All @@ -46,8 +60,19 @@ Number | Item | Description
4 | **Teams** | Manage team roles and permissions with RBAC, or map groups to your IdP.
5 | **Account settings** | Manage your password and RBAC token.

{% endif_version %}
### Side menu

{% if_version gte:3.5.x %}

Item | Description
-----|------------
**Dashboard** | See information about a workspace.
**API Gateway** | Manage the {{site.base_gateway}} entities in the current workspace.
**Secrets** | Manage vaults, keys and key sets for your environment.
{% endif_version %}
{% if_version lte:3.4.x %}

Number | Item | Description
-------|------|------------
6 | **Change workspace** | Shortcut to quickly change between workspaces.
Expand All @@ -57,11 +82,11 @@ Number | Item | Description
{% if_version gte:3.1.x %}
10 | **Vaults** | Manage secret vaults in your environment.
{% endif_version %}

{% if_version gte:3.2.x %}
11 | **Keys** | Centrally store and easily access key sets and keys.
{% endif_version %}

{% endif_version %}
{% if_version lte:3.4.x %}
### Workspace dashboard

{% if_version lte:3.0.x %}
Expand All @@ -81,3 +106,4 @@ Number | Item | Description
13 | **Total traffic graph** | Total traffic in the workspace by status code within a selected time frame.
14 | **Time frame selector** | Choose the time frame for the traffic graph, from the last 5 minutes to the last 12 hours.
{% endif_version %}
{% endif_version %}
4 changes: 2 additions & 2 deletions app/_src/gateway/upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -270,9 +270,9 @@ executing `kong config db_import config.lua`, convert the `config.lua` file into
before upgrading.

### Admin API

{% if_version lte:3.4.x %}
The Admin API endpoint `/vitals/reports` has been removed.

{% endif_version %}
`POST` requests on `/targets` endpoints are no longer able to update
existing entities. They are only able to create new ones.
If you have scripts that use `POST` requests to modify `/targets`, change them to `PUT`
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 13 additions & 0 deletions tools/screenshots/gateway/kong-manager/kong-manager.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
- output: ../../app/assets/images/products/gateway/km_workspace_3.5.png
url: http://localhost:8002/default/dashboard
wait: 4000
width: 1280
height: 1024
javascript: |
async () => {
clickElement("#app > aside > div.sidebar-content-container > nav > ul > li:nth-child(2) > div > a");
removeElementBySelector("#app > header > div > div.navbar-content > div.navbar-content-left > div > a.header-link.header-link-portals");
removeElementBySelector("#app > header > div > div.navbar-content > div.navbar-content-left > div > a.header-link.header-link-vitals");
removeElementBySelector("#app > aside > div.sidebar-content-container > nav > ul > li:nth-child(3) > div > a > div");
removeElementBySelector("#kong-ui-app-layout-notification > div");
}
11 changes: 10 additions & 1 deletion tools/screenshots/macros.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,16 @@
remove(".intercom-lightweight-app");
document.body.style.padding = "20px";
}
- type: function
name: clickElement
javascript: |
async function (selector) {
const elementToClick = document.querySelector(selector);
if (elementToClick) {
elementToClick.click();
await sleep(400);
}
}
- type: function
name: annotateNumber
javascript: |
Expand Down

0 comments on commit 9f41373

Please sign in to comment.