-
Notifications
You must be signed in to change notification settings - Fork 576
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: add M1 Serverless CGW #7360
base: main
Are you sure you want to change the base?
Conversation
Signed-off-by: John Harris <john@johnharris.io>
✅ Deploy Preview for kongdocs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Signed-off-by: John Harris <john@johnharris.io>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just some copy edits.
## Limitations | ||
|
||
Serverless Cloud Gateways is a lightweight managed Gateway offering, and as such has several limitations: | ||
* A user can only have 1 Serverless CP per Organization |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* A user can only have 1 Serverless CP per Organization | |
* A user can only have one Serverless Control Plane (CP) per organization. |
Serverless Cloud Gateways is a lightweight managed Gateway offering, and as such has several limitations: | ||
* A user can only have 1 Serverless CP per Organization | ||
* A Serverless CP can only have a single data plane node attached to it | ||
* If a serverless DP is deleted, it is not possible to re-provision one through the UI (but can be done via the API) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* If a serverless DP is deleted, it is not possible to re-provision one through the UI (but can be done via the API) | |
* If a Serverless data plane (DP) is deleted, it cannot be re-provisioned through the UI, but this can be done via the API. |
* A user can only have 1 Serverless CP per Organization | ||
* A Serverless CP can only have a single data plane node attached to it | ||
* If a serverless DP is deleted, it is not possible to re-provision one through the UI (but can be done via the API) | ||
* Serverless data plane nodes automatically shutdown after a short period of time. Sending new traffic will re-awaken them but first request latency may be a little higher while this process occurs. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* Serverless data plane nodes automatically shutdown after a short period of time. Sending new traffic will re-awaken them but first request latency may be a little higher while this process occurs. | |
* Serverless data plane nodes automatically shutdown after a short period of inactivity. Sending new traffic will reawaken them, but the first request latency may be slightly higher during this process. |
## Provisioning a Serverless Cloud Gateway | ||
|
||
1. Login to your {{site.konnect_short_name}} account. | ||
2. Create a new organization and prefix the name of the organization with `[Serverless] `. E.g. `[Serverless] My Test Org`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
2. Create a new organization and prefix the name of the organization with `[Serverless] `. E.g. `[Serverless] My Test Org`. | |
2. Create a new organization and prefix the name of the organization with `[Serverless] `. For example, `[Serverless] My Test Org`. |
2. Create a new organization and prefix the name of the organization with `[Serverless] `. E.g. `[Serverless] My Test Org`. | ||
3. Select a region. | ||
|
||
After completing these steps you will be dropped into the Serverless Gateway CP Overview, and your serverless data plane node will be automatically created. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
After completing these steps you will be dropped into the Serverless Gateway CP Overview, and your serverless data plane node will be automatically created. | |
After completing these steps, you will be directed to the **Serverless Gateway Control Plane Overview**, and a serverless data plane node will be automatically created. |
|
||
After completing these steps you will be dropped into the Serverless Gateway CP Overview, and your serverless data plane node will be automatically created. | ||
|
||
When the notification appears to confirm your gateway has been provisioned, you should be able to find the external Serverless Gateway URL in the overview box: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When the notification appears to confirm your gateway has been provisioned, you should be able to find the external Serverless Gateway URL in the overview box: | |
When the notification appears confirming your gateway has been provisioned, you will find the external Serverless Gateway URL in the overview box: |
<img src="/assets/images/products/konnect/gateway-manager/serverless-gateways-overview.png" alt="serverless gateways overview" style="max-width: 800px;"> | ||
> _**Figure 1:** The Serverless Gateway CP overview in the {{site.konnect_short_name}} UI. Once provisioned, the gateway proxy URL will show in this overview section._ | ||
|
||
The Serverless Gateway is now ready to use, and you can create services, routes, plugins, view analytics and more as you would with Hybrid Gateways or Dedicated Cloud Gateways in {{site.konnect_short_name}}. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The Serverless Gateway is now ready to use, and you can create services, routes, plugins, view analytics and more as you would with Hybrid Gateways or Dedicated Cloud Gateways in {{site.konnect_short_name}}. | |
The Serverless Gateway is now ready to use. You can create services, routes, and plugins, view analytics, and more, just as you would with Hybrid Gateways or Dedicated Cloud Gateways in {{site.konnect_short_name}}. |
Description
[DO-NOT-MERGE]
Early docs for Milestone 1 of Serverless Cloud Gateways
https://konghq.atlassian.net/browse/DOCU-3834
Testing instructions
Preview link: https://deploy-preview-7360--kongdocs.netlify.app/konnect/gateway-manager/serverless-cloud-gateways/
Checklist