Skip to content

🚸 ux(kube): use id_or_name as primary field / missing flags in cluster kubeconfig#249

Merged
jfbus merged 2 commits into
mainfrom
kubeconfig_flags
Jul 10, 2026
Merged

🚸 ux(kube): use id_or_name as primary field / missing flags in cluster kubeconfig#249
jfbus merged 2 commits into
mainfrom
kubeconfig_flags

Conversation

@jfbus

@jfbus jfbus commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

Description

This PR configures the kube usage to specify that names can be used as well as ids.

It also adds missing flags in cluster kubeconfig.

Type of Change

Please check the relevant option(s):

  • 🐛 Bug fix
  • ✨ New feature
  • 🧹 Code cleanup or refactor
  • 📝 Documentation update
  • 🔧 Build or CI-related change
  • 🔒 Security fix
  • Other (specify): ux

How Has This Been Tested?

Please describe the test strategy:

  • Manual testing
  • Unit tests
  • Integration tests
  • Not tested yet

Checklist

  • I have followed the Contributing Guidelines
  • I have added tests or explained why they are not needed
  • I have updated relevant documentation (README, examples, etc.)
  • My changes follow the Conventional Commits specification
  • My commits include appropriate Gitmoji

Additional Context

@jfbus jfbus added the kind/other Other change label Jul 10, 2026
@github-actions

github-actions Bot commented Jul 10, 2026

Copy link
Copy Markdown

WARNING : Differences in reference doc 🤔

 docs/reference/octl_kube_cluster.md            |  8 ++++----
 docs/reference/octl_kube_cluster_delete.md     |  6 +++---
 docs/reference/octl_kube_cluster_describe.md   |  6 +++---
 docs/reference/octl_kube_cluster_kubeconfig.md | 11 +++++++----
 docs/reference/octl_kube_cluster_update.md     |  6 +++---
 docs/reference/octl_kube_project.md            | 14 +++++++-------
 docs/reference/octl_kube_project_clusters.md   |  2 +-
 docs/reference/octl_kube_project_delete.md     |  6 +++---
 docs/reference/octl_kube_project_describe.md   |  6 +++---
 docs/reference/octl_kube_project_nets.md       |  6 +++---
 docs/reference/octl_kube_project_public-ips.md |  6 +++---
 docs/reference/octl_kube_project_quotas.md     |  6 +++---
 docs/reference/octl_kube_project_snapshots.md  |  6 +++---
 docs/reference/octl_kube_project_update.md     |  6 +++---
 docs/reference/octl_kube_publicip.md           |  2 +-
 docs/reference/octl_kube_publicip_describe.md  |  6 +++---
 16 files changed, 53 insertions(+), 50 deletions(-)
Detailed changes

docs/reference/octl_kube_cluster.md

-* [octl kube cluster delete](octl_kube_cluster_delete.md)	 - alias for api DeleteCluster  id
-* [octl kube cluster describe](octl_kube_cluster_describe.md)	 - alias for api GetCluster  id
-* [octl kube cluster kubeconfig](octl_kube_cluster_kubeconfig.md)	 - alias for api GetKubeconfig cluster_name_or_id
+* [octl kube cluster delete](octl_kube_cluster_delete.md)	 - alias for api DeleteCluster  id_or_name
+* [octl kube cluster describe](octl_kube_cluster_describe.md)	 - alias for api GetCluster  id_or_name
+* [octl kube cluster kubeconfig](octl_kube_cluster_kubeconfig.md)	 - alias for api GetKubeconfig id_or_name
-* [octl kube cluster update](octl_kube_cluster_update.md)	 - alias for api UpdateCluster  id
+* [octl kube cluster update](octl_kube_cluster_update.md)	 - alias for api UpdateCluster  id_or_name

docs/reference/octl_kube_cluster_delete.md

-alias for api DeleteCluster  id
+alias for api DeleteCluster  id_or_name
-> *alias for api DeleteCluster  id*
+> *alias for api DeleteCluster  id_or_name*
-octl kube cluster delete id [id]... [flags]
+octl kube cluster delete id_or_name [id_or_name]... [flags]

docs/reference/octl_kube_cluster_describe.md

-alias for api GetCluster  id
+alias for api GetCluster  id_or_name
-> *alias for api GetCluster  id*
+> *alias for api GetCluster  id_or_name*
-octl kube cluster describe id [id]... [flags]
+octl kube cluster describe id_or_name [id_or_name]... [flags]

docs/reference/octl_kube_cluster_kubeconfig.md

-alias for api GetKubeconfig cluster_name_or_id
+alias for api GetKubeconfig id_or_name
-> *alias for api GetKubeconfig cluster_name_or_id*
+> *alias for api GetKubeconfig id_or_name*
-octl kube cluster kubeconfig cluster_name_or_id [flags]
+octl kube cluster kubeconfig id_or_name [flags]
+      --group string   
+      --ttl string     
+      --user string    

docs/reference/octl_kube_cluster_update.md

-alias for api UpdateCluster  id
+alias for api UpdateCluster  id_or_name
-> *alias for api UpdateCluster  id*
+> *alias for api UpdateCluster  id_or_name*
-octl kube cluster update id [id]... [flags]
+octl kube cluster update id_or_name [id_or_name]... [flags]

docs/reference/octl_kube_project.md

-* [octl kube project delete](octl_kube_project_delete.md)	 - alias for api DeleteProject  id
-* [octl kube project describe](octl_kube_project_describe.md)	 - alias for api GetProject  id
+* [octl kube project delete](octl_kube_project_delete.md)	 - alias for api DeleteProject  id_or_name
+* [octl kube project describe](octl_kube_project_describe.md)	 - alias for api GetProject  id_or_name
-* [octl kube project nets](octl_kube_project_nets.md)	 - alias for api GetProjectNets id
-* [octl kube project public-ips](octl_kube_project_public-ips.md)	 - alias for api GetProjectPublicIps id
-* [octl kube project quotas](octl_kube_project_quotas.md)	 - alias for api GetProjectQuotas id
-* [octl kube project snapshots](octl_kube_project_snapshots.md)	 - alias for api GetProjectSnapshots id
-* [octl kube project update](octl_kube_project_update.md)	 - alias for api UpdateProject  id
+* [octl kube project nets](octl_kube_project_nets.md)	 - alias for api GetProjectNets id_or_name
+* [octl kube project public-ips](octl_kube_project_public-ips.md)	 - alias for api GetProjectPublicIps id_or_name
+* [octl kube project quotas](octl_kube_project_quotas.md)	 - alias for api GetProjectQuotas id_or_name
+* [octl kube project snapshots](octl_kube_project_snapshots.md)	 - alias for api GetProjectSnapshots id_or_name
+* [octl kube project update](octl_kube_project_update.md)	 - alias for api UpdateProject  id_or_name

docs/reference/octl_kube_project_clusters.md

-octl kube project clusters project_id [flags]
+octl kube project clusters id_or_name [flags]

docs/reference/octl_kube_project_delete.md

-alias for api DeleteProject  id
+alias for api DeleteProject  id_or_name
-> *alias for api DeleteProject  id*
+> *alias for api DeleteProject  id_or_name*
-octl kube project delete id [id]... [flags]
+octl kube project delete id_or_name [id_or_name]... [flags]

docs/reference/octl_kube_project_describe.md

-alias for api GetProject  id
+alias for api GetProject  id_or_name
-> *alias for api GetProject  id*
+> *alias for api GetProject  id_or_name*
-octl kube project describe id [id]... [flags]
+octl kube project describe id_or_name [id_or_name]... [flags]

docs/reference/octl_kube_project_nets.md

-alias for api GetProjectNets id
+alias for api GetProjectNets id_or_name
-> *alias for api GetProjectNets id*
+> *alias for api GetProjectNets id_or_name*
-octl kube project nets id [flags]
+octl kube project nets id_or_name [flags]

docs/reference/octl_kube_project_public-ips.md

-alias for api GetProjectPublicIps id
+alias for api GetProjectPublicIps id_or_name
-> *alias for api GetProjectPublicIps id*
+> *alias for api GetProjectPublicIps id_or_name*
-octl kube project public-ips id [flags]
+octl kube project public-ips id_or_name [flags]

docs/reference/octl_kube_project_quotas.md

-alias for api GetProjectQuotas id
+alias for api GetProjectQuotas id_or_name
-> *alias for api GetProjectQuotas id*
+> *alias for api GetProjectQuotas id_or_name*
-octl kube project quotas id [flags]
+octl kube project quotas id_or_name [flags]

docs/reference/octl_kube_project_snapshots.md

-alias for api GetProjectSnapshots id
+alias for api GetProjectSnapshots id_or_name
-> *alias for api GetProjectSnapshots id*
+> *alias for api GetProjectSnapshots id_or_name*
-octl kube project snapshots id [flags]
+octl kube project snapshots id_or_name [flags]

docs/reference/octl_kube_project_update.md

-alias for api UpdateProject  id
+alias for api UpdateProject  id_or_name
-> *alias for api UpdateProject  id*
+> *alias for api UpdateProject  id_or_name*
-octl kube project update id [id]... [flags]
+octl kube project update id_or_name [id_or_name]... [flags]

docs/reference/octl_kube_publicip.md

-* [octl kube publicip describe](octl_kube_publicip_describe.md)	 - alias for api GetProjectPublicIps  public_ip_id
+* [octl kube publicip describe](octl_kube_publicip_describe.md)	 - alias for api GetProjectPublicIps  id_or_name

docs/reference/octl_kube_publicip_describe.md

-alias for api GetProjectPublicIps  public_ip_id
+alias for api GetProjectPublicIps  id_or_name
-> *alias for api GetProjectPublicIps  public_ip_id*
+> *alias for api GetProjectPublicIps  id_or_name*
-octl kube publicip describe public_ip_id [public_ip_id]... [flags]
+octl kube publicip describe id_or_name [id_or_name]... [flags]

@jfbus jfbus marked this pull request as ready for review July 10, 2026 13:40
@jfbus jfbus requested a review from a team July 10, 2026 13:40
@jfbus jfbus requested a review from a team as a code owner July 10, 2026 13:40
@github-actions

github-actions Bot commented Jul 10, 2026

Copy link
Copy Markdown

Binary size: 82.2MB => 82.2MB (change +0KB, +0.0%) 😉

Comment thread docs/reference/octl_kube_cluster_kubeconfig.md Outdated
@jfbus jfbus force-pushed the kubeconfig_flags branch from a198f5a to 297bb58 Compare July 10, 2026 14:28
@jfbus jfbus changed the title 🚸 ux(kube): use name_or_id as primary field / missing flags in cluster kubeconfig 🚸 ux(kube): use id_or_name as primary field / missing flags in cluster kubeconfig Jul 10, 2026
@jfbus jfbus requested a review from ryohkhn July 10, 2026 14:32
@jfbus jfbus merged commit 806800c into main Jul 10, 2026
10 of 11 checks passed
@jfbus jfbus deleted the kubeconfig_flags branch July 10, 2026 14:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

kind/other Other change

Development

Successfully merging this pull request may close these issues.

2 participants