Skip to content

Draft: Explain the role of agentk in the flux setup tutorial

What does this MR do?

This MR suggests to enhance the documentation for the flux setup tutorial - https://docs.gitlab.com/ee/user/clusters/agent/gitops/flux_tutorial.html.

I personally found it confusing to understand why flux needs support of agentk. It appeared overly complex and is lacking explanation imho. Agentk and gitops pull is deprecated and it is clear to some that operational container scanning and the integration with the CI pipeline are still a task for agentk. Now when the flux setup tutorial is mentioning to also install agentk, the question I was asked is why. If someone considers to use rather ArgoCD you would not think of combining it with agentk either. Which leads down to explaining the reason.

I learned the following from @nagyv-gitlab

The tutorial installs agentk for two reasons:

  • to make a more feature-full experience including the cluster UI
  • to show how one can install a Helm chart with Flux

My suggestion would be to make it explicit that agentk is not used for gitops pull in any way and is being installed for those two reasons above and what else might be relevant. It'd be further helpful to link to the full description of tasks of agentk from there as well and also to the deprecated use case.

So, it is becoming perfectly clear that you can have flux without agentk but have certain disadvantages and missing UI capabilities?

Cheers, Mirko

Related issues

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 you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.

  • 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