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

docs: sealos create support for environment variable based template rendering #4224

Merged
merged 6 commits into from Nov 2, 2023

Conversation

LZiHaN
Copy link
Contributor

@LZiHaN LZiHaN commented Nov 1, 2023

🤖 Generated by Copilot at 31fa465

Summary

📝🆕🌐

This pull request adds and documents a new option for the sealos create command that allows specifying environment variables for cluster creation. The changes affect both the English and Chinese documentation files in docs/4.0.

Oh, we're the crew of the sealos ship, and we sail the code sea
We document our commands with care, for every user to see
We added a new option today, to set environment vars
So heave away, me hearties, heave away on sealos create

Walkthrough

  • Add a new option -e, --env=[] to the sealos create command, which allows users to specify environment variables used during the rendering of template files (link, link)
  • Modify the example command for the sealos create command in the docs/4.0/docs/self-hosting/lifecycle-management/reference/sealos/commands/create.md and docs/4.0/i18n/zh-Hans/self-hosting/lifecycle-management/reference/sealos/commands/create.md files, adding the -e registryPort=8443 option and clarifying that the cluster is not actually run by the command (link, link)
  • Update the wording of the last paragraph in the example section of the sealos create command documentation, improving the clarity and accuracy of the information (link, link)

refer to #3774

Supporting documentation:
https://sealos.io/docs/self-hosting/lifecycle-management/operations/build-image/build-image-go_template
https://sealos.io/docs/self-hosting/lifecycle-management/advanced-guide/template-function
https://sealos.io/docs/self-hosting/lifecycle-management/reference/sealos/app-cluster-image

@sealos-ci-robot
Copy link
Member

🤖 Generated by lychee action

Summary

Status Count
🔍 Total 970
✅ Successful 377
⏳ Timeouts 0
🔀 Redirected 0
👻 Excluded 592
❓ Unknown 0
🚫 Errors 0

Full action output

Full Github Actions output

Copy link

sweep-ai bot commented Nov 1, 2023

Apply Sweep Rules to your PR?

  • Apply: Leftover TODOs in the code should be handled.
  • Apply: All new business logic should have corresponding unit tests in the tests/ directory.
  • Apply: Any clearly inefficient or repeated code should be optimized or refactored.

@sealos-ci-robot
Copy link
Member

📘 Preview documentation website

👀 Visit Preview

@cuisongliu cuisongliu added this to the v5.0 milestone Nov 1, 2023
@cuisongliu cuisongliu merged commit 77e7e18 into labring:main Nov 2, 2023
16 checks passed
@LZiHaN LZiHaN deleted the issue-3774 branch November 6, 2023 12:50
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.

None yet

3 participants