-
Notifications
You must be signed in to change notification settings - Fork 14.5k
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
federation: Adding user guides for federation replicasets and secrets #1290
federation: Adding user guides for federation replicasets and secrets #1290
Conversation
Both of these are very similar to the existing federation namespaces guide: https://github.com/kubernetes/kubernetes.github.io/blob/release-1.4/docs/user-guide/federation/namespaces.md |
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.
Some docs stuff to address--mostly small, nothing heavily structural.
@@ -36,9 +36,11 @@ Once we have the control plane setup, we can start creating federation API | |||
resources. | |||
Following guides explain some of the resources in detail: |
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.
Following -> The following
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
* [Events](/docs/user-guide/federation/events/) | ||
* [Namespaces](/docs/user-guide/federation/namespaces/) | ||
* [Replicasets](/docs/user-guide/federation/replicasets/) |
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.
Replicasets -> ReplicaSets
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
--- | ||
--- | ||
|
||
This guide explains how to use replicasets in Federation control plane. |
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.
replicasets -> ReplicaSets
This should be a global replacement.
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.
Also, "Federation control plane" -> "the Federation control plane" (or "a Federated control plane.")
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
|
||
Replicasets in federation control plane (referred to as "federated replicasets" in | ||
this guide) are very similar to the traditional [Kubernetes | ||
Replicasets](/docs/user-guide/replicasets/) providing the same functionality. |
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.
"providing the same functionality" -> ", and provide the same functionality."
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
API for traditional Kubernetes Replicaset. You can create a replicaset by sending | ||
a request to the federation apiserver. | ||
|
||
You can do that using kubectl by running: |
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.
Link "kubectl" to the kubectl 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.
fixed
|
||
## Deleting a Federated Replicaset | ||
|
||
You can delete a federated replicaset as you would delete a Kubernetes |
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.
Same as above edit on "Updating"
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
|
||
Note that at this point, deleting a federated replicaset will not delete the | ||
corresponding replicasets from underlying clusters. | ||
Users are expected to delete them manually. |
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.
"Users are expected to" -> "You must delete the underlying ReplicaSets manually."
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
|
||
|
||
## Updating a Federated Secret | ||
|
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.
Same edit as "Updating a Federated ReplicaSet"
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
updated, it updates the corresponding secrets in all underlying clusters to | ||
match it. | ||
|
||
## Deleting a Federated Secret |
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.
Same edit as "Deleting a Federated ReplicaSet"
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
|
||
Note that at this point, deleting a federated secret will not delete the | ||
corresponding secrets from underlying clusters. | ||
Users are expected to delete them manually. |
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.
Same edit as in "Deleted a Federated ReplicaSet"
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
c7e4acd
to
bed0355
Compare
bed0355
to
d376fc9
Compare
Thanks @devin-donnelly. PTAL |
Docs LGTM. Does this need a tech review? |
Per my convo with Nikhil, this is okay to merge; sending to release-1.4. |
Thanks @devin-donnelly |
…tes#1290) This back-ports the install instructions from the 2.12 branch (kubernetes#1244) into the 2.11 branch, specifically for the edge helm charts. Co-authored-by: cpretzer <cpretzer@users.noreply.github.com>
Merge dev-ko into main (for Korean localization live version)
Ref #1215
cc @kubernetes/sig-cluster-federation
This change is