Skip to content

Fix SecureGuard installation docs - #2237

Open
abuango wants to merge 1 commit into
mainfrom
secureguard-installation-devex
Open

Fix SecureGuard installation docs#2237
abuango wants to merge 1 commit into
mainfrom
secureguard-installation-devex

Conversation

@abuango

@abuango abuango commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

Fixes found while installing SecureGuard from these docs end to end.

installation/

  • Add a Prerequisites notice stating the registry is private and access is by invitation, with a route to credentials via sales. Removes the duplicate statement from the pull-secret bullet below it.
  • Add kubectl create namespace before the secret command — following the page top to bottom failed on its first command.
  • State the node minimum (3 × 2 vCPU / 4 GiB). The chart's post-install NOTES say it; no doc page did, which is too late to pick a cluster.
  • Move What the Chart Deploys above Deployment Modes, so you know what you are installing before you install it.
  • Add an RBAC binding step to Install Order; the chart ships no bindings, so a user who logs in without one gets 403 on everything.
  • Add helm test secureguard as the verification step. The chart ships the test and the NOTES advertise it; it appeared on no doc page.
  • Document --version pinning on the Managed install.
  • Add an Uninstalling section: the OpenBao PVCs, <release>-openbao-keys, <release>-dex-admin, and the five CRDs installed by a pre-install hook all outlive helm uninstall.
  • Note that the unseal-key backup writes the key shares to disk in plain text.

getting-started/

  • Add creating the pull secret as step 1, with the namespace; drops --create-namespace from the install, and renumbers the rest.
  • Add a credentials notice to Prerequisites.

troubleshooting/

  • Add Pods Stuck in ImagePullBackOff as the first General Issues entry. It is the most likely first failure and was undocumented.

@kubermatic-bot kubermatic-bot added dco-signoff: yes Denotes that all commits in the pull request have the valid DCO signoff message. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jul 29, 2026
@kubermatic-bot

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign scheeles for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Add pull-secret values wiring, namespace creation, node sizing, RBAC and
helm test steps, version pinning, and an uninstall section.

Signed-off-by: Abubakar Siddiq Ango <abubakar@kubermatic.com>
@abuango
abuango force-pushed the secureguard-installation-devex branch from 90b3c77 to 7cbdfdf Compare July 29, 2026 03:07
@abuango
abuango requested a review from scheeles July 29, 2026 03:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dco-signoff: yes Denotes that all commits in the pull request have the valid DCO signoff message. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants