-
Notifications
You must be signed in to change notification settings - Fork 14.4k
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
Adding a guide for admins to set up federation #662
Adding a guide for admins to set up federation #662
Conversation
cc @kubernetes/docs @kubernetes/docs-review-team @johndmulhausen @lavalamp |
Also updated |
Now that we have the federation control plane up and running, we can start registering kubernetes clusters. | ||
|
||
First of all, we need to create a secret containing kubeconfig for that kubernetes cluster, which federation control plane will use to talk to that kubernetes cluster. | ||
For now, we create this secret in the host kubernetes cluster (that hosts federation control plane). When we start supporting secrets in federation control plane, we will create this secret their. |
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.
s/secret their/secret there/
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.
good catch, thx!
fixed
@nikhiljindal Few minor nits, LGTM otherwise. Feel free to apply the LGTM label after addressing the comments. |
Adding my comments from #656: One important thing that isn't included here is how DNS works. Right now AWS and GCE are supported, but the docs don't mention how/why DNS is used, or how users can add their own DNS provider. Another thing that isn't clear is whether resources - like pods or services - can exist at the federation level, i.e. in the |
name: <secret-name> | ||
``` | ||
|
||
You need to insert the appropriate values for `<client-cidr>`, `<apiserver-address>` and `<secret-name>`. |
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.
What does the client-cidr
refer to here?
If I have a cluster from another region I want to add (with its own load balancer), where would I find the CIDR?
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.
added some explanation.
If you have a globally accessible IP address for that cluster, then you can just set the CIDR to "0.0.0.0/0"
@nikhiljindal ping |
Updated code as per comments, PTAL |
@nikhiljindal Hey, would you also mind addressing my comment above? |
$ KUBERNETES_PROVIDER=gce FEDERATION_DNS_PROVIDER=google-clouddns FEDERATION_NAME=myfederation DNS_ZONE_NAME=myfederation.example FEDERATION_PUSH_REPO_BASE=gcr.io/google_containers ./federation/cluster/federation-up.sh | ||
``` | ||
|
||
KUBERNETES_PROVIDER is the cloud provider. |
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.
KUBERNETES_PROVIDER
(backticks) -- this goes for all the env vars, just mentioning it once here
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.
done
Apologies @jamiehannaford for missing your comment earlier.
Have added some info on how/why DNS is used with explanation for FEDERATION_DNS_PROVIDER env var.
IIUC, this is like a federated ingress object that is backed by pods from all clusters? |
|
||
### Updating KubeDNS | ||
|
||
Once the cluster is registered with federation, we are all ready to use it. |
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.
with a federation
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.
well its not just a federation. Its the federation that we are setting up.
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.
You could also say "with the federation" if you like that better. Just not "with federation" which is not grammatically correct. :)
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.
Fixed
Thanks @johndmulhausen |
The command to run these pods on an existing GCE cluster will look like: | ||
|
||
```shell | ||
$ KUBERNETES_PROVIDER=gce FEDERATION_DNS_PROVIDER=google-clouddns FEDERATION_NAME=myfederation DNS_ZONE_NAME=myfederation.example FEDERATION_PUSH_REPO_BASE=gcr.io/google_containers ./federation/cluster/federation-up.sh |
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.
We need to fix federation/manifests/federation-apiserver-deployment.yaml
before telling customers to bring up a cluster this way, since as of right now the federation etcd is not backed by persistent storage.
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.
As discussed have added a note to say so.
Updated the code as per comments |
Thanks, @nikhiljindal ! Merging based on previous LGTMs from tech reviewers here |
Signed-off-by: Zahari Dichev <zaharidichev@gmail.com>
* feat: start localization to contributor ladder * feat: add contributor ladder * docs: add more translation to contributor ladder * feat: add more translation to contributor ladder * feat: add more translation to contributor ladder * fix: fix small typos * Apply suggestions from code review Co-authored-by: Jéssica Lins <jlins@redhat.com> * feat: apply suggestions by code review * feat: change "." to ";" Co-authored-by: Jéssica Lins <jlins@redhat.com>
* feat: start localization to contributor ladder * feat: add contributor ladder * docs: add more translation to contributor ladder * feat: add more translation to contributor ladder * feat: add more translation to contributor ladder * fix: fix small typos * Apply suggestions from code review Co-authored-by: Jéssica Lins <jlins@redhat.com> * feat: apply suggestions by code review * feat: change "." to ";" Co-authored-by: Jéssica Lins <jlins@redhat.com>
* Update CODEOWNERS in dev-pt to sync with main * Settings and initial contents for Portuguese localization (kubernetes#343) * docs: add configs and index to content/pt * docs: add contribute and style guide to content/pt * docs: add more translated content and update index.md * doc: add i18n/pt.toml * doc: change configs to use pt-br instead of pt * docs: add style-guide in pt-br * docs: small typos in pt-br * docs: small contribute in ptbr * docs: fix markdown at style-guide Co-authored-by: Seokho Son <shsongist@gmail.com> * docs: fix weight to pt-br config Co-authored-by: Seokho Son <shsongist@gmail.com> * docs: remove i18n/pt.toml Co-authored-by: Seokho Son <shsongist@gmail.com> * Update CODEOWNDERS for dev-pt * Add content/pt-br/application_programming_interface.md (kubernetes#437) * Add content/pt-br/application_programming_interface.md Signed-off-by: Jéssica Lins <jessicaalins@gmail.com> * Add content/pt-br/blue_green_deployment.md (kubernetes#436) * Add content/pt-br/blue_green_deployment.md Signed-off-by: Jéssica Lins <jessicaalins@gmail.com> * adding client_server_architecture localization (kubernetes#480) * Add content/pt-br/bare_metal_machine.md (kubernetes#493) * Add content/pt-br/bare_metal_machine.md * Add content/pt-br/container-image.md * Update content/pt-br/bare_metal_machine.md * Remove container-image.md * Traduzido título * Add content/pt-br/devops.md (kubernetes#478) * docs(pt-br): add content/pt-br/devops.md * Add content/pt-br/containerization.md (kubernetes#487) * docs: add containerization.md localization to ptbr * Update content/pt-br/containerization.md Co-authored-by: Jéssica Lins <jlins@redhat.com> * Update content/pt-br/containerization.md Co-authored-by: Jéssica Lins <jlins@redhat.com> * Update content/pt-br/containerization.md Co-authored-by: Jéssica Lins <jlins@redhat.com> Co-authored-by: Jéssica Lins <jlins@redhat.com> * Add content/pt-br/cluster.md (kubernetes#486) * docs: add cluster.md localization to ptbr * docs: add cluster.md localization to ptbr * Apply suggested reviews Co-authored-by: Jéssica Lins <jlins@redhat.com> Co-authored-by: Jéssica Lins <jlins@redhat.com> * Add content/pt-br/container.md (kubernetes#485) * docs: add container.md localization to ptbr * feat: improve some sentences * Add content/pt-br/cloud_native_apps.md (kubernetes#596) * Add content/pt-br/bare_metal_machine.md * Add content/pt-br/container-image.md * Update content/pt-br/bare_metal_machine.md * Remove container-image.md * Traduzido título * Remove bare_metal_machine.md * Add content/pt-br/cloud_native_apps.md * Add content/pt-br/container-image.md (kubernetes#557) * Add content/pt-br/bare_metal_machine.md * Add content/pt-br/container-image.md * Update content/pt-br/bare_metal_machine.md * Remove container-image.md * Traduzido título * Add container-image.md * Remove bare_metal_machine.md * Change from registros do contêiner to repositório de imagens * api gateway localization (kubernetes#479) * Add content/pt-br/cloud_native_security.md (kubernetes#643) * Add content/pt-br/bare_metal_machine.md * Add content/pt-br/container-image.md * Update content/pt-br/bare_metal_machine.md * Remove container-image.md * Traduzido título * Traduzido cloud_native_security * Add content/pt-br/canary_deployment.md (kubernetes#595) * Add content/pt-br/bare_metal_machine.md * Add content/pt-br/container-image.md * Update content/pt-br/bare_metal_machine.md * Remove container-image.md * Traduzido título * Remove bare_metal_machine.md * Add canary_deployment.md * Add content/pt-br/continuous_delivery.md (kubernetes#558) * Add content/pt-br/bare_metal_machine.md * Add content/pt-br/container-image.md * Update content/pt-br/bare_metal_machine.md * Remove container-image.md * Traduzido título * Remove bare_metal_machine.md * Add continuous_delivery.md * Add content/pt-br/contributor-ladder (kubernetes#662) * feat: start localization to contributor ladder * feat: add contributor ladder * docs: add more translation to contributor ladder * feat: add more translation to contributor ladder * feat: add more translation to contributor ladder * fix: fix small typos * Apply suggestions from code review Co-authored-by: Jéssica Lins <jlins@redhat.com> * feat: apply suggestions by code review * feat: change "." to ";" Co-authored-by: Jéssica Lins <jlins@redhat.com> * feat: change style guide to how to contribute and style guide (kubernetes#663) * Add content/pt-br/continuous_integration.md (kubernetes#594) * Add content/pt-br/bare_metal_machine.md * Add content/pt-br/container-image.md * Update content/pt-br/bare_metal_machine.md * Remove container-image.md * Traduzido título * Remove bare_metal_machine.md * Add continuous_integration.md * Sentence structure adjustment * [pt-BR] Add contributors names (kubernetes#671) * feat: add contributors * feat: add ptbr contributors * [pt-BR] Update config.toml (kubernetes#677) * feat: update config.toml with main * Settings and initial contents for Portuguese localization (kubernetes#343) * docs: add configs and index to content/pt * docs: add contribute and style guide to content/pt * docs: add more translated content and update index.md * doc: add i18n/pt.toml * doc: change configs to use pt-br instead of pt * docs: add style-guide in pt-br * docs: small typos in pt-br * docs: small contribute in ptbr * docs: fix markdown at style-guide Co-authored-by: Seokho Son <shsongist@gmail.com> * docs: fix weight to pt-br config Co-authored-by: Seokho Son <shsongist@gmail.com> * docs: remove i18n/pt.toml Co-authored-by: Seokho Son <shsongist@gmail.com> * Add content/pt-br/application_programming_interface.md (kubernetes#437) * Add content/pt-br/application_programming_interface.md Signed-off-by: Jéssica Lins <jessicaalins@gmail.com> * Add content/pt-br/blue_green_deployment.md (kubernetes#436) * Add content/pt-br/blue_green_deployment.md Signed-off-by: Jéssica Lins <jessicaalins@gmail.com> * adding client_server_architecture localization (kubernetes#480) * Add content/pt-br/bare_metal_machine.md (kubernetes#493) * Add content/pt-br/bare_metal_machine.md * Add content/pt-br/container-image.md * Update content/pt-br/bare_metal_machine.md * Remove container-image.md * Traduzido título * Add content/pt-br/devops.md (kubernetes#478) * docs(pt-br): add content/pt-br/devops.md * Add content/pt-br/containerization.md (kubernetes#487) * docs: add containerization.md localization to ptbr * Update content/pt-br/containerization.md Co-authored-by: Jéssica Lins <jlins@redhat.com> * Update content/pt-br/containerization.md Co-authored-by: Jéssica Lins <jlins@redhat.com> * Update content/pt-br/containerization.md Co-authored-by: Jéssica Lins <jlins@redhat.com> Co-authored-by: Jéssica Lins <jlins@redhat.com> * Add content/pt-br/cluster.md (kubernetes#486) * docs: add cluster.md localization to ptbr * docs: add cluster.md localization to ptbr * Apply suggested reviews Co-authored-by: Jéssica Lins <jlins@redhat.com> Co-authored-by: Jéssica Lins <jlins@redhat.com> * Add content/pt-br/container.md (kubernetes#485) * docs: add container.md localization to ptbr * feat: improve some sentences * Add content/pt-br/cloud_native_apps.md (kubernetes#596) * Add content/pt-br/bare_metal_machine.md * Add content/pt-br/container-image.md * Update content/pt-br/bare_metal_machine.md * Remove container-image.md * Traduzido título * Remove bare_metal_machine.md * Add content/pt-br/cloud_native_apps.md * Add content/pt-br/container-image.md (kubernetes#557) * Add content/pt-br/bare_metal_machine.md * Add content/pt-br/container-image.md * Update content/pt-br/bare_metal_machine.md * Remove container-image.md * Traduzido título * Add container-image.md * Remove bare_metal_machine.md * Change from registros do contêiner to repositório de imagens * api gateway localization (kubernetes#479) * Add content/pt-br/cloud_native_security.md (kubernetes#643) * Add content/pt-br/bare_metal_machine.md * Add content/pt-br/container-image.md * Update content/pt-br/bare_metal_machine.md * Remove container-image.md * Traduzido título * Traduzido cloud_native_security * Add content/pt-br/canary_deployment.md (kubernetes#595) * Add content/pt-br/bare_metal_machine.md * Add content/pt-br/container-image.md * Update content/pt-br/bare_metal_machine.md * Remove container-image.md * Traduzido título * Remove bare_metal_machine.md * Add canary_deployment.md * Add content/pt-br/continuous_delivery.md (kubernetes#558) * Add content/pt-br/bare_metal_machine.md * Add content/pt-br/container-image.md * Update content/pt-br/bare_metal_machine.md * Remove container-image.md * Traduzido título * Remove bare_metal_machine.md * Add continuous_delivery.md * Add content/pt-br/contributor-ladder (kubernetes#662) * feat: start localization to contributor ladder * feat: add contributor ladder * docs: add more translation to contributor ladder * feat: add more translation to contributor ladder * feat: add more translation to contributor ladder * fix: fix small typos * Apply suggestions from code review Co-authored-by: Jéssica Lins <jlins@redhat.com> * feat: apply suggestions by code review * feat: change "." to ";" Co-authored-by: Jéssica Lins <jlins@redhat.com> * feat: change style guide to how to contribute and style guide (kubernetes#663) * Add content/pt-br/continuous_integration.md (kubernetes#594) * Add content/pt-br/bare_metal_machine.md * Add content/pt-br/container-image.md * Update content/pt-br/bare_metal_machine.md * Remove container-image.md * Traduzido título * Remove bare_metal_machine.md * Add continuous_integration.md * Sentence structure adjustment * [pt-BR] Add contributors names (kubernetes#671) * feat: add contributors * feat: add ptbr contributors * [pt-BR] Update config.toml (kubernetes#677) * feat: update config.toml with main * feat: translate feedback section in ptbr Co-authored-by: Seokho Son <shsongist@gmail.com> Co-authored-by: Jéssica Lins <jlins@redhat.com> Co-authored-by: Willian dos Santos <will.santos92@gmail.com> Co-authored-by: Mr. Erlison <98214640+MrErlison@users.noreply.github.com> Co-authored-by: Marcelo Mansur <mansur.ufmg@gmail.com>
* feat: start localization to contributor ladder * feat: add contributor ladder * docs: add more translation to contributor ladder * feat: add more translation to contributor ladder * feat: add more translation to contributor ladder * fix: fix small typos * Apply suggestions from code review Co-authored-by: Jéssica Lins <jlins@redhat.com> * feat: apply suggestions by code review * feat: change "." to ";" Co-authored-by: Jéssica Lins <jlins@redhat.com>
* feat: start localization to contributor ladder * feat: add contributor ladder * docs: add more translation to contributor ladder * feat: add more translation to contributor ladder * feat: add more translation to contributor ladder * fix: fix small typos * Apply suggestions from code review Co-authored-by: Jéssica Lins <jlins@redhat.com> * feat: apply suggestions by code review * feat: change "." to ";" Co-authored-by: Jéssica Lins <jlins@redhat.com>
Supercedes #656
cc @kubernetes/sig-cluster-federation @colhom @mml
Guide with steps for admin to setup federation