-
Notifications
You must be signed in to change notification settings - Fork 117
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
Add example for Role, RoleBinding and Secret to configure BGP passwords #1837
base: main
Are you sure you want to change the base?
Add example for Role, RoleBinding and Secret to configure BGP passwords #1837
Conversation
✅ Deploy Preview succeeded!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for calico-docs-preview-next ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Thanks for this contribution, @paketb0te! I'll let @caseydavenport vet the technical side before I follow up with a docs review. |
@caseydavenport I expect this new information would be universal. Am I right thinking we should eventually pick these changes to all products / versions? |
kind: Role | ||
metadata: | ||
name: bgp-passwords-reader | ||
namespace: kube-system |
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.
I think we want to default to calico-system (most new installs use the calico-system namespace).
Perhaps this is a use-case for Tabs for "Operator" and "Manifest" installs? We have those elsewhere in the docs.
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.
Sure, I don't mind which one is used as example :)
Maybe we could even make it extra-explicit by using something like $NAMESPACE_IN_WHICH_CALICO_IS_RUNNING
That would
a) make it non-copy-paste-able, and thus
b) ensure that people look up the namespace calico is actually running in.
I like these Tabs for the different installation methods because they help keep the docs a bit clearer, but I also think they are better used in the "explanatory" sections of the docs and could be confusing in the Resource Definition Reference.
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.
I'd be happy with that approach :)
I'll leave it up to @ctauchen as to what the preferred style guideline would be in this case.
Product Version(s):
Calico
Issue:
fixes projectcalico/calico#6893
Link to docs preview:
CLICK
SME review:
DOCS review:
Additional information:
The Docs (in the reource definition for BGP peers) show that BGP Passwords must be stored in a Secret and then be referenced via the
KeyRef
(name of the secret and the key within that secret).BUT it does not mention that this requires additional privileges for the
calico-node
ServiceAccount to access this secret.It obviously makes sense if you think about it, but IMO it would make a lot of sense to mention that somewhere - see also @caseydavenport comments in projectcalico/calico#6893
I think the included example might be a bit over the top, maybe there is a way to make it show only partially by default and expand on click or something?
I am not exactly familiar with mdx unfortunately.
Merge checklist: