Skip to content

Clarify cluster deletion behavior in APIs

Harsh Chourariarequested to merge
hchouraria-docs-cluster-delete-api-no-cleanup-behavior into master

What does this MR do?

All of the cluster deletion APIs only delete the linked cluster object in GitLab and do not invoke the cleanup functions that's available as an option through the UIs.

This change adds sentences to all 3 APIs that delete clusters to clarify their behavior w.r.t. underlying resources within the connected Kubernetes clusters.

Note: These are deprecated APIs in 15.0+ so perhaps this change should also be picked into 14.10 and 13.12 branches for past version documentation references after its removal during 15.0?

Related issues

Customer support ticket (internal link): https://gitlab.zendesk.com/agent/tickets/285086 Related Slack thread with investigation notes: https://gitlab.slack.com/archives/CCBJYEWAW/p1650899628586649?thread_ts=1650898697.834649&cid=CCBJYEWAW

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Reviewer's checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • Ensure a release milestone is set.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.

Merge request reports