Skip to content

Update Flux reconciliation status for bad config

What does this MR do and why?

Currently, we show an "Unknown" status when Flux is reconciling a badly configured deployment. The cluster UI should show "Reconciling" status instead.

MR acceptance checklist

Please evaluate this MR against the MR acceptance checklist. It helps you analyze changes to reduce risks in quality, performance, reliability, security, and maintainability.

Screenshots or screen recordings

Screenshots are required for UI changes, and strongly recommended for all other merge requests.

Before After
Screenshot 2024-01-09 at 22.32.20.png Screenshot 2024-01-09 at 22.31.44.png

How to set up and validate locally

  1. Follow this guide to start with the Flux.

  2. Visit the Environments page:

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

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

  5. 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.
  6. 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>
  7. 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 Deploy the GitLab Agent (agentk) with k3d section to create a local cluster and connect your agent with the cluster.

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

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

  10. Validate the Flux sync status

  11. Update your Flux deployment to point to a non-existing image

  12. Validate the Flux sync status

Related to #424525 (closed)

Edited by Anna Vovchenko

Merge request reports