Skip to content

Trigger a Flux reconciliation from the cluster UI

What does this MR do and why?

This MR adds a feature to trigger Flux resource reconciliation from the Kubernetes overview on the environment page. We add the action to the Actions section of the details drawer (which appears once the user clicked on the Flux resource status).

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.

Success Errror
Screen_Recording_2024-08-07_at_13.41.23 Screen_Recording_2024-08-07_at_13.42.00

How to set up and validate locally

Numbered steps to set up and validate the change are strongly suggested.

Validate locally without full set up (using patch)

  1. Visit Project -> Operate -> Environments
  2. Create/Edit an environment using the UI
  3. Apply patch
Click to expand
diff --git a/app/assets/javascripts/environments/environment_details/components/kubernetes/kubernetes_overview.vue b/app/assets/javascripts/environments/environment_details/components/kubernetes/kubernetes_overview.vue
index c6f087a7f74a..c24423b66bc5 100644
--- a/app/assets/javascripts/environments/environment_details/components/kubernetes/kubernetes_overview.vue
+++ b/app/assets/javascripts/environments/environment_details/components/kubernetes/kubernetes_overview.vue
@@ -98,11 +98,11 @@ export default {
           fluxResourcePath: this.fluxResourcePath,
         };
       },
-      skip() {
-        return Boolean(
-          !this.fluxResourcePath || this.fluxResourcePath?.includes(HELM_RELEASES_RESOURCE_TYPE),
-        );
-      },
+      // skip() {
+      //   return Boolean(
+      //     !this.fluxResourcePath || this.fluxResourcePath?.includes(HELM_RELEASES_RESOURCE_TYPE),
+      //   );
+      // },
       error(err) {
         this.fluxApiError = err.message;
       },
diff --git a/app/assets/javascripts/environments/environment_details/index.vue b/app/assets/javascripts/environments/environment_details/index.vue
index ec97a6334fbb..6d15f3275b28 100644
--- a/app/assets/javascripts/environments/environment_details/index.vue
+++ b/app/assets/javascripts/environments/environment_details/index.vue
@@ -47,7 +47,32 @@ export default {
         };
       },
       update(data) {
-        return data?.project?.environment;
+        const result = data?.project?.environment;
+        if (!result.clusterAgent) {
+          const clusterAgent = {
+            __typename: 'ClusterAgent',
+            id: 'gid://gitlab/Clusters::Agent/123',
+            name: 'my-agent',
+            webPath: '/gitlab-org/cluster-integration/-/cluster_agents/my-agent',
+            tokens: {
+              __typename: 'ClusterAgentTokenConnection',
+              nodes: [
+                {
+                  __typename: 'ClusterAgentToken',
+                  id: 'gid://gitlab/Clusters::AgentToken/123',
+                  lastUsedAt: '2023-05-30T11:47:56Z',
+                },
+              ],
+            },
+          };
+
+          return {
+            ...result,
+            clusterAgent,
+          };
+        }
+
+        return result;
       },
       result() {
         this.updateCurrentTab();
diff --git a/app/assets/javascripts/environments/graphql/resolvers/flux.js b/app/assets/javascripts/environments/graphql/resolvers/flux.js
index 2aa4e85f5b12..84ebad033c31 100644
--- a/app/assets/javascripts/environments/graphql/resolvers/flux.js
+++ b/app/assets/javascripts/environments/graphql/resolvers/flux.js
@@ -113,6 +113,44 @@ const getFluxResource = ({ query, variables, field, resourceType, client }) => {
   const withCredentials = true;
   const url = `${variables.configuration.basePath}/apis/${variables.fluxResourcePath}`;
 
+  updateConnectionStatus(client, {
+    configuration: variables.configuration,
+    namespace: 'flux-system',
+    resourceType,
+    status: connectionStatus.connected,
+  });
+  return mapFluxItems(
+    {
+      kind: 'Kustomization',
+      metadata: {
+        name: 'flux-system',
+        namespace: 'flux-system',
+        creationTimestamp: '2024-08-08T09:40:19Z',
+      },
+      status: {
+        conditions: [
+          {
+            lastTransitionTime: '2024-08-08T09:40:19Z',
+            message: 'Applied revision: main@sha1:bfe9681105478dae9f9ef99358e91514ee259652',
+            observedGeneration: 1,
+            reason: 'ReconciliationSucceeded',
+            status: 'True',
+            type: 'Ready',
+          },
+        ],
+        inventory: [
+          {
+            id: '_alerts.notification.toolkit.fluxcd.io_apiextensions.k8s.io_CustomResourceDefinition',
+          },
+          {
+            id: '_buckets.source.toolkit.fluxcd.io_apiextensions.k8s.io_CustomResourceDefinition',
+          },
+        ],
+      },
+    },
+    KUSTOMIZATIONS_RESOURCE_TYPE,
+  );
+
   return axios
     .get(url, { withCredentials, headers })
     .then((res) => {
@@ -195,6 +233,7 @@ export const fluxMutations = {
     const withCredentials = true;
     const url = `${configuration.basePath}/apis/${fluxResourcePath}`;
 
+    return buildKubernetesErrors();
     return axios
       .patch(url, data, { withCredentials, headers })
       .then(() => {
diff --git a/app/assets/javascripts/environments/graphql/resolvers/kubernetes/index.js b/app/assets/javascripts/environments/graphql/resolvers/kubernetes/index.js
index 974a1e3a8aa2..80dfc30aac71 100644
--- a/app/assets/javascripts/environments/graphql/resolvers/kubernetes/index.js
+++ b/app/assets/javascripts/environments/graphql/resolvers/kubernetes/index.js
@@ -101,9 +101,11 @@ export const kubernetesMutations = {
 export const kubernetesQueries = {
   k8sPods(_, { configuration, namespace }, { client }) {
     const query = k8sPodsQuery;
+    return [];
     return getK8sPods({ client, query, configuration, namespace });
   },
   k8sServices(_, { configuration, namespace }, { client }) {
+    return [];
     const coreV1Api = new CoreV1Api(new Configuration(configuration));
     const servicesApi = namespace
       ? coreV1Api.listCoreV1NamespacedService({ namespace })
  1. Visit the Environments page and select the environment.
  2. Click on the Flux sync status
  3. Click on the trigger reconciliation button and validate the action. Normally the sync status would change to reconciling and then reconciled, but you won't see it with the patch.

Validate locally with the full set up and real data

  1. Follow this guide to start with the Flux.

  2. Visit Project -> Operate -> Environments

  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:

    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. Click the Flux sync status

  11. Click on the trigger reconciliation button and validate the action.

Related to #434248 (closed)

Edited by Anna Vovchenko

Merge request reports

Loading