Skip to content

Commit

Permalink
feat: Multi-geo GA (#6499)
Browse files Browse the repository at this point in the history
* Add back content from original multi-geo beta branch, add AU region

Signed-off-by: Diana <[email protected]>

* Added region specific hostname tables

Signed-off-by: Diana <[email protected]>

* Change region to geo, update file name to geo, add release notes

Signed-off-by: Diana <[email protected]>

* Update index.md

Adding region-specific URLs, confirmed region codes from https://deploy-preview-6499--kongdocs.netlify.app/konnect/geo/

* Update updates.md

* Apply code review feedback

Signed-off-by: Diana <[email protected]>

* Fix broken links

Signed-off-by: Diana <[email protected]>

* Change geo ordering to alphabetical

Signed-off-by: Diana <[email protected]>

---------

Signed-off-by: Diana <[email protected]>
Co-authored-by: Amy Goldsmith <[email protected]>
  • Loading branch information
cloudjumpercat and acgoldsmith authored Nov 21, 2023
1 parent 2da7a7f commit 6f87b78
Show file tree
Hide file tree
Showing 19 changed files with 162 additions and 36 deletions.
2 changes: 2 additions & 0 deletions app/_data/docs_nav_konnect.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@
url: /network-resiliency/
- text: Port and Network Requirements
url: /network/
- text: Geographic Regions
url: /geo/
- text: Compatibility
url: /compatibility/
- text: Stages of Software Availability
Expand Down
8 changes: 6 additions & 2 deletions app/_src/deck/guides/konnect.md
Original file line number Diff line number Diff line change
Expand Up @@ -206,8 +206,12 @@ The default API decK uses is `https://us.api.konghq.com`, which targets the `clo

{% if_version gte:1.14.x %}

{{site.base_gateway}} supports US and EU geographic regions.
To target the EU region, set `konnect-addr` to `"https://eu.api.konghq.com"`.
{{site.base_gateway}} supports AU, EU, and US [geographic regions](/konnect/geo/).

To target a specific geo, set `konnect-addr` to one of the following:
* AU geo:`"https://au.api.konghq.com"`
* EU geo:`"https://eu.api.konghq.com"`
* US geo:`"https://us.api.konghq.com"`

{% endif_version %}

Expand Down
4 changes: 4 additions & 0 deletions app/konnect/account-management/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,7 @@ control plane. You should never have to deal with a license
directly.

For any license questions, contact your sales representative.

## Geographic region management

When you create a {{site.konnect_saas}} account, you select a [geographic region](/konnect/geo) for your instance. Geos are distinct deployments of {{site.konnect_short_name}} with objects, such as services and consumers, that are geo-specific. Only authentication is shared between {{site.konnect_short_name}} geos.
3 changes: 3 additions & 0 deletions app/konnect/api-products/service-documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ A core function of the Dev Portal is publishing API product descriptions and API
Through API Products, you can also publish any API product and its
documentation to the Dev Portal. Publishing API products to the Dev Portal is the only way to expose your service to developers. Once the API product is published and available to developers, they can apply for access by [registering](/konnect/dev-portal/dev-reg/) a developer account. You can also [manage](/konnect/dev-portal/access-and-approval/manage-devs/) access to the Dev Portal from the {{site.konnect_saas}} interface.

{:.note}
> **Note**: You can only publish API products in your [geographic region](/konnect/geo) to the Dev Portal in your geo. If you want to publish API products to a Dev Portal in another geo, switch to the new geo in the bottom-left of {{site.konnect_product_name}}.
## API product descriptions

You can provide extended descriptions of your API products with a Markdown (`.md`) file. The contents of this file will be displayed as the introduction to your API in the Dev Portal. API product descriptions can be any markdown document that describes your service:
Expand Down
10 changes: 3 additions & 7 deletions app/konnect/api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,11 @@ disable_image_expand: true

## Base URLs

There are two types of base URLs that are used in {{site.konnect_short_name}} APIs:
{{site.konnect_short_name}} API base URLs differ based on the geo they are hosted in or if they are global. For a list of the API base URLs by geo, see [Ports and Network Requirements](/konnect/network/).

* **Global**: `https://global.api.konghq.com`
The global endpoint is used to manage geo-agnostic {{site.konnect_short_name}} entities that live in a global database. These APIs interact with entities that are not geo-specific and therefore do not have any regional boundaries. For example, identity management and IdP settings are all geo-agnostic configurations applied to the organization as a whole.

* **Region specific**: `https://{REGION_CODE}.api.konghq.com`

The global endpoint is used to manage region-agnostic {{site.konnect_short_name}} entities that live in a global database. These APIs interact with entities that are not region specific and therefore do not have any regional boundaries. For example, identity management and IdP settings are all region-agnostic configurations applied to the organization as a whole.

The region-specific endpoints are used to manage {{site.konnect_short_name}} entities that live in a specific {{site.konnect_short_name}} region. These APIs interact with entities specific to a region and do not have the ability to cross regional boundaries. For example, control planes, data plane nodes, and API product listings are all region-specific entities and therefore must use the region-specific endpoint.
The geo-specific endpoints are used to manage {{site.konnect_short_name}} entities that live in a specific {{site.konnect_short_name}} geo. These APIs interact with entities specific to a geo and do not have the ability to cross regional boundaries. For example, control planes, data plane nodes, and API product listings are all geo-specific entities and therefore must use the geo-specific endpoint. See [Geographic Regions](/konnect/geo/) for more information.



Expand Down
8 changes: 5 additions & 3 deletions app/konnect/dev-portal/access.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,16 @@ The Dev Portal URL looks like this:

https://example.us.portal.konghq.com/

{:.note}
> **Note:** If you're hosting your Dev Portal through Netlify, the Dev Portal URL is the one you specify in the **Dev Portal** sidebar under **Settings** > **Portal Domain** > **Custom Self-Hosted UI Domain**.
Your Dev Portal URL may vary. Keep the following in mind:

* The Dev Portal URL varies based on geo.
* If you're hosting your Dev Portal through Netlify, the Dev Portal URL is the one you specify in the **Dev Portal** sidebar under **Settings** > **Portal Domain** > **Custom Self-Hosted UI Domain**.

## View an API product in the Dev Portal {#url}

The Dev Portal page contains a list of API Products that are published on the Dev Portal.

To find an API product in the Dev Portal, click {% konnect_icon dev-portal %} **Dev Portal** to open the **Published API Products** overview. This page lists every published API Product that is being managed by {{site.konnect_short_name}}.
To find an API product in the Dev Portal, click {% konnect_icon dev-portal %} **Dev Portal** to open the **Published API Products** overview. This page lists geo-specific published API products that are managed by {{site.konnect_short_name}}.

To open a published API Product in the Dev Portal:

Expand Down
8 changes: 6 additions & 2 deletions app/konnect/dev-portal/applications/enable-app-reg.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,17 @@ When you enable application registration, {{site.konnect_saas}} enables plugins
These plugins run inside the data plane to support application registration for the API product version and are managed by
{{site.konnect_saas}}.

Enabling application registration is specific to the [geographic region](/konnect/geo).
You must enable application registration in each geo that you want to allow developers to register with.
Each geo has their own API keys and specifications for application registration in their respective geo.

## Support for any control plane

App registration is fully supported in the `default` control plane when using the application `consumers` and the `acl` plugin. The `default` control plane is the one that is first created in each region when you create an organization.
App registration is fully supported in the `default` control plane when using the application `consumers` and the `acl` plugin. The `default` control plane is the one that is first created in each geo when you create an organization.
For non-`default` control planes, app registration is supported using the `konnect-application-auth` plugin available as of {{site.base_gateway}} 3.0.

{:.note}
> **Note:** Although it can be renamed, the [`default` control plane group](/konnect/gateway-manager/control-plane-groups/) will always be the first and oldest control plane group in each region.
> **Note:** Although it can be renamed, the [`default` control plane group](/konnect/gateway-manager/control-plane-groups/) will always be the first and oldest control plane group in each geo.
## Prerequisites

Expand Down
2 changes: 2 additions & 0 deletions app/konnect/dev-portal/dev-reg.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: Sign Up for a Dev Portal Account

Anyone that wants to access the {{site.konnect_short_name}} Dev Portal needs to register and request access to that specific Dev Portal, including {{site.konnect_short_name}} admins. Admins will have separate credentials for [{{site.konnect_short_name}}](https://cloud.konghq.com/) and the Dev Portal.

If your organization has multiple [geographic regions](/konnect/geo/), developers must register and request access to the Dev Portal in each geo separately. Dev Portals in different geos don't share any data, including developer information.

Developer registrations can be manually approved by {{site.konnect_short_name}} admins, or automatically approved by configuring your [auto-approve settings](/konnect/dev-portal/access-and-approval/auto-approve-devs-apps/).


Expand Down
1 change: 1 addition & 0 deletions app/konnect/gateway-manager/configuration/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ Gateway services can be managed though Gateway Manager:
* When you create a {{site.konnect_short_name}} service implementation through the Setup Wizard, it automatically creates a Gateway service.
* You can also create a Gateway service directly through Gateway Manager. This
service won't be attached to an API product by default.
* Services are geo-specific and are not shared between [geographic regions](/konnect/geo/).

To see if a Gateway service is connected to an API product, open its
detail page from {% konnect_icon runtimes %} **Gateway Manager** > **Gateway Services**. If it's attached to an
Expand Down
33 changes: 33 additions & 0 deletions app/konnect/geo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: Geographic Regions
content_type: explanation
no_version: true
---

{{site.konnect_saas}} allows you to host and operate your cloud instance in a geographic region that you specify. This is important for data privacy and regulatory compliance for you organization.

Geographic regions allow you to also operate {{site.konnect_saas}} in a similar geo to your users and their infrastructure applications.
<!--- Do not publish yet: "This reduces network latency and minimizes the blast-radius in the event of cross-region connectivity failures." -->

## Supported geos

{{site.konnect_saas}} currently supports the following geos:

* AU
* EU
* US

## Geo management

When you create a {{site.konnect_saas}} account, you select a geographic region for your instance. Geos are distinct deployments of {{site.konnect_short_name}} with objects, such as services and consumers, that are geo-specific. Only authentication, billing, and usage is shared between {{site.konnect_short_name}} geos.

The following objects are geo-specific and are not shared between geos:

* [Services](/konnect/servicehub/)
* [API products](/konnect/api-products/)
* [Service meshes and mesh zones](/konnect/mesh-manager/)
* [Routes](/konnect/getting-started/implement-service/)
* [Consumers](/konnect/gateway-manager/configuration/)
* [Application registration](/konnect/dev-portal/applications/enable-app-reg/)
* [Dev Portal](/konnect/dev-portal/access/)
* [Custom teams and roles](/konnect/org-management/teams-and-roles/)
1 change: 1 addition & 0 deletions app/konnect/getting-started/access-account.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ title: Create a Kong Konnect Account

- If using a social identity provider, you will be directed to the identity provider to sign in.
- If using an email address and password, you will need to verify your email by clicking on a link emailed to you.
- For both methods, you will need to select your default geo.

3. Create an organization by providing an organization name, then click **Create Organization**.

Expand Down
2 changes: 1 addition & 1 deletion app/konnect/getting-started/productize-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Productize a Service
---

Using [API Products](/konnect/api-products), you can create and manage API products to productize your services. Each API product consists of at least one API product version, and each API product version is connected to a Gateway service. Creating API products is the first step in making your APIs and their documentation available to developers.
Using [API Products](/konnect/api-products), you can create and manage API products to productize your services. Each API product consists of at least one API product version, and each API product version is connected to a Gateway service. Creating API products is the first step in making your APIs and their documentation available to developers. API products are geo-specific and are not shared between [geographic regions](/konnect/geo/).

![{{site.konnect_short_name}} service diagram](/assets/images/products/konnect/gateway-manager/konnect-services-diagram.png)

Expand Down
2 changes: 2 additions & 0 deletions app/konnect/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ lightweight, fast, and flexible API gateway.

* Providing a real-time, centralized view of all your services. Monitor golden signals such as error rate and latency for each service and route to gain deep insights into your API products.

* Control which [geographic region](/konnect/geo) the universal API control plane is operated in. AU, EU, and US geos are currently supported. This allows you to operate {{site.konnect_short_name}} in a similar geographic region to your end-users, as well as ensure data privacy and regulatory compliance.


<div class="docs-grid-install">

Expand Down
Loading

0 comments on commit 6f87b78

Please sign in to comment.