Skip to content
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

Merged
merged 1 commit into from
Sep 24, 2016

Conversation

nikhiljindal
Copy link
Contributor

@nikhiljindal nikhiljindal commented Sep 23, 2016

Ref #1215

cc @kubernetes/sig-cluster-federation


This change is Reviewable

@nikhiljindal
Copy link
Contributor Author

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

Copy link
Contributor

@devin-donnelly devin-donnelly left a 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:
Copy link
Contributor

Choose a reason for hiding this comment

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

Following -> The following

Copy link
Contributor Author

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/)
Copy link
Contributor

Choose a reason for hiding this comment

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

Replicasets -> ReplicaSets

Copy link
Contributor Author

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.
Copy link
Contributor

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.

Copy link
Contributor

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.")

Copy link
Contributor Author

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.
Copy link
Contributor

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."

Copy link
Contributor Author

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:
Copy link
Contributor

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.

Copy link
Contributor Author

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
Copy link
Contributor

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"

Copy link
Contributor Author

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.
Copy link
Contributor

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."

Copy link
Contributor Author

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

Copy link
Contributor

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"

Copy link
Contributor Author

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
Copy link
Contributor

@devin-donnelly devin-donnelly Sep 23, 2016

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"

Copy link
Contributor Author

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.
Copy link
Contributor

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"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

fixed

@nikhiljindal
Copy link
Contributor Author

nikhiljindal commented Sep 24, 2016

Thanks @devin-donnelly.
Updated code as per comments.

PTAL

@devin-donnelly
Copy link
Contributor

Docs LGTM. Does this need a tech review?

@devin-donnelly
Copy link
Contributor

Per my convo with Nikhil, this is okay to merge; sending to release-1.4.

@devin-donnelly devin-donnelly merged commit a6c58ae into kubernetes:release-1.4 Sep 24, 2016
@nikhiljindal
Copy link
Contributor Author

Thanks @devin-donnelly

mikutas pushed a commit to mikutas/k8s-website that referenced this pull request Sep 22, 2022
…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>
Okabe-Junya pushed a commit to Okabe-Junya/website that referenced this pull request Dec 4, 2023
Merge dev-ko into main (for Korean localization live version)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants