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

📖 Document the CS_EXTERNAL_ID in the quickstart. #194

Merged
merged 4 commits into from
Jan 14, 2025

Conversation

garloff
Copy link
Member

@garloff garloff commented Jan 13, 2025

What this PR does / why we need it:

The CS_EXTERNAL_ID is not obvious in the quickstart guide, which can be fixed with one sentence.

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):

Fixes #192.

Fixes #192.

Signed-off-by: Kurt Garloff <[email protected]>
@garloff garloff requested a review from jschoone January 13, 2025 07:57
@garloff garloff self-assigned this Jan 13, 2025
Copy link
Contributor

@jschoone jschoone left a comment

Choose a reason for hiding this comment

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

In newer versions this can also be left empty if only one external network exists. But this is probably not the case for all Cluster Stack releases out there so it's good to mention it.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
@garloff
Copy link
Member Author

garloff commented Jan 13, 2025

In newer versions this can also be left empty if only one external network exists. But this is probably not the case for all Cluster Stack releases out there so it's good to mention it.

I assume you would then have to remove the variable from spec.topology.variables entirely in cluster.yaml, correct?

Signed-off-by: Kurt Garloff <[email protected]>

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
@garloff garloff merged commit 2b2935f into main Jan 14, 2025
3 checks passed
@garloff garloff deleted the feat/document-external-id branch January 14, 2025 16:12
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.

Quickstart guide: EXTERNAL_ID needs to be explained
2 participants