Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Optimize the example of the 'install' command line. #1861

Closed
wants to merge 1 commit into from

Conversation

sujoshua
Copy link
Contributor

@sujoshua sujoshua commented Jul 24, 2023

Since --helm-set is an alias of --set and only --set is listed in help, it would be confusing when example still use

# Install Cilium into Kubernetes context "kind-cluster1" and also set cluster
# name and ID to prepare for multi-cluster capabilities.
cilium install --context kind-cluster1 --helm-set cluster.id=1 --helm-set cluster.name=cluster1

Instead we should use set as follows

# Install Cilium into Kubernetes context "kind-cluster1" and also set cluster
# name and ID to prepare for multi-cluster capabilities.
cilium install --context kind-cluster1 --set cluster.id=1 --set cluster.name=cluster1

This way, users can easily find the correct flag in the --help command.

Signed-off-by: Joshua Su [email protected]

@sujoshua sujoshua requested a review from a team as a code owner July 24, 2023 13:58
@sujoshua sujoshua requested a review from derailed July 24, 2023 13:58
@maintainer-s-little-helper
Copy link

Commit d92407d does not contain "Signed-off-by".

Please follow instructions provided in https://docs.cilium.io/en/stable/contributing/development/contributing_guide/#developer-s-certificate-of-origin

@sujoshua sujoshua temporarily deployed to ci July 24, 2023 13:58 — with GitHub Actions Inactive
@sujoshua sujoshua closed this Jul 24, 2023
@sujoshua sujoshua temporarily deployed to ci July 24, 2023 14:53 — with GitHub Actions Inactive
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.

1 participant