Provide a help text when setting up the cluster UI
Proposal
Provide a help text when user picks
- a namespace
- a Flux resource
when they configure the cluster UI.
See this video for an explanation:
UX Proposal:
Add the following help text to the fields:
- Kubernetes namespace: No selection shows all authorized resources in the cluster. Learn more.
- Select Flux resource: If a Flux resource is specified, its reconciliation status is reflected in GitLab.
Implementation Plan:
- Update
environment_namespace_selector.vue
to add a description text for the Kubernetes namespace field.- Use the
description
slot of theGlFormGroup
component to add text. - Store the text in
$options.i18n
object together with the other translations. - Use
helpPagePath
helper to create a link to the docs (helpPagePath('user/clusters/agent/index.md')
). - Use
GlSprintf
andGlLink
components to render the link inside the text. - Update the corresponding spec to test that the proper text and link were added.
- Use the
- Update
environment_flux_resource_selector.vue
to add a description text for the Flux recourse field.- Use the
description
prop of theGlFormGroup
component to add text. - Store the text in
$options.i18n
object together with the other translations. - Update the corresponding spec to test that the proper text was added.
- Use the
Tips for validating the change locally:
-
Ensure your GDK is running on
HTTPS
-
Enable KAS on your GDK (steps 1-2 from the guide).
-
Visit the Project -> Infrastructure -> Kubernetes clusters page and create an agent following the instruction from the modal.
- Select the "Connect a cluster" button
- The modal should pop up
- In the modal select "Select an agent or enter a name to create new"
- You probably won't have any configured agents to show up in the list, create a new one by typing the name of your choice
- The button should appear at the bottom of the list saying "Create agent:
<your-agent-name>
" - Select the button and click "Register" in the next view.
- Save the token to use it in the next point.
-
Please follow points 3-8 from the guide and then the (Optional) Deploy the GitLab Agent (agentk) with k3d section to create a local cluster and connect your agent with the cluster.
-
Add the following configuration for your agent, commit the following on the default branch:
.gitlab/agents/<your-agent-name>/config.yaml
:user_access: access_as: agent: {} projects: - id: <your-group>/<your-project>
-
Follow this guide to start with the Flux
-
Visit the Project -> Operate -> Environments
-
Create/Edit an environment using the UI, select the agent created in the previous steps and the namespace used for the Flux setup
-
Once the namespace is selected, verify the Flux resource selector is shown