Skip to content

doc: add API parameter syntax examples for nodeofferings and nodetemp… - #13902

Merged
DaanHoogland merged 1 commit into
apache:mainfrom
chunkyen:doc/createK8sCluster-api-examples
Sep 2, 2026
Merged

doc: add API parameter syntax examples for nodeofferings and nodetemp…#13902
DaanHoogland merged 1 commit into
apache:mainfrom
chunkyen:doc/createK8sCluster-api-examples

Conversation

@chunkyen

Copy link
Copy Markdown
Contributor

Description

The API documentation for createKubernetesCluster does not include syntax examples for the nodeofferings and nodetemplates parameters, making it difficult for users to specify different service offerings and templates for control vs worker nodes.

This PR adds usage examples to the @Parameter descriptions, following the same inline example pattern already used by the cniconfigdetails parameter 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

  • Bug fix (non-breaking change which fixes an issue)
  • Documentation change (API parameter descriptions)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • Code formatted according to project style
  • Self-reviewed the changes
  • No new warnings generated
  • Documentation updated (this IS the documentation update)

…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
@boring-cyborg

boring-cyborg Bot commented Aug 18, 2026

Copy link
Copy Markdown

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)
Here are some useful points:

@DaanHoogland DaanHoogland added this to the 4.24.0 milestone Aug 18, 2026

@DaanHoogland DaanHoogland left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

clgtm

@DaanHoogland

Copy link
Copy Markdown
Contributor

note: text only

@codecov

codecov Bot commented Aug 18, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 19.65%. Comparing base (121d931) to head (2afb902).
⚠️ Report is 69 commits behind head on main.

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     
Flag Coverage Δ
uitests 3.41% <ø> (ø)
unittests 20.92% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@DaanHoogland DaanHoogland moved this from Backlog to In review in CloudStack Testing Aug 31, 2026
@DaanHoogland
DaanHoogland merged commit 3d70ce4 into apache:main Sep 2, 2026
9 of 27 checks passed
@github-project-automation github-project-automation Bot moved this from In review to Done in CloudStack Testing Sep 2, 2026
@weizhouapache

Copy link
Copy Markdown
Member

this PR breaks the simulator CI:

image

@shwstppr

shwstppr commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

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

@weizhouapache

Copy link
Copy Markdown
Member

this PR breaks the simulator CI:

image

fixed by #14044

@weizhouapache

Copy link
Copy Markdown
Member

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

good idea !

@DaanHoogland

Copy link
Copy Markdown
Contributor

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

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.
In this case the change was text only and the build passed. We have a usually failing Sonar check and also coverage is not passing. So what will be the requirements that we do impose?
¿

  • rat
  • lint/pre-commit
  • build
  • codeql
  • test-matrix
    ?

@weizhouapache

Copy link
Copy Markdown
Member

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

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. In this case the change was text only and the build passed. We have a usually failing Sonar check and also coverage is not passing. So what will be the requirements that we do impose? ¿

  • rat
  • lint/pre-commit
  • build
  • codeql
  • test-matrix
    ?

we can start with a minimum set

  • Build / build (pull_request)
  • License Check / build (pull_request)
  • pre-commit / Run pre-commit (pull_request)
  • Simulator CI / build (pull_request)
  • UI Build / build (pull_request)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants