Add missing service account error to k8s agent troubleshooting documentation
What does this MR do?
Enabling the operational container scanning (former: Cluster image scanning) in the agent for Kubernetes documentation fails initially because the agent cannot detect the service account name. This problem is tracked in #361972 (closed)
This breaks the onboarding workflow as you need to learn how to inspect the agent logs and make sense of the presented error.
kubectl logs -f -l=app=gitlab-agent -n gitlab-agent
{"level":"error","time":"2022-06-17T15:15:02.665Z","msg":"Failed to perform vulnerability scan on workload","mod_name":"starboard_vulnerability","error":"getting service account by name: gitlab-agent/gitlab-agent: serviceaccounts \"gitlab-agent\" not found"}
This MR adds a troubleshooting section with the error from the agent logs to the documentation, explains the problem, links the issue, and documents possible workarounds until the agent supports service account detection.
Related issues
Cluster image scanning does not work with non-d... (#361972 - closed)
Author's checklist
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
If you're adding or changing the main heading of the page (H1), ensure that the product tier badge is added. -
If you are a GitLab team member, request a review based on: - The documentation page's metadata.
- The associated Technical Writer.
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 likeDefault behavior when you close an issue
. -
The headings (other than the page title) should be active. Instead of Configuring GDK
, say something likeConfigure 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.