Skip to content

♻️ refacto(kube): refactoring of project/cluster name handling#283

Draft
jfbus wants to merge 1 commit into
mainfrom
prerun_defaults
Draft

♻️ refacto(kube): refactoring of project/cluster name handling#283
jfbus wants to merge 1 commit into
mainfrom
prerun_defaults

Conversation

@jfbus

@jfbus jfbus commented Jul 22, 2026

Copy link
Copy Markdown
Contributor

Description

This PR refactors the way project/cluster names are resolved within octl kube commands.

Before the PR, both were forwarded to the API command as-is and resolved by the API command.
After this PR:

  • API commands only work with project/cluster IDs
  • a prerun function is called in high level commands and computes IDs.

The PR also fixes some cases were the default project was not used (e.g. octl kube cluster create)

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):

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

@github-actions

Copy link
Copy Markdown

🔖 auto-tagging: Adding label "kind/refactoring"

@github-actions github-actions Bot added the kind/refactoring Refactoring or internal changes label Jul 22, 2026
@github-actions

github-actions Bot commented Jul 22, 2026

Copy link
Copy Markdown

WARNING : Differences in reference doc 🤔

 docs/reference/octl_iaas_consumptionaccount_aggregate_all.md     | 4 ++--
 docs/reference/octl_iaas_consumptionaccount_aggregate_compute.md | 4 ++--
 docs/reference/octl_iaas_consumptionaccount_aggregate_gpu.md     | 4 ++--
 docs/reference/octl_iaas_consumptionaccount_list.md              | 4 ++--
 docs/reference/octl_kube_api_CreateCluster.md                    | 1 -
 docs/reference/octl_kube_api_DeleteCluster.md                    | 3 +--
 docs/reference/octl_kube_api_GetCluster.md                       | 3 +--
 docs/reference/octl_kube_api_GetKubeconfig.md                    | 9 ++++-----
 docs/reference/octl_kube_api_UpdateCluster.md                    | 1 -
 docs/reference/octl_kube_api_UpgradeCluster.md                   | 3 +--
 docs/reference/octl_kube_cluster.md                              | 2 +-
 docs/reference/octl_kube_cluster_create.md                       | 2 +-
 docs/reference/octl_kube_cluster_delete.md                       | 2 +-
 docs/reference/octl_kube_cluster_describe.md                     | 2 +-
 docs/reference/octl_kube_cluster_kubeconfig.md                   | 2 +-
 docs/reference/octl_kube_cluster_list.md                         | 2 +-
 docs/reference/octl_kube_cluster_update.md                       | 2 +-
 docs/reference/octl_kube_nodepool.md                             | 3 +--
 docs/reference/octl_kube_nodepool_api.md                         | 3 +--
 docs/reference/octl_kube_nodepool_api_Create.md                  | 3 +--
 docs/reference/octl_kube_nodepool_api_Delete.md                  | 3 +--
 docs/reference/octl_kube_nodepool_api_Get.md                     | 3 +--
 docs/reference/octl_kube_nodepool_api_List.md                    | 3 +--
 docs/reference/octl_kube_nodepool_api_Update.md                  | 3 +--
 docs/reference/octl_kube_nodepool_create.md                      | 2 +-
 docs/reference/octl_kube_nodepool_delete.md                      | 2 +-
 docs/reference/octl_kube_nodepool_describe.md                    | 2 +-
 docs/reference/octl_kube_nodepool_list.md                        | 2 +-
 docs/reference/octl_kube_project_use.md                          | 2 +-
 29 files changed, 34 insertions(+), 47 deletions(-)
Detailed changes

docs/reference/octl_iaas_consumptionaccount_aggregate_all.md

-      --from-date osctime   The beginning of the time period, in ISO 8601 date format (for example, 2020-06-14).
+      --from-date osctime   The beginning of the time period, in ISO 8601 date format (for example, 2020-06-14). (default beginning-of-month)
-      --to-date osctime     The end of the time period, in ISO 8601 date format (for example, 2020-06-30).
+      --to-date osctime     The end of the time period, in ISO 8601 date format (for example, 2020-06-30). (default today)

docs/reference/octl_iaas_consumptionaccount_aggregate_compute.md

-      --from-date osctime   The beginning of the time period, in ISO 8601 date format (for example, 2020-06-14).
+      --from-date osctime   The beginning of the time period, in ISO 8601 date format (for example, 2020-06-14). (default beginning-of-month)
-      --to-date osctime     The end of the time period, in ISO 8601 date format (for example, 2020-06-30).
+      --to-date osctime     The end of the time period, in ISO 8601 date format (for example, 2020-06-30). (default today)

docs/reference/octl_iaas_consumptionaccount_aggregate_gpu.md

-      --from-date osctime   The beginning of the time period, in ISO 8601 date format (for example, 2020-06-14).
+      --from-date osctime   The beginning of the time period, in ISO 8601 date format (for example, 2020-06-14). (default beginning-of-month)
-      --to-date osctime     The end of the time period, in ISO 8601 date format (for example, 2020-06-30).
+      --to-date osctime     The end of the time period, in ISO 8601 date format (for example, 2020-06-30). (default today)

docs/reference/octl_iaas_consumptionaccount_list.md

-      --from-date osctime       The beginning of the time period, in ISO 8601 date format (for example, 2020-06-14).
+      --from-date osctime       The beginning of the time period, in ISO 8601 date format (for example, 2020-06-14). (default beginning-of-month)
-      --to-date osctime         The end of the time period, in ISO 8601 date format (for example, 2020-06-30).
+      --to-date osctime         The end of the time period, in ISO 8601 date format (for example, 2020-06-30). (default today)

docs/reference/octl_kube_api_CreateCluster.md

-      --project string                                               project name

docs/reference/octl_kube_api_DeleteCluster.md

-      --project string   project name

docs/reference/octl_kube_api_GetCluster.md

-      --project string   project name

docs/reference/octl_kube_api_GetKubeconfig.md

-      --project string   project name

docs/reference/octl_kube_api_UpdateCluster.md

-      --project string                                               project name

docs/reference/octl_kube_api_UpgradeCluster.md

-      --project string   project name

docs/reference/octl_kube_cluster.md

-      --project string   project name
+      --project string   Name or ID of project

docs/reference/octl_kube_cluster_create.md

-      --project string                      [REQUIRED] Unique identifier of the project this cluster belongs to
+      --project string                      Unique identifier of the project this cluster belongs to

docs/reference/octl_kube_cluster_delete.md

-      --project string             project name
+      --project string             Name or ID of project

docs/reference/octl_kube_cluster_describe.md

-      --project string             project name
+      --project string             Name or ID of project

docs/reference/octl_kube_cluster_kubeconfig.md

-      --project string             project name
+      --project string             Name or ID of project

docs/reference/octl_kube_cluster_list.md

-      --project string             project name
+      --project string             Name or ID of project

docs/reference/octl_kube_cluster_update.md

-      --project string             project name
+      --project string             Name or ID of project

docs/reference/octl_kube_nodepool.md

-      --project string   project name

docs/reference/octl_kube_nodepool_api.md

-      --cluster string   [REQUIRED] Name or ID of cluster
+      --cluster string   [REQUIRED] ID of cluster
-      --project string   Name or ID of project

docs/reference/octl_kube_nodepool_api_Create.md

-      --cluster string             [REQUIRED] Name or ID of cluster
+      --cluster string             [REQUIRED] ID of cluster
-      --project string             Name or ID of project

docs/reference/octl_kube_nodepool_api_Delete.md

-      --cluster string             [REQUIRED] Name or ID of cluster
+      --cluster string             [REQUIRED] ID of cluster
-      --project string             Name or ID of project

docs/reference/octl_kube_nodepool_api_Get.md

-      --cluster string             [REQUIRED] Name or ID of cluster
+      --cluster string             [REQUIRED] ID of cluster
-      --project string             Name or ID of project

docs/reference/octl_kube_nodepool_api_List.md

-      --cluster string             [REQUIRED] Name or ID of cluster
+      --cluster string             [REQUIRED] ID of cluster
-      --project string             Name or ID of project

docs/reference/octl_kube_nodepool_api_Update.md

-      --cluster string             [REQUIRED] Name or ID of cluster
+      --cluster string             [REQUIRED] ID of cluster
-      --project string             Name or ID of project

docs/reference/octl_kube_nodepool_create.md

+      --project string                     Name or ID of project
-      --project string             project name

docs/reference/octl_kube_nodepool_delete.md

+      --project string   Name or ID of project
-      --project string             project name

docs/reference/octl_kube_nodepool_describe.md

+      --project string   Name or ID of project
-      --project string             project name

docs/reference/octl_kube_nodepool_list.md

+      --project string   Name or ID of project
-      --project string             project name

docs/reference/octl_kube_project_use.md

-octl kube project use [project_id_or_name] [flags]
+octl kube project use [id_or_name] [flags]

@github-actions

Copy link
Copy Markdown

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

@jfbus jfbus changed the title ♻️ refacto(kube): refactoring of default cluster handling ♻️ refacto(kube): refactoring of project/cluster name handling Jul 22, 2026
@jfbus
jfbus force-pushed the prerun_defaults branch 2 times, most recently from 205e194 to 2c1cea5 Compare July 22, 2026 15:01
@jfbus
jfbus force-pushed the prerun_defaults branch from 2c1cea5 to 57a7592 Compare July 22, 2026 15:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

kind/refactoring Refactoring or internal changes

Development

Successfully merging this pull request may close these issues.

1 participant