doc: add API parameter syntax examples for nodeofferings and nodetemp… - #13902
Conversation
…lates in createKubernetesCluster Add usage examples to the @parameter descriptions for nodeofferings and nodetemplates in CreateKubernetesClusterCmd.java, showing how to specify different service offerings and templates for control vs worker nodes. Discussion: apache#13395
|
Congratulations on your first Pull Request and welcome to the Apache CloudStack community! If you have any issues or are unsure about any anything please check our Contribution Guide (https://github.com/apache/cloudstack/blob/main/CONTRIBUTING.md)
|
|
note: text only |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #13902 +/- ##
============================================
+ Coverage 3.41% 19.65% +16.23%
- Complexity 0 19792 +19792
============================================
Files 487 6368 +5881
Lines 41867 574889 +533022
Branches 7912 70353 +62441
============================================
+ Hits 1429 112975 +111546
- Misses 40238 449643 +409405
- Partials 200 12271 +12071
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
|
I'm concerned about why we merged a PR that was visibly failing all Simulator CI jobs. Not sure maybe we should look into repository rulesets for branch protection |
fixed by #14044 |
good idea ! |
I am in favour in principle, but am a bit worried that our many false positives are going to impede our (already not so great) velocity.
|
we can start with a minimum set
|


Description
The API documentation for
createKubernetesClusterdoes not include syntax examples for thenodeofferingsandnodetemplatesparameters, making it difficult for users to specify different service offerings and templates for control vs worker nodes.This PR adds usage examples to the
@Parameterdescriptions, following the same inline example pattern already used by thecniconfigdetailsparameter in the same file.Examples added
nodeofferings:
nodeofferings[0].node="control"&nodeofferings[0].offering=""&
nodeofferings[1].node="worker"&nodeofferings[1].offering=""
nodetemplates:
nodetemplates[0].node="control"&nodetemplates[0].template=""&
nodetemplates[1].node="worker"&nodetemplates[1].template=""
Context
Discussion: #13395
Thanks to @Pearl1594 for providing the syntax and @DaanHoogland for guiding the contribution process.
Types of changes
Checklist