feat(admin-api): add `cascade` querystring parameter to support force delete workspace #5506

vm-001 · 2023-04-27T08:39:31Z

Description

Introduces a new query parameter cascade for workspace delete API to support workspace cascade delete.

Testing instructions

Netlify link: https://deploy-preview-5506--kongdocs.netlify.app/

Checklist

Review label added
PR pointed to correct branch (main for immediate publishing, or a release branch: e.g. release/gateway-3.2, release/deck-1.17)

https://github.com/Kong/kong-ee/pull/5915

FTI-4731

netlify · 2023-04-27T08:39:39Z

✅ Deploy Preview for kongdocs ready!

Name	Link
🔨 Latest commit	`af1a33c`
🔍 Latest deploy log	https://app.netlify.com/sites/kongdocs/deploys/64ae257db3bebd0008151f81
😎 Deploy Preview	https://deploy-preview-5506--kongdocs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

github-actions · 2023-04-27T08:39:45Z

⚠️ Please add at least one of the following review labels to this PR:

review:copyedit: Request for writer review.
review:general: Review for general accuracy and presentation.
Does the doc work? Does it output correctly?
review:tech: Request for technical review for a docs platform change.
review:sme: Request for review from an SME (engineer, PM, etc.).

Note: Only Kong employees can add labels due to a GitHub limitation.
If you're an OSS contributor, thank you! The maintainers will label this PR for you.

lena-larionova · 2023-04-27T15:27:20Z

app/_src/gateway/admin-api/workspaces/reference.md

+
+Recursively delete a workspace. Normally, deleting a workspace requires its entities to be deleted first. This option allows you to recursively delete a workspace without manually deleting its entities first.
+
+```
+DELETE /workspaces/{name or id}?recursive=true
+```
+


Suggested change

Recursively delete a workspace. Normally, deleting a workspace requires its entities to be deleted first. This option allows you to recursively delete a workspace without manually deleting its entities first.

```

DELETE /workspaces/{name or id}?recursive=true

```

### Recursively delete a workspace

Normally, deleting a workspace requires its entities to be deleted first. This option allows you to recursively delete a workspace without manually deleting its entities first.

<div class="endpoint delete">/workspaces/{name or id}?recursive=true</div>

Not sure about phrasing yet. I think we need to have a stronger warning here to be absolutely sure they want to do this.

How about:

Recursively delete a workspace

Deleting a workspace requires first deleting its entities. This option allows you to delete a workspace without manually deleting its entities first, as it handles the entity deletion before the workspace is deleted.

/workspaces/{name or id}?recursive=true

Slight rephrase:

Deleting a workspace requires deleting its entities first. This option lets you delete a workspace without manually deleting its entities first, as it handles the entity deletion before the workspace is deleted.

Otherwise, looks good.

lena-larionova · 2023-04-27T15:30:35Z

Q: Does deleting a workspace using this method leave all of the entities orphaned, or will they be deleted as well?

vm-001 · 2023-04-28T02:34:46Z

Q: Does deleting a workspace using this method leave all of the entities orphaned, or will they be deleted as well?

workspace's core entities will be deleted when the workspace was deleted by using the above method.

hbagdi · 2023-05-02T17:05:29Z

@lena-larionova This has been moved to 3.4, could you please add a github milestone for 3.4 and move this there?

lena-larionova · 2023-05-04T21:56:14Z

Temporarily closing. Will reopen when we have a 3.4 branch to push to. Marked with 3.4 milestone so we'll see it in the queue.

vm-001 · 2023-07-04T07:34:51Z

Here are the candidates for the user-facing parameter names. Vote an accurate one, or feel free to add a new one.

👍 vote to cascade
👀 vote to recursive
❤️ vote to force
🚀 recursive_delete

app/_src/gateway/admin-api/workspaces/reference.md

lena-larionova · 2023-07-11T20:39:27Z

@vm-001 harry mentioned that this will change the behavior in Kong Manager. That means that this doc also needs updating: https://deploy-preview-5506--kongdocs.netlify.app/gateway/latest/kong-manager/workspaces/#edit-a-workspace

Source: https://github.com/Kong/docs.konghq.com/blob/feat/force-delete-workspace/app/_src/gateway/kong-manager/workspaces.md

vm-001 · 2023-07-12T03:09:29Z

@hbagdi @lena-larionova
Can we consider this is the document change for the admin API aspect? We have another ticket to require GUI support at KM https://konghq.atlassian.net/browse/KAG-1992 the KM GUI doc can be done at this separated ticket.

Co-authored-by: lena-larionova <[email protected]>

lena-larionova

LGTM, merging despite failing test. A previous commit broke it, I'll fix separately.

* version bump for gateway 3.4 * Bump kong-plugins submodule (#5682) * feat(logging): add workspace name in the logging payload (#5251) (#5585) * feat(logging): add workspace name in the logging payload (#5251) Co-authored-by: lena.larionova <[email protected]> * update the ee-version --------- Co-authored-by: lena.larionova <[email protected]> * feat(opentelemetry): add AWS header propagation (#5732) * feat(opentelemetry): add AWS header propagation * Add a changelog entry for AWS header propagation --------- Co-authored-by: lena-larionova <[email protected]> * docs(secrets-management): update docs with vault rotation and some small adjustments ### Summary In Kong 3.4 we added support for secrets rotation using TTLs. This commit adds a section to Kong docs about it. There are some small adjustments to secrets management docs as well. Signed-off-by: Aapo Talvensaari <[email protected]> * bump version for support tables to 3.4 * feat(admin-api): add `cascade` querystring parameter to support force delete workspace (#5506) * add recursive querystring parameter * rename to cascade * Update app/_src/gateway/admin-api/workspaces/reference.md Co-authored-by: lena-larionova <[email protected]> --------- Co-authored-by: lena-larionova <[email protected]> * fix: remove unnecessary tab tags in secrets rotation * fix version number typo * Add changelog entry for 3.4.x changes in the ip-restriction plugin (#5736) * Add changelog entry for 3.4.x changes in the ip-restriction plugin * minor formatting edit --------- Co-authored-by: lena-larionova <[email protected]> * feat(opentelemetry): support the parameter as referenceable (#5809) * [DOCU-3224] Remove cassandra from 3.4 (#5803) * remove cassandra * Update app/_src/gateway/kong-enterprise/analytics/reports.md Co-authored-by: Diana <[email protected]> --------- Co-authored-by: Diana <[email protected]> * chore(*): add more explanation when using EKS IRSA to access RDS database (#5831) * chore(*): add more explanation when using EKS IRSA to access RDS database * Update app/_src/gateway/kong-enterprise/aws-iam-auth-to-rds-database.md Co-authored-by: lena-larionova <[email protected]> --------- Co-authored-by: lena-larionova <[email protected]> * Add new distros, drop End-Of-Life distributions, and rename amazonlinux-2022 to 2023 (#5770) * Drop End-Of-Life distributions, and rename amazonlinux-2022 to 2023 * Update distro support for 3.4 * Add rhel9 fips support in 3.4 * Add rhel9 arm64 support * fix issue of 3.2, 3.3, and 3.4 not displaying * re-add ubuntu 18.04 to versions prior to 3.4 with EOL date --------- Co-authored-by: Andy Zhang <[email protected]> Co-authored-by: lena-larionova <[email protected]> Co-authored-by: lena.larionova <[email protected]> * chore: 3.3 > 3.4 nav changes (#5863) update 3.4 nav to match 3.3 * docs(consumer-groups): add api-specs for first-class consumer-group changes (#5873) * rename, repoint to 3.4 * fix issue with parameters --------- Co-authored-by: Angel <[email protected]> * chore: Update configuration reference for gateway 3.4 (#5881) * update autodoc-conf-ee script with latest badges * generate config ref for 3.4; update autogen script for config ref * [Autodocs] PDK and API documentation (#5882) * PDK docs * vale * fix if_version * API specs * kong.vault fix * Migrate from Cassandra to PostgreSQL (#5885) * first commit * add more info * Apply suggestions from code review Co-authored-by: lena-larionova <[email protected]> * more feedback * navbar changes, rename * image move * Update app/_src/gateway/migrate-cassandra-to-postgres.md Co-authored-by: lena-larionova <[email protected]> --------- Co-authored-by: lena-larionova <[email protected]> * AdminAPI - Add cascade query param to workspace endpoints, fix issue with validate plugin endpoint. (#5894) * add few missing things to the AdminAPIs * change contact info * fix boolean in quotes * remove quotes * add link to docs * feat: Remove Alpine instructions from Docker install instructions for 3.4 (#5886) * Remove Alpine instructions from Docker install doc Signed-off-by: Diana <[email protected]> * Conditionally render Alpine tiles on install page Signed-off-by: Diana <[email protected]> * Fix Vale warning Signed-off-by: Diana <[email protected]> --------- Signed-off-by: Diana <[email protected]> * docs(secrets-management): update docs with vault rotation and some small adjustments (#5779) * docs(secrets-management): update docs with vault rotation and some small adjustments In Kong 3.4 we added support for secrets rotation using TTLs. This commit adds a section to Kong docs about it. There are some small adjustments to secrets management docs as well. Signed-off-by: Aapo Talvensaari <[email protected]> * Apply suggestions from code review Co-authored-by: Hans Hübner <[email protected]> * Update app/_src/gateway/kong-enterprise/secrets-management/secrets-rotation.md Co-authored-by: Joshua Schmid <[email protected]> * Update app/_src/gateway/kong-enterprise/secrets-management/backends/aws-sm.md * Update app/_src/gateway/kong-enterprise/secrets-management/advanced-usage.md * Update app/_src/gateway/kong-enterprise/secrets-management/backends/gcp-sm.md * Update app/_src/gateway/kong-enterprise/secrets-management/backends/hashicorp-vault.md * docs(secrets-mgmt): act on feedback * docs(secrets): add defaults * Fix accidental submodule update Signed-off-by: Diana <[email protected]> * Apply suggestions from code review * Fix Vale errors Signed-off-by: Diana <[email protected]> * Fix last few Vale errors and fix table formatting Signed-off-by: Diana <[email protected]> --------- Signed-off-by: Aapo Talvensaari <[email protected]> Signed-off-by: Diana <[email protected]> Co-authored-by: Hans Hübner <[email protected]> Co-authored-by: Enrique García Cota <[email protected]> Co-authored-by: Joshua Schmid <[email protected]> Co-authored-by: Diana <[email protected]> * Feat: Kong Manager OSS documentation (#5864) * Add placeholder page Signed-off-by: Diana <[email protected]> * Add KM OSS screenshot, fill out KM OSS overview page, edit ports page Signed-off-by: Diana <[email protected]> * Add note about KM OSS to get started, add KM OSS to list of things OSS users can use on the main page Signed-off-by: Diana <[email protected]> * Fix broken KM link * Fix broken links in old versions, appease Vale Signed-off-by: Diana <[email protected]> * Add conditional rendering to KM ports Signed-off-by: Diana <[email protected]> * Make small fixes, apply code review feedback Signed-off-by: Diana <[email protected]> * Manually conditionally render badges for KM OSS params Signed-off-by: Diana <[email protected]> * Change Kong Manager Free to Kong Manager Enterprise Signed-off-by: Diana <[email protected]> * Add KM OSS icon, fix if_version in config file Signed-off-by: Diana <[email protected]> * Fix path to image, add links to concept pages Signed-off-by: Diana <[email protected]> * Fix icon color Co-authored-by: lena-larionova <[email protected]> * Fix sidebar test Signed-off-by: Diana <[email protected]> --------- Signed-off-by: Diana <[email protected]> Co-authored-by: lena-larionova <[email protected]> * [DOCU-3167] Update references to Amazon Linux 2023 (#5841) * Change AWS 2022 to AWS 2023 Signed-off-by: Diana <[email protected]> * Fix cloudsmith links, change our Signed-off-by: Diana <[email protected]> * Apply suggestions from code review Co-authored-by: Isa Farnik <[email protected]> * Fix AWS 2023 yum install steps, edit the Amazon install options Signed-off-by: Diana <[email protected]> --------- Signed-off-by: Diana <[email protected]> Co-authored-by: Isa Farnik <[email protected]> * Update expression router documentation for kong 3.4 (#5889) docs(expression): update expression for kong 3.4 * deprecated `overrides` endpoint note, cascade endpoint added to workspace delete. (#5907) * deprecated endpoint note, cascade endpoint added to markdown. * Add feedback from Lena * [Docu-3170] Support for scoping plugins by consumer group. (#5874) * Consumer groups main adds * fix: add missing "to" to KongPlugin guide * Add `no_consumer_group` to third-party plugins schemas * bump plugins submodule * Add support for `Enable on consumer group` tab * More plugins * vale * broken link * vale * fix broken link * Feedback * update plugins submodule to update config * redirects for consumer groups API documentation * add deprecation * last bit of feedback * add details about mixed version kGW setups * Apply suggestions from code review Co-authored-by: lena-larionova <[email protected]> * vale * Apply suggestions from code review Co-authored-by: Diana <[email protected]> Co-authored-by: lena-larionova <[email protected]> * feedback * fix last precedence thing --------- Co-authored-by: Travis Raines <[email protected]> Co-authored-by: Fabian Rodriguez <[email protected]> Co-authored-by: lena-larionova <[email protected]> Co-authored-by: Diana <[email protected]> * chore: Copy over nav changes from 3.3 to 3.4 (#5908) copy over nav changes from 3.3 to 3.4 * Chore: Fix vale, Update Github action (#5895) * test vale * fix it I think * edit .vale.ini * try again * test new action * test * test again * test * test * test * remove vale test items * chore: Add 3.4 version to Gateway upgrade doc (#5911) Add 3.4 version to upgrade doc Signed-off-by: Diana <[email protected]> * Add documentation for Gateway 3.4 Wasm support (#5840) * wasm docs WIP * wasm docs review changes * addressing reviewdog comments * cursed typo * review comments addressed and some config changes * refine configuration instructions * quotes around config * use `export` instead of changing user's conf * copy edit * Update app/_src/gateway/plugin-development/wasm.md Co-authored-by: Vinicius Mignot <[email protected]> * Update app/_src/gateway/plugin-development/wasm.md Co-authored-by: Hisham Muhammad <[email protected]> * Change "WasmX" to "Kong using WebAssembly" Co-authored-by: Hisham Muhammad <[email protected]> * Update app/_src/gateway/plugin-development/wasm.md Co-authored-by: Hisham Muhammad <[email protected]> * Avoid first-person plural * typo * fix vale to not flag Wasm * more vale fixes * Update app/_src/gateway/reference/wasm.md Co-authored-by: Hisham Muhammad <[email protected]> * Update app/_src/gateway/reference/wasm.md Co-authored-by: Hisham Muhammad <[email protected]> * Update app/_src/gateway/reference/wasm.md Co-authored-by: Hisham Muhammad <[email protected]> * keep list ordered * review suggestion * Update app/_src/gateway/plugin-development/wasm.md * title-case Kong DB entities * reword [proxy-]wasm language support explanation * typo: increase => increased * add note about lack of testing for other SDKs * reword proxy-wasm limitations and link to ngx_wasm_module * explain: route filters are executed after service filters * reword declarative/kong.yml instruction * dictionary: add new terms * make proxy-wasm link consistent between pages * explain: lua plugin interaction * fix typos * Update app/_src/gateway/reference/wasm.md Co-authored-by: Thibault Charbonnier <[email protected]> * wrapping * reword Lua plugin vs wasm filter ordering warning * copy edit --------- Co-authored-by: Vinicius Mignot <[email protected]> Co-authored-by: Angel <[email protected]> Co-authored-by: Angel <[email protected]> Co-authored-by: Hisham Muhammad <[email protected]> Co-authored-by: Thibault Charbonnier <[email protected]> * chore: Update plugins submodule for 3.4 (#5912) update plugins submodule for 3.4 * chore: Changelog for Kong Gateway 3.4.0.0 (#5905) * 3.4 changelog draft * all the formatting and clean up and links * descriptions and links for a bunch of new features * fix typos and disable vale * Apply suggestions from code review Co-authored-by: Angel <[email protected]> * fix a typo --------- Co-authored-by: Angel <[email protected]> * chore: Breaking changes in Kong Gateway 3.4 (#5914) * remove vitals changelog entry, change was reverted * breaking changes for 3.4 * appease vale * add zipkin to queue param affected plugins list * fix typo * chore: Add gpg/rsa gateway-34 repo keys (#5919) * chore: add compatibility issues for v3.4 (#5918) * chore: add compatibility issues for v3.4 Adds version compatibility issues for gateway v3.4. Removes D155 due to a reversal of support for datadog-tracing between v3.2 and v3.2.2. Adds a few other non v3.4 changeIDs. * typos and docs link --------- Signed-off-by: Aapo Talvensaari <[email protected]> Signed-off-by: Diana <[email protected]> Co-authored-by: Michael Heap <[email protected]> Co-authored-by: Xiaoyan Rao <[email protected]> Co-authored-by: Antoine Labarussias <[email protected]> Co-authored-by: Aapo Talvensaari <[email protected]> Co-authored-by: Yusheng Li <[email protected]> Co-authored-by: Hans Hübner <[email protected]> Co-authored-by: Yufu Zhao <[email protected]> Co-authored-by: Diana <[email protected]> Co-authored-by: Qirui(Keery) Nie <[email protected]> Co-authored-by: Wangchong Zhou <[email protected]> Co-authored-by: Andy Zhang <[email protected]> Co-authored-by: Joshua Schmid <[email protected]> Co-authored-by: Angel <[email protected]> Co-authored-by: Angel <[email protected]> Co-authored-by: Enrique García Cota <[email protected]> Co-authored-by: Isa Farnik <[email protected]> Co-authored-by: Chrono <[email protected]> Co-authored-by: Travis Raines <[email protected]> Co-authored-by: Fabian Rodriguez <[email protected]> Co-authored-by: Michael Martin <[email protected]> Co-authored-by: Vinicius Mignot <[email protected]> Co-authored-by: Hisham Muhammad <[email protected]> Co-authored-by: Thibault Charbonnier <[email protected]> Co-authored-by: Amy Goldsmith <[email protected]> Co-authored-by: Alex Gaesser <[email protected]>

vm-001 requested a review from a team as a code owner April 27, 2023 08:39

vm-001 added the review:general Review for general accuracy and presentation. Does the doc work? Does it output correctly? label Apr 27, 2023

lena-larionova requested changes Apr 27, 2023

View reviewed changes

lena-larionova added this to the Gateway 3.3 milestone Apr 27, 2023

lena-larionova self-assigned this Apr 27, 2023

lena-larionova modified the milestones: Gateway 3.3, Gateway 3.4 May 4, 2023

lena-larionova closed this May 4, 2023

vm-001 reopened this Jul 4, 2023

add recursive querystring parameter

d671261

vm-001 force-pushed the feat/force-delete-workspace branch from c0d34df to d671261 Compare July 4, 2023 07:13

vm-001 changed the base branch from release/gateway-3.3 to release/gateway-3.4 July 4, 2023 07:13

rename to cascade

0a4b948

hanshuebner changed the title ~~feat(admin-api): add recursive querystring parameter to support force delete workspace~~ feat(admin-api): add cascade querystring parameter to support force delete workspace Jul 4, 2023

lena-larionova reviewed Jul 11, 2023

View reviewed changes

app/_src/gateway/admin-api/workspaces/reference.md Outdated Show resolved Hide resolved

Update app/_src/gateway/admin-api/workspaces/reference.md

af1a33c

Co-authored-by: lena-larionova <[email protected]>

lena-larionova approved these changes Jul 12, 2023

View reviewed changes

lena-larionova merged commit 64d03ce into release/gateway-3.4 Jul 12, 2023

lena-larionova deleted the feat/force-delete-workspace branch July 12, 2023 16:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(admin-api): add `cascade` querystring parameter to support force delete workspace #5506

feat(admin-api): add `cascade` querystring parameter to support force delete workspace #5506

vm-001 commented Apr 27, 2023 •

edited by hanshuebner

Loading

netlify bot commented Apr 27, 2023 •

edited

Loading

github-actions bot commented Apr 27, 2023

lena-larionova Apr 27, 2023 •

edited

Loading

vm-001 Apr 28, 2023

lena-larionova May 2, 2023

lena-larionova commented Apr 27, 2023

vm-001 commented Apr 28, 2023

hbagdi commented May 2, 2023

lena-larionova commented May 4, 2023

vm-001 commented Jul 4, 2023 •

edited

Loading

lena-larionova commented Jul 11, 2023

vm-001 commented Jul 12, 2023

lena-larionova left a comment

feat(admin-api): add cascade querystring parameter to support force delete workspace #5506

feat(admin-api): add cascade querystring parameter to support force delete workspace #5506

Conversation

vm-001 commented Apr 27, 2023 • edited by hanshuebner Loading

Description

Testing instructions

Checklist

netlify bot commented Apr 27, 2023 • edited Loading

✅ Deploy Preview for kongdocs ready!

github-actions bot commented Apr 27, 2023

lena-larionova Apr 27, 2023 • edited Loading

Choose a reason for hiding this comment

vm-001 Apr 28, 2023

Choose a reason for hiding this comment

Recursively delete a workspace

lena-larionova May 2, 2023

Choose a reason for hiding this comment

lena-larionova commented Apr 27, 2023

vm-001 commented Apr 28, 2023

hbagdi commented May 2, 2023

lena-larionova commented May 4, 2023

vm-001 commented Jul 4, 2023 • edited Loading

lena-larionova commented Jul 11, 2023

vm-001 commented Jul 12, 2023

lena-larionova left a comment

Choose a reason for hiding this comment

feat(admin-api): add `cascade` querystring parameter to support force delete workspace #5506

feat(admin-api): add `cascade` querystring parameter to support force delete workspace #5506

vm-001 commented Apr 27, 2023 •

edited by hanshuebner

Loading

netlify bot commented Apr 27, 2023 •

edited

Loading

lena-larionova Apr 27, 2023 •

edited

Loading

vm-001 commented Jul 4, 2023 •

edited

Loading