-
Notifications
You must be signed in to change notification settings - Fork 3.4k
add getting started guide for BIRD #10326
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
Conversation
Release note label not set, please set the appropriate release note. |
Coverage increased (+0.007%) to 45.519% when pulling 968de865a7e87298df7e44cf3661a62bcc52d49f on ctripcloud:bird_guide into 43f7824 on cilium:master. |
efa061a
to
968de86
Compare
test-docs-please |
968de86
to
37dc5bb
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @ArthurChiao! This is great 👍
I haven't tested it yet, but I found a few nits (see below) and a couple warnings returned by Sphinx when I run make render-docs
to see the Read the docs rendering. I have written these as GitHub suggestions whenever possible, in case that makes it easier for you to integrate and then just rebase :-)
Could you also add this guide to Documentation/gettingstarted/index.rst
, under Advanced Networking
?
Commit 9cd69cf215cf3a87e23a3d9696461bbeab3f63c1 does not contain "Signed-off-by". Please follow instructions provided in https://docs.cilium.io/en/stable/contributing/contributing/#developer-s-certificate-of-origin |
Commits 9cd69cf215cf3a87e23a3d9696461bbeab3f63c1, 3e22ddc3ad742fe86566be4f19ccdd4b5a799b2a do not contain "Signed-off-by". Please follow instructions provided in https://docs.cilium.io/en/stable/contributing/contributing/#developer-s-certificate-of-origin |
3 similar comments
Commits 9cd69cf215cf3a87e23a3d9696461bbeab3f63c1, 3e22ddc3ad742fe86566be4f19ccdd4b5a799b2a do not contain "Signed-off-by". Please follow instructions provided in https://docs.cilium.io/en/stable/contributing/contributing/#developer-s-certificate-of-origin |
Commits 9cd69cf215cf3a87e23a3d9696461bbeab3f63c1, 3e22ddc3ad742fe86566be4f19ccdd4b5a799b2a do not contain "Signed-off-by". Please follow instructions provided in https://docs.cilium.io/en/stable/contributing/contributing/#developer-s-certificate-of-origin |
Commits 9cd69cf215cf3a87e23a3d9696461bbeab3f63c1, 3e22ddc3ad742fe86566be4f19ccdd4b5a799b2a do not contain "Signed-off-by". Please follow instructions provided in https://docs.cilium.io/en/stable/contributing/contributing/#developer-s-certificate-of-origin |
Commits 9cd69cf215cf3a87e23a3d9696461bbeab3f63c1, 3e22ddc3ad742fe86566be4f19ccdd4b5a799b2a, 5ae1bb146765074c247ddb5a3b6707d5325628dc, 45490bdea80e9e6c78c2d1ad169830a95e7dd5d8 do not contain "Signed-off-by". Please follow instructions provided in https://docs.cilium.io/en/stable/contributing/contributing/#developer-s-certificate-of-origin |
2 similar comments
Commits 9cd69cf215cf3a87e23a3d9696461bbeab3f63c1, 3e22ddc3ad742fe86566be4f19ccdd4b5a799b2a, 5ae1bb146765074c247ddb5a3b6707d5325628dc, 45490bdea80e9e6c78c2d1ad169830a95e7dd5d8 do not contain "Signed-off-by". Please follow instructions provided in https://docs.cilium.io/en/stable/contributing/contributing/#developer-s-certificate-of-origin |
Commits 9cd69cf215cf3a87e23a3d9696461bbeab3f63c1, 3e22ddc3ad742fe86566be4f19ccdd4b5a799b2a, 5ae1bb146765074c247ddb5a3b6707d5325628dc, 45490bdea80e9e6c78c2d1ad169830a95e7dd5d8 do not contain "Signed-off-by". Please follow instructions provided in https://docs.cilium.io/en/stable/contributing/contributing/#developer-s-certificate-of-origin |
hi @pchaigno , big thanks for your advises! I have resolved them except two:
|
Commits 2899518813f2c09ed83c2b26044d9f8325eac295, 6f688cb145abdd9b239b0a9637edcadcbcdff26f, 4fdc010f06d3980563940a66edf16666750e3c6a do not contain "Signed-off-by". Please follow instructions provided in https://docs.cilium.io/en/stable/contributing/contributing/#developer-s-certificate-of-origin |
2 similar comments
Commits 2899518813f2c09ed83c2b26044d9f8325eac295, 6f688cb145abdd9b239b0a9637edcadcbcdff26f, 4fdc010f06d3980563940a66edf16666750e3c6a do not contain "Signed-off-by". Please follow instructions provided in https://docs.cilium.io/en/stable/contributing/contributing/#developer-s-certificate-of-origin |
Commits 2899518813f2c09ed83c2b26044d9f8325eac295, 6f688cb145abdd9b239b0a9637edcadcbcdff26f, 4fdc010f06d3980563940a66edf16666750e3c6a do not contain "Signed-off-by". Please follow instructions provided in https://docs.cilium.io/en/stable/contributing/contributing/#developer-s-certificate-of-origin |
Commits 2899518813f2c09ed83c2b26044d9f8325eac295, 6f688cb145abdd9b239b0a9637edcadcbcdff26f, 4fdc010f06d3980563940a66edf16666750e3c6a, 577200131e61f8b76e6281f5504e0a3ae7d06090, 87514dbfa03e7e8009c8047f8c828942c5f5935d do not contain "Signed-off-by". Please follow instructions provided in https://docs.cilium.io/en/stable/contributing/contributing/#developer-s-certificate-of-origin |
3 similar comments
Commits 2899518813f2c09ed83c2b26044d9f8325eac295, 6f688cb145abdd9b239b0a9637edcadcbcdff26f, 4fdc010f06d3980563940a66edf16666750e3c6a, 577200131e61f8b76e6281f5504e0a3ae7d06090, 87514dbfa03e7e8009c8047f8c828942c5f5935d do not contain "Signed-off-by". Please follow instructions provided in https://docs.cilium.io/en/stable/contributing/contributing/#developer-s-certificate-of-origin |
Commits 2899518813f2c09ed83c2b26044d9f8325eac295, 6f688cb145abdd9b239b0a9637edcadcbcdff26f, 4fdc010f06d3980563940a66edf16666750e3c6a, 577200131e61f8b76e6281f5504e0a3ae7d06090, 87514dbfa03e7e8009c8047f8c828942c5f5935d do not contain "Signed-off-by". Please follow instructions provided in https://docs.cilium.io/en/stable/contributing/contributing/#developer-s-certificate-of-origin |
Commits 2899518813f2c09ed83c2b26044d9f8325eac295, 6f688cb145abdd9b239b0a9637edcadcbcdff26f, 4fdc010f06d3980563940a66edf16666750e3c6a, 577200131e61f8b76e6281f5504e0a3ae7d06090, 87514dbfa03e7e8009c8047f8c828942c5f5935d do not contain "Signed-off-by". Please follow instructions provided in https://docs.cilium.io/en/stable/contributing/contributing/#developer-s-certificate-of-origin |
c1398b3
to
1cfe207
Compare
Indeed i missed the hidden ones just now @pchaigno |
ref cilium#10160 Signed-off-by: ArthurChiao <arthurchiao@hotmail.com>
1cfe207
to
719232c
Compare
test-docs-please |
@ArthurChiao can this be backported to 1.7 as well, meaning, is it confirmed to work with 1.7 so it could go into the stable doc? Thx |
@borkmann yes, i have tested Cilium Actually in my understanding, Cilium and bird works independently, they collaborate through kernel routing tables/facilities, so as long as they do not break their kernel conventions, each of them could be upgraded/downgraded transparently - or even, be replaced by their alternatives (that's how we rolling-replaced kube-router with bird). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is awesome!
Did you consider whether it is feasible to deploy BIRD as a DaemonSet rather than configuring each node? Just wondering if there's an easier configuration path there.
Either way, the nice thing about this guide is that it explains the various settings that must be made and at least provides the first round of documentation. That's valuable in itself.
Full disclosure: I didn't try this guide out.
@joestringer that's nice way for automation, but at present there are many challenges that may threaten the availability (both bird itself and the whole cluster) instead of strengthen it, such as:
For these reason, we prefer standalone deployment of bird currently. However, i will consider your suggested way, thanks! |
ref #10160
Signed-off-by: ArthurChiao arthurchiao@hotmail.com
This change is