Stream last events at the bottom of Kubernetes resource details
What does this MR do and why?
This MR adds watch API for the Kubernetes events. It also fixes an issue when an event has no lastTimestamp. The event should always have either lastTimestamp or eventTime, we use eventTime as a fallback.
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.
How to set up and validate locally
Validate locally without full setup (using patch)
- Visit Project -> Operate -> Environments
- Create/Edit an environment using the UI
- Apply patch
Click to expand
diff --git a/app/assets/javascripts/environments/environment_details/index.vue b/app/assets/javascripts/environments/environment_details/index.vue
index cea9be0f6eef..a61d6abe20fa 100644
--- a/app/assets/javascripts/environments/environment_details/index.vue
+++ b/app/assets/javascripts/environments/environment_details/index.vue
@@ -48,7 +48,33 @@ 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',
+ project: { fullPath: 'foo/bar' },
+ 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/kubernetes/index.js b/app/assets/javascripts/environments/graphql/resolvers/kubernetes/index.js
index 6c38eb22f265..30f09c67d2ef 100644
--- a/app/assets/javascripts/environments/graphql/resolvers/kubernetes/index.js
+++ b/app/assets/javascripts/environments/graphql/resolvers/kubernetes/index.js
@@ -46,6 +46,34 @@ const watchDeployments = ({ configuration, namespace, client }) => {
};
const watchEvents = ({ client, configuration, namespace, involvedObjectName, config }) => {
+ const update = [
+ {
+ lastTimestamp: null,
+ eventTime: new Date().toISOString(),
+ message: 'Yay! Found the image',
+ reason: 'Update',
+ source: { component: 'kubelet', host: 'k3d-k3s-default-server-0' },
+ type: 'Normal',
+ },
+ {
+ lastTimestamp: new Date(Date.now() - 1000 * 60 * 4).toISOString(),
+ eventTime: '',
+ message: 'Back-off pulling image "doesnotexist:latest"',
+ reason: 'BackOff',
+ source: { component: 'kubelet', host: 'k3d-k3s-default-server-0' },
+ type: 'Normal',
+ },
+ ];
+
+ setTimeout(() => {
+ client.writeQuery({
+ query: k8sEventsQuery,
+ variables: { configuration, namespace, involvedObjectName },
+ data: { k8sEvents: update },
+ });
+ }, 3000);
+
+ return;
const fieldSelector = `involvedObject.name=${involvedObjectName}`;
const watchPath = buildWatchPath({ resource: 'events', namespace });
const watcherApi = new WatchApi(config);
@@ -129,6 +157,7 @@ export const kubernetesQueries = {
return getK8sPods({ client, query, configuration, namespace });
},
k8sServices(_, { configuration, namespace }, { client }) {
+ return [];
const coreV1Api = new CoreV1Api(new Configuration(configuration));
const servicesApi = namespace
? coreV1Api.listCoreV1NamespacedService({ namespace })
@@ -194,6 +223,19 @@ export const kubernetesQueries = {
const fieldSelector = `involvedObject.name=${involvedObjectName}`;
const config = new Configuration(configuration);
+ watchEvents({ client, configuration, namespace, involvedObjectName, config });
+
+ return [
+ {
+ lastTimestamp: new Date(Date.now() - 1000 * 60 * 4).toISOString(),
+ eventTime: '',
+ message: 'Back-off pulling image "doesnotexist:latest"',
+ reason: 'BackOff',
+ source: { component: 'kubelet', host: 'k3d-k3s-default-server-0' },
+ type: 'Normal',
+ },
+ ];
+
const coreV1Api = new CoreV1Api(config);
const eventsApi = coreV1Api.listCoreV1NamespacedEvent({ namespace, fieldSelector });
return eventsApi
diff --git a/app/assets/javascripts/kubernetes_dashboard/graphql/helpers/resolver_helpers.js b/app/assets/javascripts/kubernetes_dashboard/graphql/helpers/resolver_helpers.js
index e827ca18044a..4be93fe2db97 100644
--- a/app/assets/javascripts/kubernetes_dashboard/graphql/helpers/resolver_helpers.js
+++ b/app/assets/javascripts/kubernetes_dashboard/graphql/helpers/resolver_helpers.js
@@ -125,6 +125,205 @@ export const getK8sPods = ({
mapFn = mapWorkloadItem,
queryField = 'k8sPods',
}) => {
+ return [
+ {
+ status: {
+ phase: 'Succeeded',
+ },
+ spec: {
+ containers: [
+ {
+ name: 'helm',
+ },
+ ],
+ },
+ metadata: {
+ annotations: {
+ 'helmcharts.helm.cattle.io/configHash':
+ 'SHA256=E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855',
+ },
+ creationTimestamp: '2023-07-31T11:50:17.000Z',
+ labels: {
+ 'controller-uid': '6c03c7fc-663b-4054-8842-37196eeb708b',
+ 'helmcharts.helm.cattle.io/chart': 'traefik-crd',
+ 'job-name': 'helm-install-traefik-crd',
+ },
+ name: 'helm-install-traefik-crd-gsj56',
+ namespace: 'kube-system',
+ resourceVersion: '576',
+ uid: 'd58f5220-9b8f-403a-9051-530559891bd7',
+ },
+ __typename: 'LocalWorkloadItem',
+ },
+ {
+ status: {
+ phase: 'Succeeded',
+ },
+ spec: {
+ containers: [
+ {
+ name: 'helm',
+ },
+ ],
+ },
+ metadata: {
+ annotations: {
+ 'helmcharts.helm.cattle.io/configHash':
+ 'SHA256=1EF9AFCD934FEF498C2BA9787FC96FA76D94643B6A79486BF80DA848478FBAF0',
+ },
+ creationTimestamp: '2023-07-31T11:50:17.000Z',
+ labels: {
+ 'controller-uid': 'fa3d99b5-7137-4a36-b98e-bf8d9f7d1171',
+ 'helmcharts.helm.cattle.io/chart': 'traefik',
+ 'job-name': 'helm-install-traefik',
+ },
+ name: 'helm-install-traefik-csrck',
+ namespace: 'kube-system',
+ resourceVersion: '580',
+ uid: '4a25607b-91d6-4f5f-8e43-72f1f7445c4b',
+ },
+ __typename: 'LocalWorkloadItem',
+ },
+ {
+ status: {
+ phase: 'Succeeded',
+ },
+ spec: {
+ containers: [
+ {
+ name: 'local-path-provisioner',
+ },
+ ],
+ },
+ metadata: {
+ annotations: {},
+ creationTimestamp: '2023-07-31T11:50:17.000Z',
+ labels: {
+ app: 'local-path-provisioner',
+ 'pod-template-hash': '79f67d76f8',
+ },
+ name: 'local-path-provisioner-79f67d76f8-sl8jw',
+ namespace: 'kube-system',
+ resourceVersion: '23266248',
+ uid: '6c2c9ffb-f472-42f0-815c-11a266f8f2af',
+ },
+ __typename: 'LocalWorkloadItem',
+ },
+ {
+ status: {
+ phase: 'Running',
+ },
+ spec: {
+ containers: [
+ {
+ name: 'coredns',
+ },
+ ],
+ },
+ metadata: {
+ annotations: {},
+ creationTimestamp: '2023-07-31T11:50:17.000Z',
+ labels: {
+ 'k8s-app': 'kube-dns',
+ 'pod-template-hash': '597584b69b',
+ },
+ name: 'coredns-597584b69b-r6wbx',
+ namespace: 'kube-system',
+ resourceVersion: '23266286',
+ uid: '9143156d-44a0-4d22-a958-669d3d3ae96d',
+ },
+ __typename: 'LocalWorkloadItem',
+ },
+ {
+ status: {
+ phase: 'Running',
+ },
+ spec: {
+ containers: [
+ {
+ name: 'lb-tcp-80',
+ },
+ {
+ name: 'lb-tcp-443',
+ },
+ ],
+ },
+ metadata: {
+ annotations: {},
+ creationTimestamp: '2023-07-31T11:50:17.000Z',
+ labels: {
+ app: 'svclb-traefik-79ffb0a8',
+ 'controller-revision-hash': '767bb4755d',
+ 'pod-template-generation': '1',
+ 'svccontroller.k3s.cattle.io/svcname': 'traefik',
+ 'svccontroller.k3s.cattle.io/svcnamespace': 'kube-system',
+ },
+ name: 'svclb-traefik-79ffb0a8-cw5v5',
+ namespace: 'kube-system',
+ resourceVersion: '23266323',
+ uid: '23630529-6f71-40b5-9074-9fc0850ea813',
+ },
+ __typename: 'LocalWorkloadItem',
+ },
+ {
+ status: {
+ phase: 'Running',
+ },
+ spec: {
+ containers: [
+ {
+ name: 'traefik',
+ },
+ ],
+ },
+ metadata: {
+ annotations: {
+ 'prometheus.io/path': '/metrics',
+ 'prometheus.io/port': '9100',
+ 'prometheus.io/scrape': 'true',
+ },
+ creationTimestamp: '2023-07-31T11:50:17.000Z',
+ labels: {
+ 'app.kubernetes.io/instance': 'traefik-kube-system',
+ 'app.kubernetes.io/managed-by': 'Helm',
+ 'app.kubernetes.io/name': 'traefik',
+ 'helm.sh/chart': 'traefik-20.3.1_up20.3.0',
+ 'pod-template-hash': '66c46d954f',
+ },
+ name: 'traefik-66c46d954f-mdwwn',
+ namespace: 'kube-system',
+ resourceVersion: '23266369',
+ uid: '2a04dd82-809d-42a0-8439-e655bcf53056',
+ },
+ __typename: 'LocalWorkloadItem',
+ },
+ {
+ status: {
+ phase: 'Running',
+ },
+ spec: {
+ containers: [
+ {
+ name: 'metrics-server',
+ },
+ ],
+ },
+ metadata: {
+ annotations: {},
+ creationTimestamp: '2023-07-31T11:50:17.000Z',
+ labels: {
+ 'k8s-app': 'metrics-server',
+ 'pod-template-hash': '5f9f776df5',
+ },
+ name: 'metrics-server-5f9f776df5-4ts4p',
+ namespace: 'kube-system',
+ resourceVersion: '23266399',
+ uid: '847d09e2-d9c0-4a54-9e97-e3d5d273e5d6',
+ },
+ __typename: 'LocalWorkloadItem',
+ },
+ ];
+
const config = new Configuration(configuration);
const coreV1Api = new CoreV1Api(config);
- Visit the Environments page and select the environment.
- Click on any pod in the table to view the details drawer.
- Verify the events section at the bottom of the drawer.
Validate locally with full setup and real data
Prerequisites:
- NGINX, loopback interface, and HTTPS set up on your GDK
- Docker instance
- KAS enabled on GDK (steps 1-2 from the guide).
-
Visit the Project -> Infrastructure -> Kubernetes clusters page and create an agent following the instructions 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.
-
Add the following configuration inside your project in
.gitlab/agents/<your-agent-name>/config.yamlfor the user_access agent:user_access: access_as: agent: {} projects: - id: <your-group>/<your-project-to-share-agent-with> -
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.
-
Visit Project -> Operate -> Environments
-
Create/Edit an environment using the UI
-
Select an agent from the dropdown in the Environments settings page and save the change.
-
Visit the Environments page and visit the environment details page for the environment that has an associated agent.
-
Click on any pod in the table to view the details drawer.
-
Verify the events section at the bottom of the drawer.
Related to #470042 (closed)
Edited by Anna Vovchenko