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.

Sign up for GitHub

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

Jump to bottom

docs(workspace): Add warnings to kong migrations #8092

Merged
merged 3 commits into from
Oct 29, 2024
Merged

docs(workspace): Add warnings to kong migrations #8092

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
87352d4
docs(workspace): add various warning to kong migrations finish.
Oyami-Srk Oct 28, 2024
6310fcd
Update migration-finish-warning.md
Oyami-Srk Oct 28, 2024
6047c64
Apply suggestions
Oyami-Srk Oct 29, 2024
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
1 change: 1 addition & 0 deletions app/_includes/md/enterprise/migration-finish-warning.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
When adding new plugins to the existing installation (either manually or via the extension of `bundled` plugins), the `kong migrations finish` or `kong migrations up` must be run with `-f` flag to forcely upgrade the plugin schemas.

Check failure on line 1 in app/_includes/md/enterprise/migration-finish-warning.md

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[kong.Spelling] Did you really mean 'forcely'?

Raw Output:
{"message": "[kong.Spelling] Did you really mean 'forcely'?", "location": {"path": "app/_includes/md/enterprise/migration-finish-warning.md", "range": {"start": {"line": 1, "column": 198}}}, "severity": "ERROR"}
Oyami-Srk marked this conversation as resolved.
Show resolved Hide resolved
3 changes: 3 additions & 0 deletions app/_src/gateway/admin-api/workspaces/reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -300,6 +300,9 @@ Attributes | Description
`name or id`<br>**required** | The unique identifier **or** the name of the workspace to delete
`cascade` | The `cascade` option lets you delete a workspace and all of its entities in one request.

{:.important}
> **Caution**: If deleting with the `cascade` option fails with `foreign key violation`, you may need to upgrade schema with `kong migrations -f finish`.
Oyami-Srk marked this conversation as resolved.
Show resolved Hide resolved


**Response**

Expand Down
2 changes: 2 additions & 0 deletions app/_src/gateway/breaking-changes/34x.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,3 +88,5 @@ The `/consumer_groups/:id/overrides` endpoint has been deprecated. While this en
Some referenceable configuration fields, such as the `http_endpoint` field
of the `http-log` plugin and the `endpoint` field of the `opentelemetry` plugin,
do not accept reference values due to incorrect field validation.

{% include /md/enterprise/migration-finish-warning.md %}
Oyami-Srk marked this conversation as resolved.
Show resolved Hide resolved
5 changes: 4 additions & 1 deletion app/_src/gateway/migrate-ce-to-ke.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,11 @@ to be up to date on any pending migration:

```shell
kong migrations up [-c configuration_file]
kong migrations finish [-c configuration_file]
kong migrations -f finish [-c configuration_file]
```

{:.important}
> **Caution**: {% include /md/enterprise/migration-finish-warning.md %}
Oyami-Srk marked this conversation as resolved.
Show resolved Hide resolved

2. Confirm that all of the entities are now available on your
{{site.ee_product_name}} node.
2 changes: 2 additions & 0 deletions app/_src/gateway/reference/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -284,6 +284,8 @@ Options:

```

{:.important}
> **Caution**: {% include /md/enterprise/migration-finish-warning.md %}
Oyami-Srk marked this conversation as resolved.
Show resolved Hide resolved
---


Expand Down
3 changes: 3 additions & 0 deletions app/_src/gateway/upgrade/blue-green.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,3 +138,6 @@ Write updates to {{site.base_gateway}} can now be performed, though we suggest y
{:.note}
> **Note**: This upgrade strategy is not the same thing as the [Blue-green (Canary) Deployment](/gateway/{{page.release}}/production/canary/).
That process is meant for upgrading your upstream services and is not related to {{site.base_gateway}} upgrades.

{:.important}
> **Caution**: {% include /md/enterprise/migration-finish-warning.md %}
Oyami-Srk marked this conversation as resolved.
Show resolved Hide resolved
2 changes: 2 additions & 0 deletions app/_src/gateway/upgrade/in-place.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,3 +96,5 @@ Prioritize the database-level restoration method over the application-level meth
Write updates to {{site.base_gateway}} can now be performed, though we suggest you keep monitoring metrics for a while.


{:.important}
> **Caution**: {% include /md/enterprise/migration-finish-warning.md %}
Oyami-Srk marked this conversation as resolved.
Show resolved Hide resolved
2 changes: 2 additions & 0 deletions app/gateway/changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3511,6 +3511,8 @@ hang when attempting to expand an API.
of the `http-log` plugin and the `endpoint` field of the `opentelemetry` plugin,
do not accept reference values due to incorrect field validation.

* {% include /md/enterprise/migration-finish-warning.md %}
Oyami-Srk marked this conversation as resolved.
Show resolved Hide resolved

## 3.3.1.1
**Release Date** 2023/10/12

Expand Down
Loading