Skip to content

Implement Watch API for Flux sync status

What does this MR do and why?

This MR adds Kubernetes Watch API support for the Flux Kustomizations and HelmReleases resources. As the Watch API will wait until it gets any data, we are doing the first request without watching and only subscribing to watch stream if the needed data is returned. After subscribing to the stream, we are getting real-time updates from Kubernetes.

This MR is a part of the Watch API effort, that is developed behind the k8s_watch_api feature flag. We already have support for watching the Kubernetes pods and are planning to add watch for every resource type.

Screenshots or screen recordings

flux-watch

How to set up and validate locally

  1. Enable the k8_watch_api feature flag

          Feature.enable(:k8_watch_api, Project.find(<project id>))
  2. Follow this guide to start with the Flux.

  3. Visit the Environments page:

    • Project -> Operate -> Environments if the new navigation is enabled
    • Project -> Deployments -> Environments if the new navigation is not enabled
  4. Create/Edit an environment using the UI

  5. Enable KAS on your GDK (steps 1-2 from the guide).

  6. 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.
  7. Add the following configuration inside your project in .gitlab/agents/<your-agent-name>/config.yaml for the user_access agent:

    gitops:
      manifest_projects:
      - id: <your-group>/<your-project>
    user_access:
      access_as: 
        agent: {}
      projects:
      - id: <your-group>/<your-project-to-share-agent-with>
  8. Note that the shared agents should be connected to the cluster in order to appear in the list. 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.

  9. Select an agent from the dropdown in the Environments settings page and save the change.

  10. Visit the Environments page and select the environment that has an associated agent.

  11. Add/delete/restart pods in your cluster and verify the related data changes in real-time.

  12. You can run flux reconcile customization <kustomization_name> to enforce the reconciliation to run.

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Related to #422945 (closed)

Merge request reports