Docs feedback: "under the root" unclear in Workspace config
MR: Pending
Description
In user/workspace/configuration (from !128652 (merged)) we write
You can use any agent defined under the root group of your project …
Feedback has been received that it is not clear whether "under the root" implies
- the very top-level namespace exactly, or
- the immediate parent group of a project, or
- any sub-group level in between?
The documentation should be updated and replace "under the root" with "under the top-level namespace" for clarity. While this documentation will be updated in the future to reflect instructions that are more in line with the latest work on the group-agent authorization strategy, the update covered in this issue will address any ambiguities that users might face in the interim.
Acceptance Criteria
-
Update the documentation to explicitly refer to the top-level namespace wherever "root group" is referred
Technical Requirements
NA as this is a documentation update
Design Requirements
NA as this is a documentation update
Impact Assessment
NA as this is a documentation update
User Story
NA as this is a documentation update
Earlier Description
In user/workspace/configuration (from !128652 (merged)) we writeYou can use any agent defined under the root group of your project …
It is not clear whether "under the root" there means:
- the very top-level namespace exactly, or
- the immediate parent group of a project, or
- any sub-group level in between?
Also:
- our UI on the
/groups/…/-/clusters
page makes it clear thatConnect a cluster ([is] deprecated)
, and - further above, we define this feature as "isolated development environments for your GitLab projects",
Should we mention group-level clusters there at all anymore?
"View agents" for developers or "Manage agents" for maintainers encompass the action of using an agent for a project?
Lastly, doesContext
This customer is owner of the _sub_group where the agent is configured, but has only minimal access in the top-level namespace, and is seeing Neither --kubeconfig nor --master was specified
warnings in their k8s logs.
I'm wondering whether this indicates "root = top-level namespace", because:
-
noAgentsContent
code being associated with theadministrator must configure a cluster agent for the project's group
message and they see - its computed conditionals
- This would match the observations, IMHO, implying that our "under the root group" wording is too ambiguous.
Possible follow-up issue
Within the groups docs, we use only "parent group", but various synonyms in other docs sections. Are the latter deviating?
# doc/user/group@v16.5.1-ee
$ rg --no-filename --only-matching "(parent|root|top level) (group|namespace)" \
| sort | uniq -c | sort
1 Parent group
32 parent group
# doc/
$ rg --no-filename --only-matching "(parent|root|top level) (group|namespace)" \
| sort | uniq -c | sort
2 parent Group
4 Top level group
6 Root namespace
12 Root Group
14 Parent group
18 parent namespace
22 top level group
26 top level namespace
42 root group
88 root namespace
286 parent group