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

doc: modify the cmd help message #2128

Merged
merged 1 commit into from
Mar 23, 2023

Conversation

Stevent-fei
Copy link
Collaborator

@Stevent-fei Stevent-fei commented Mar 20, 2023

Describe what this PR does / why we need it

Use single quotes around the password to ensure that the password is treated as a string.

example:

sealer run docker.io/sealerio/kubernetes:v1.22.15 -m 172.16.130.20 -n 172.16.130.21 -p 'Sealer123$abc'

Does this pull request fix one issue?

Describe how you did it

Describe how to verify it

Special notes for reviews

@codecov-commenter
Copy link

codecov-commenter commented Mar 20, 2023

Codecov Report

Patch coverage has no change and project coverage change: +4.35 🎉

Comparison is base (b964a4d) 8.38% compared to head (f2bff11) 12.73%.

❗ Current head f2bff11 differs from pull request most recent head 32d4553. Consider uploading reports for the commit 32d4553 to get more accurate results

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

Additional details and impacted files
@@            Coverage Diff            @@
##            main    #2128      +/-   ##
=========================================
+ Coverage   8.38%   12.73%   +4.35%     
=========================================
  Files        258      258              
  Lines      22194    22198       +4     
=========================================
+ Hits        1860     2827     +967     
+ Misses     20088    18990    -1098     
- Partials     246      381     +135     
Flag Coverage Δ
e2e-tests 8.60% <ø> (+7.27%) ⬆️
unit-tests 18.90% <0.00%> (-0.01%) ⬇️

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

Impacted Files Coverage Δ
pkg/clusterfile/decoder.go 45.32% <0.00%> (-0.22%) ⬇️

... and 28 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@@ -43,7 +43,7 @@ Then you can use any sealer command to manage the cluster like:

var exampleForGenCmd = `The following command will generate Clusterfile used by sealer under user home dir:

sealer alpha gen --passwd Sealer123 --image kubernetes:v1.19.8
sealer alpha gen --passwd 'Sealer123' --image kubernetes:v1.19.8
Copy link
Member

Choose a reason for hiding this comment

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

--image kubernetes:v1.19.8 replace to the latest sealer image version Or give a sample .

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

done

@kakaZhou719 kakaZhou719 changed the title doc: modify the description of the cmd module doc: modify the cmd help message Mar 23, 2023
Copy link
Member

@kakaZhou719 kakaZhou719 left a comment

Choose a reason for hiding this comment

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

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug] sealer will get wrong password when the password carries the $sign
3 participants