Skip to content

🚸 ux(vm/lbu): migrate vmshealth/vmsstate to lbu/vm subcommands#120

Merged
jfbus merged 1 commit intomainfrom
lbu_aliases
Mar 13, 2026
Merged

🚸 ux(vm/lbu): migrate vmshealth/vmsstate to lbu/vm subcommands#120
jfbus merged 1 commit intomainfrom
lbu_aliases

Conversation

@jfbus
Copy link
Copy Markdown
Contributor

@jfbus jfbus commented Mar 12, 2026

Description

This PR:

  • replaces iaas vmshealth list with iaas loadbalancer backends
  • replaces iaas vmsstate list with iaas loadbalancer states

The PR also improves the github comment about doc changes and fixes the generate test that missed new files.

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

Add any additional context or screenshots if necessary.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 12, 2026

WARNING : Differences in reference doc 🤔

 docs/reference/octl_iaas.md                       |  2 --
 docs/reference/octl_iaas_loadbalancer.md          |  1 +
 docs/reference/octl_iaas_loadbalancer_backends.md | 42 +++++++++++++++++++++++
 docs/reference/octl_iaas_vm.md                    |  1 +
 docs/reference/octl_iaas_vm_states.md             | 42 +++++++++++++++++++++++
 5 files changed, 86 insertions(+), 2 deletions(-)
Detailed changes

docs/reference/octl_iaas.md

-* [octl iaas vmshealth](octl_iaas_vmshealth.md)	 - vmshealth commands
-* [octl iaas vmsstate](octl_iaas_vmsstate.md)	 - vmsstate commands

docs/reference/octl_iaas_loadbalancer.md

+* [octl iaas loadbalancer backends](octl_iaas_loadbalancer_backends.md)	 - alias for api ReadVmsHealth --LoadBalancerName load_balancer_name

docs/reference/octl_iaas_loadbalancer_backends.md

new file mode 100644
+## octl iaas loadbalancer backends
+
+alias for api ReadVmsHealth --LoadBalancerName load_balancer_name
+
+### Synopsis
+
+> *alias for api ReadVmsHealth --LoadBalancerName load_balancer_name*
+
+Lists the state of one or more backend virtual machines (VMs) registered with a specified load balancer.
+
+```
+octl iaas loadbalancer backends load_balancer_name [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for backends
+```
+
+### Options inherited from parent commands
+
+```
+  -c, --columns string    columns to display - [+]<title>:<jq query for content>||<title>:<jq query for content>
+      --config string     Path of profile file (by default, ~/.osc/config.json)
+      --filter strings    comma separated list of filters for results - name:value,name:value, alias for jq filter 'select(.name | test("value"))'
+      --jq string         jq filter
+      --no-upgrade        do not check for new versions
+  -O, --out-file string   redirect output to file
+  -o, --output string     output format (raw, json, yaml, table, csv, none, base64) (default "raw")
+      --payload string    JSON content for query body
+      --profile string    Profile to use in profile file (by default, "default")
+      --single            convert single entry lists to a single object
+      --template string   JSON template file for query body
+  -v, --verbose           Verbose output
+  -y, --yes               answer yes to all prompts
+```
+
+### SEE ALSO
+
+* [octl iaas loadbalancer](octl_iaas_loadbalancer.md)	 - loadbalancer commands
+

docs/reference/octl_iaas_vm.md

+* [octl iaas vm states](octl_iaas_vm_states.md)	 - alias for api ReadVmsState

docs/reference/octl_iaas_vm_states.md

new file mode 100644
+## octl iaas vm states
+
+alias for api ReadVmsState
+
+### Synopsis
+
+> *alias for api ReadVmsState*
+
+Lists the status of one or more virtual machines (VMs).
+
+```
+octl iaas vm states [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for states
+```
+
+### Options inherited from parent commands
+
+```
+  -c, --columns string    columns to display - [+]<title>:<jq query for content>||<title>:<jq query for content>
+      --config string     Path of profile file (by default, ~/.osc/config.json)
+      --filter strings    comma separated list of filters for results - name:value,name:value, alias for jq filter 'select(.name | test("value"))'
+      --jq string         jq filter
+      --no-upgrade        do not check for new versions
+  -O, --out-file string   redirect output to file
+  -o, --output string     output format (raw, json, yaml, table, csv, none, base64) (default "raw")
+      --payload string    JSON content for query body
+      --profile string    Profile to use in profile file (by default, "default")
+      --single            convert single entry lists to a single object
+      --template string   JSON template file for query body
+  -v, --verbose           Verbose output
+  -y, --yes               answer yes to all prompts
+```
+
+### SEE ALSO
+
+* [octl iaas vm](octl_iaas_vm.md)	 - vm commands
+

@jfbus jfbus added the kind/other Other change label Mar 12, 2026
@jfbus jfbus marked this pull request as ready for review March 12, 2026 17:09
@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 12, 2026

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

@jfbus jfbus force-pushed the lbu_aliases branch 8 times, most recently from c1fa448 to 9eb7264 Compare March 13, 2026 10:24
@jfbus jfbus merged commit dcf19ac into main Mar 13, 2026
7 checks passed
@jfbus jfbus deleted the lbu_aliases branch March 13, 2026 12:11
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