Skip to content

Implement Watch API for Kubernetes API calls

Anna Vovchenko requested to merge 422945-implement-watch-api-for-kubernetes-api-calls-2 into master

What does this MR do and why?

This MR implements the watch for the pods on the Environments page. The change is currently behind the k8s_watch_api feature flag.

Screenshots or screen recordings

Screen_Recording_2023-10-05_at_12.51.48

2023-10-05_at_12.51.48

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. 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 (Optional) 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. Add/delete/restart pods in your cluster and verify the related data changes in real-time.

MR acceptance checklist

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

Review progress:

Related to #422945 (closed)

Edited by Anna Vovchenko

Merge request reports