feat(xo6): download cluster kubeconfig

Author: sylvere-a

@xen-orchestra/web-core/lib/locales/en.json

@@ -73,6 +73,7 @@
   "action:disconnect-n-vifs": "Disconnect 1 VIF | Disconnect {n} VIFs",
   "action:disconnect-pool": "Disconnect pool",
   "action:download-bugtools-archive": "Download bugtools archive",
+  "action:download-kubeconfig-admin-file": "Download kubeconfig admin file",
   "action:duplicate": "Duplicate",
   "action:duplicate-n-vms": "Duplicate 1 VM | Duplicate {n} VMs",
   "action:edit": "Edit",
@@ -280,6 +281,7 @@
   "cluster": "Cluster",
   "cluster-class": "Cluster class",
   "cluster-delete-warning": "Deleting this Kubernetes cluster is permanent and cannot be undone. All associated resources, workloads, and configurations may become unavailable. Make sure this cluster is no longer in use before confirming. | Deleting these Kubernetes clusters is permanent and cannot be undone. All associated resources, workloads, and configurations may become unavailable. Make sure these clusters are no longer in use before confirming.",
+  "cluster-missing": "Cluster is missing",
   "cluster-name": "Cluster name",
   "clusters": "Clusters",
   "color-mode:auto": "Automatic mode",
@@ -545,11 +547,13 @@
   "job:backup-repository-benchmark:missing-backup-repository": "Missing backup repository",
   "job:backup-repository-benchmark:repository-disabled": "Backup repository disabled",
   "job:cluster-delete:missing-cluster": "No clusters to delete",
+  "job:cluster-kubeconfig-download:missing-cluster": "@:cluster-missing",
   "job:connect:in-progress": "Connect in progress…",
   "job:create:in-progress": "Create in progress…",
   "job:delete:in-progress": "Delete in progress…",
   "job:disable:in-progress": "Disable in progress…",
   "job:disconnect:in-progress": "Disconnect in progress…",
+  "job:download:in-progress": "Download in progress…",
   "job:edit:in-progress": "Edit in progress…",
   "job:enable:in-progress": "Enable in progress…",
   "job:export:in-progress": "Export in progress…",

@xen-orchestra/web-core/lib/locales/fr.json

@@ -73,6 +73,7 @@
   "action:disconnect-n-vifs": "Déconnecter 1 VIF | Déconnecter {n} VIFs",
   "action:disconnect-pool": "Déconnecter le pool",
   "action:download-bugtools-archive": "Télécharger l’archive bugtools",
+  "action:download-kubeconfig-admin-file": "Télécharger le fichier kubeconfig admin",
   "action:duplicate": "Dupliquer",
   "action:duplicate-n-vms": "Dupliquer 1 VM | Dupliquer {n} VMs",
   "action:edit": "Modifier",
@@ -280,6 +281,7 @@
   "cluster": "Cluster",
   "cluster-class": "Cluster class",
   "cluster-delete-warning": "La suppression de ce cluster Kubernetes est définitive et ne peut pas être annulée. Toutes les ressources, charges de travail et configurations associées pourraient devenir indisponibles. Assurez-vous que le cluster n'est plus en cours d'utilisation avant de confirmer. | La suppression de ces clusters Kubernetes est définitive et ne peut pas être annulée. Toutes les ressources, charges de travail et configurations associées pourraient devenir indisponibles. Assurez-vous que les clusters ne sont plus en cours d'utilisation avant de confirmer.",
+  "cluster-missing": "Cluster manquant",
   "cluster-name": "Nom du cluster",
   "clusters": "Clusters",
   "color-mode:auto": "Mode automatique",
@@ -545,11 +547,13 @@
   "job:backup-repository-benchmark:missing-backup-repository": "Aucun dépôt de sauvegarde",
   "job:backup-repository-benchmark:repository-disabled": "Dépôt de sauvegarde désactivé",
   "job:cluster-delete:missing-cluster": "Aucun cluster à supprimer",
+  "job:cluster-kubeconfig-download:missing-cluster": "@:cluster-missing",
   "job:connect:in-progress": "Connexion en cours…",
   "job:create:in-progress": "Création en cours…",
   "job:delete:in-progress": "Suppression en cours…",
   "job:disable:in-progress": "Désactivation en cours…",
   "job:disconnect:in-progress": "Déconnexion en cours…",
+  "job:download:in-progress": "Téléchargement en cours…",
   "job:edit:in-progress": "Modification en cours…",
   "job:enable:in-progress": "Activation en cours…",
   "job:export:in-progress": "Export en cours…",

@xen-orchestra/web/src/modules/kubernetes/components/actions/ClusterActions.vue

@@ -1,9 +1,11 @@
 <template>
+  <ClusterKubeconfigDownloadButton :cluster />
   <ClusterDeleteButton :cluster />
 </template>
 
 <script lang="ts" setup>
 import ClusterDeleteButton from '@/modules/kubernetes/components/actions/delete-cluster/ClusterDeleteButton.vue'
+import ClusterKubeconfigDownloadButton from '@/modules/kubernetes/components/actions/download-kubeconfig/ClusterKubeconfigDownloadButton.vue'
 import type { XoKubernetesCluster } from '@/modules/kubernetes/types/xo-kubernetes.type.ts'
 
 defineProps<{

@xen-orchestra/web/src/modules/kubernetes/components/actions/download-kubeconfig/ClusterKubeconfigDownloadButton.vue

@@ -0,0 +1,28 @@
+<template>
+  <MenuItem
+    icon="action:download"
+    accent="neutral"
+    :disabled="!canDownloadKubeconfig"
+    :busy="isDownloadingKubeconfig"
+    @click="downloadKubeconfig()"
+  >
+    {{ t('action:download-kubeconfig-admin-file') }}
+  </MenuItem>
+</template>
+
+<script lang="ts" setup>
+import { useKubernetesClusterKubeconfigDownload } from '@/modules/kubernetes/composables/use-kubernetes-cluster-kubeconfig-download.composable.ts'
+import type { XoKubernetesCluster } from '@/modules/kubernetes/types/xo-kubernetes.type.ts'
+import MenuItem from '@core/components/menu/MenuItem.vue'
+import { useI18n } from 'vue-i18n'
+
+const { cluster } = defineProps<{
+  cluster: XoKubernetesCluster
+}>()
+
+const { t } = useI18n()
+
+const { downloadKubeconfig, canDownloadKubeconfig, isDownloadingKubeconfig } = useKubernetesClusterKubeconfigDownload(
+  () => cluster
+)
+</script>

@xen-orchestra/web/src/modules/kubernetes/composables/use-kubernetes-cluster-kubeconfig-download.composable.ts

@@ -0,0 +1,23 @@
+import { useXoKubernetesClusterKubeconfigDownloadJob } from '@/modules/kubernetes/jobs/xo-kubernetes-cluster-kubeconfig-download.job.ts'
+import type { XoKubernetesCluster } from '@/modules/kubernetes/types/xo-kubernetes.type.ts'
+import { isClusterPhaseReady } from '@/modules/kubernetes/utils/kubernetes-cluster.util.ts'
+import { toComputed } from '@core/utils/to-computed.util.ts'
+import { computed, type MaybeRefOrGetter } from 'vue'
+
+export function useKubernetesClusterKubeconfigDownload(rawCluster: MaybeRefOrGetter<XoKubernetesCluster>) {
+  const cluster = toComputed(rawCluster)
+
+  const { run, canRun, isRunning: isDownloadingKubeconfig } = useXoKubernetesClusterKubeconfigDownloadJob(cluster)
+
+  const canDownloadKubeconfig = computed(() => canRun.value && isClusterPhaseReady(cluster.value.phase))
+
+  async function downloadKubeconfig() {
+    try {
+      await run()
+    } catch (error) {
+      console.error('Error when downloading cluster kubeconfig:', error)
+    }
+  }
+
+  return { downloadKubeconfig, canDownloadKubeconfig, isDownloadingKubeconfig }
+}

@xen-orchestra/web/src/modules/kubernetes/jobs/xo-kubernetes-cluster-args.ts

@@ -0,0 +1,12 @@
+import type { XoKubernetesCluster } from '@/modules/kubernetes/types/xo-kubernetes.type.ts'
+import { defineJobArg } from '@core/packages/job'
+
+export const xoKubernetesClustersArg = defineJobArg({
+  identify: (cluster: XoKubernetesCluster) => cluster.id,
+  toArray: true,
+})
+
+export const xoKubernetesClusterArg = defineJobArg({
+  identify: (cluster: XoKubernetesCluster) => cluster.id,
+  toArray: false,
+})

@xen-orchestra/web/src/modules/kubernetes/jobs/xo-kubernetes-cluster-delete-args.ts

@@ -1,10 +1,10 @@
-import { clustersArg } from '@/modules/kubernetes/jobs/xo-kubernetes-cluster-delete-args.ts'
+import { xoKubernetesClustersArg } from '@/modules/kubernetes/jobs/xo-kubernetes-cluster-args.ts'
 import type { XoKubernetesCluster } from '@/modules/kubernetes/types/xo-kubernetes.type.ts'
 import { fetchDelete } from '@/shared/utils/fetch.util.ts'
 import { defineJob, JobError, JobRunningError } from '@core/packages/job'
 import { useI18n } from 'vue-i18n'
 
-export const useXoKubernetesClusterDeleteJob = defineJob('kubernetes-cluster.delete', [clustersArg], () => {
+export const useXoKubernetesClusterDeleteJob = defineJob('kubernetes-cluster.delete', [xoKubernetesClustersArg], () => {
   const { t } = useI18n()
 
   return {

@xen-orchestra/web/src/modules/kubernetes/jobs/xo-kubernetes-cluster-delete.job.ts

@@ -0,0 +1,35 @@
+import { xoKubernetesClusterArg } from '@/modules/kubernetes/jobs/xo-kubernetes-cluster-args.ts'
+import type { XoKubernetesCluster } from '@/modules/kubernetes/types/xo-kubernetes.type.ts'
+import { fetchRequest } from '@/shared/utils/fetch.util.ts'
+import { defineJob, JobError, JobRunningError } from '@core/packages/job'
+import { downloadFile } from '@core/utils/download-file.utils.ts'
+import { useI18n } from 'vue-i18n'
+
+export const useXoKubernetesClusterKubeconfigDownloadJob = defineJob(
+  'kubernetes-cluster.kubeconfig-download',
+  [xoKubernetesClusterArg],
+  () => {
+    const { t } = useI18n()
+
+    return {
+      async run(cluster: XoKubernetesCluster) {
+        const { kubeconfig } = await fetchRequest<{ kubeconfig: string }>(`kubernetes/clusters/${cluster.id}/config`)
+
+        const url = URL.createObjectURL(new Blob([kubeconfig], { type: 'application/yaml' }))
+
+        downloadFile(url, `${cluster.name}-kubeconfig.yaml`, false)
+        URL.revokeObjectURL(url)
+      },
+
+      validate(isRunning, cluster: XoKubernetesCluster | undefined) {
+        if (!cluster) {
+          throw new JobError(t('job:cluster-kubeconfig-download:missing-cluster'))
+        }
+
+        if (isRunning) {
+          throw new JobRunningError(t('job:download:in-progress'))
+        }
+      },
+    }
+  }
+)

@xen-orchestra/web/src/modules/kubernetes/jobs/xo-kubernetes-cluster-kubeconfig-download.job.ts

@@ -14,6 +14,7 @@
 - [XO6/Kubernetes] Add Kubernetes in the treeview, Kubernetes page with clusters table and side-panel (PR [#10459](https://github.com/vatesfr/xen-orchestra/pull/10459))
 - [XO6/Kubernetes] Kubernetes clusters can now be created from the UI (PR [#10524](https://github.com/vatesfr/xen-orchestra/pull/10524))
 - [XO6/Kubernetes] Kubernetes clusters can now be deleted from the UI (PR [#10526](https://github.com/vatesfr/xen-orchestra/pull/10526))
+- [XO6/Kubernetes] Kubernetes clusters kubeconfig admin file can now be downloaded from the UI (PR [#10535](https://github.com/vatesfr/xen-orchestra/pull/10535))
 
 ### Bug fixes