Skip to content

clustermesh install documentation: missing step #28889

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Nov 14, 2023
Merged

clustermesh install documentation: missing step #28889

merged 1 commit into from
Nov 14, 2023

Conversation

dashaun
Copy link
Contributor

@dashaun dashaun commented Oct 31, 2023

As I normally follow along with documentation, I usually look at the code blocks to see which steps I need to execute.

I was starting from scratch, following the docs, and never saw a cilium install step. When I got to the cilium clustermesh enable step I got an error, because I hadn't installed Cilium into the cluster yet.

This patch simply points out that Cilium needs to be installed on each cluster, and it gives a code block, with a copy/paste example.

Please ensure your pull request adheres to the following guidelines:

  • For first time contributors, read Submitting a pull request
  • All code is covered by unit and/or runtime tests where feasible.
  • All commits contain a well written commit description including a title,
    description and a Fixes: #XXX line if the commit addresses a particular
    GitHub issue.
  • If your commit description contains a Fixes: <commit-id> tag, then
    please add the commit author[s] as reviewer[s] to this issue.
  • All commits are signed off. See the section Developer’s Certificate of Origin
  • Provide a title or release-note blurb suitable for the release notes.
  • Are you a user of Cilium? Please add yourself to the Users doc
  • Thanks for contributing!

@dashaun dashaun requested review from a team as code owners October 31, 2023 08:49
@dashaun dashaun requested review from marseel and learnitall October 31, 2023 08:49
@maintainer-s-little-helper maintainer-s-little-helper bot added the dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. label Oct 31, 2023
@github-actions github-actions bot added the kind/community-contribution This was a contribution made by a community member. label Oct 31, 2023
@aanm aanm added the release-note/misc This PR makes changes that have no direct user impact. label Oct 31, 2023
@maintainer-s-little-helper maintainer-s-little-helper bot removed the dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. label Oct 31, 2023
@aanm
Copy link
Member

aanm commented Oct 31, 2023

/test

marseel
marseel requested changes Oct 31, 2023
View reviewed changes
Copy link
Contributor

@marseel marseel left a comment

Choose a reason for hiding this comment

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

Thanks for your contribution, definitely makes sense to me.

@maintainer-s-little-helper
Copy link

Commit 058d9a1 does not match "(?m)^Signed-off-by:".

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

@maintainer-s-little-helper maintainer-s-little-helper bot added the dont-merge/needs-sign-off The author needs to add signoff to their commits before merge. label Oct 31, 2023
@maintainer-s-little-helper
Copy link

Commits 058d9a1, a8b051c do not match "(?m)^Signed-off-by:".

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

@dashaun dashaun marked this pull request as draft November 1, 2023 20:10
@maintainer-s-little-helper
Copy link

Commits 058d9a1, a8b051c, b93af2b do not match "(?m)^Signed-off-by:".

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

@dashaun dashaun marked this pull request as ready for review November 1, 2023 20:17
@dashaun dashaun requested a review from marseel November 1, 2023 20:45
learnitall
learnitall suggested changes Nov 1, 2023
View reviewed changes
Copy link
Contributor

@learnitall learnitall left a comment

Choose a reason for hiding this comment

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

There's one change needed to get a successful build. Otherwise LGTM. Thanks!

@maintainer-s-little-helper
Copy link

Commits 058d9a1, a8b051c, ab50a14, b93af2b, e6e7d49 do not match "(?m)^Signed-off-by:".

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

1 similar comment
@maintainer-s-little-helper
Copy link

Commits 058d9a1, a8b051c, ab50a14, b93af2b, e6e7d49 do not match "(?m)^Signed-off-by:".

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

@dashaun dashaun requested a review from learnitall November 1, 2023 23:47
@aanm
Copy link
Member

aanm commented Nov 3, 2023

@dashaun thank you for the contribution. Can you squash all commits together into one? Thank you

marseel
marseel approved these changes Nov 3, 2023
View reviewed changes
Copy link
Contributor

@marseel marseel left a comment

Choose a reason for hiding this comment

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

Thanks, looks good from my side.

learnitall
learnitall approved these changes Nov 3, 2023
View reviewed changes
Copy link
Contributor

@learnitall learnitall left a comment

Choose a reason for hiding this comment

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

Thanks!

@squeed
Copy link
Contributor

squeed commented Nov 8, 2023

@dashaun can you please squash to a single commit? Thanks! Then this will be ready to merge.

@maintainer-s-little-helper
Copy link

Commits 058d9a1, a8b051c, ab50a14, b93af2b, e6e7d49, b24c2a6, 1cf793e do not match "(?m)^Signed-off-by:".

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

@maintainer-s-little-helper
Copy link

Commits 058d9a1, a8b051c, ab50a14, b93af2b, e6e7d49, b24c2a6, 1cf793e, 76b84dd do not match "(?m)^Signed-off-by:".

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

@dashaun dashaun closed this Nov 12, 2023
@dashaun
Docs: clustermesh install documentation, add missing step
a14eb7d 
As I normally follow along with documentation, I usually look at the code blocks to see which steps I need to execute.

I was starting from scratch, following the docs, and never saw a *cilium install* step.
When I got to the *cilium clustermesh enable* step I got an error, because I hadn't installed Cilium into the cluster yet.

This patch simply points out that Cilium needs to be installed on each cluster, and it gives a code block, with a copy/paste example.

Signed-off-by: DaShaun Carter <dashaun@dashaun.com>
@dashaun dashaun reopened this Nov 12, 2023
@maintainer-s-little-helper maintainer-s-little-helper bot removed dont-merge/needs-sign-off The author needs to add signoff to their commits before merge. labels Nov 12, 2023
@dashaun
Copy link
Contributor Author

dashaun commented Nov 12, 2023 •
edited
Loading

@squeed Squashed into 1 commit

@julianwiedmann julianwiedmann added area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. area/clustermesh Relates to multi-cluster routing functionality in Cilium. labels Nov 14, 2023
@julianwiedmann
Copy link
Member

/test

@julianwiedmann julianwiedmann merged commit e010bfd into cilium:main Nov 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@marseel marseel marseel approved these changes

+1 more reviewer

@learnitall learnitall learnitall approved these changes

Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
area/clustermesh Relates to multi-cluster routing functionality in Cilium. area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. kind/community-contribution This was a contribution made by a community member. release-note/misc This PR makes changes that have no direct user impact.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@dashaun @aanm @squeed @julianwiedmann @marseel @learnitall