From 3e0096f3a5a146baad5d1a67dbb19c41c96b7adc Mon Sep 17 00:00:00 2001 From: Mathieu Champlon Date: Wed, 23 Sep 2026 15:30:52 +0200 Subject: [PATCH] cli: add reference pages for kubernetes status and reset-cluster (#26144) ## Description `docker desktop kubernetes status` and `docker desktop kubernetes reset-cluster` are implemented in desktop-cli but had no reference page: `data/cli/desktop` was missing their YAML, which is what the reference pages are generated from. Adds both files and lists them in the parent command's `cname`/`clink` (also fixes `clink` pointing at a nonexistent `docker_desktop_engine_images.yaml`). ## Related issues or tickets https://docker.atlassian.net/browse/DDB-567 ## Reviews - [ ] Technical review - [ ] Editorial review --- .../desktop/docker_desktop_kubernetes.yaml | 6 ++++- ...cker_desktop_kubernetes_reset-cluster.yaml | 11 ++++++++++ .../docker_desktop_kubernetes_status.yaml | 22 +++++++++++++++++++ 3 files changed, 38 insertions(+), 1 deletion(-) create mode 100644 data/cli/desktop/docker_desktop_kubernetes_reset-cluster.yaml create mode 100644 data/cli/desktop/docker_desktop_kubernetes_status.yaml diff --git a/data/cli/desktop/docker_desktop_kubernetes.yaml b/data/cli/desktop/docker_desktop_kubernetes.yaml index 4beff946db..94ff477b55 100644 --- a/data/cli/desktop/docker_desktop_kubernetes.yaml +++ b/data/cli/desktop/docker_desktop_kubernetes.yaml @@ -5,8 +5,12 @@ pname: docker desktop plink: docker_desktop.yaml cname: - docker desktop kubernetes images + - docker desktop kubernetes reset-cluster + - docker desktop kubernetes status clink: - - docker_desktop_engine_images.yaml + - docker_desktop_kubernetes_images.yaml + - docker_desktop_kubernetes_reset-cluster.yaml + - docker_desktop_kubernetes_status.yaml deprecated: false hidden: false experimental: false diff --git a/data/cli/desktop/docker_desktop_kubernetes_reset-cluster.yaml b/data/cli/desktop/docker_desktop_kubernetes_reset-cluster.yaml new file mode 100644 index 0000000000..0290c00dd5 --- /dev/null +++ b/data/cli/desktop/docker_desktop_kubernetes_reset-cluster.yaml @@ -0,0 +1,11 @@ +command: docker desktop kubernetes reset-cluster +short: Reset the Kubernetes cluster managed by Docker Desktop +usage: docker desktop kubernetes reset-cluster +pname: docker desktop kubernetes +plink: docker_desktop_kubernetes.yaml +deprecated: false +hidden: false +experimental: false +experimentalcli: false +kubernetes: false +swarm: false diff --git a/data/cli/desktop/docker_desktop_kubernetes_status.yaml b/data/cli/desktop/docker_desktop_kubernetes_status.yaml new file mode 100644 index 0000000000..765b526b75 --- /dev/null +++ b/data/cli/desktop/docker_desktop_kubernetes_status.yaml @@ -0,0 +1,22 @@ +command: docker desktop kubernetes status +short: Get the status of the Kubernetes cluster managed by Docker Desktop +usage: docker desktop kubernetes status +pname: docker desktop kubernetes +plink: docker_desktop_kubernetes.yaml +options: + - option: format + value_type: string + default_value: pretty + description: 'Format the output. Accepted values are: pretty, json' + deprecated: false + hidden: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false +deprecated: false +hidden: false +experimental: false +experimentalcli: false +kubernetes: false +swarm: false