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

Federated Hpa feature doc #5487

Merged
merged 4 commits into from
Sep 26, 2017
Merged

Federated Hpa feature doc #5487

merged 4 commits into from
Sep 26, 2017

Conversation

irfanurrehman
Copy link
Contributor

@irfanurrehman irfanurrehman commented Sep 15, 2017

cc @kubernetes/sig-federation-pr-reviews @kubernetes/sig-federation-feature-requests
cc @quinton-hoole

Allow edits from maintainers checkbox


This change is Reviewable

@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Sep 15, 2017
@k8sio-netlify-preview-bot
Copy link
Collaborator

k8sio-netlify-preview-bot commented Sep 15, 2017

Deploy preview ready!

Built with commit 30df752

https://deploy-preview-5487--kubernetes-io-vnext-staging.netlify.com

@zacharysarah
Copy link
Contributor

@irfanurrehman 👋 I'd like to make some small edits. Would you please make sure that the box to allow edits from maintainers is checked?

@irfanurrehman
Copy link
Contributor Author

@irfanurrehman I'd like to make some small edits. Would you please make sure that the box to allow edits from maintainers is checked?

@zacharysarah apologies for missing it while raising the PR. Done now.

@ghost
Copy link

ghost commented Sep 15, 2017

Review status: 0 of 3 files reviewed at latest revision, 6 unresolved discussions.


docs/tasks/administer-federation/hpa.md, line 2 at r1 (raw file):

---
title: Federated Hpas

I'd spell it out: "Federated Horizontal Pod Autoscalers (HPA)"


docs/tasks/administer-federation/hpa.md, line 6 at r1 (raw file):

{% capture overview %}
This guide explains how to use Hpas in the Federation control plane.

HPA's ?


docs/tasks/administer-federation/hpa.md, line 65 at r1 (raw file):

Once a federated Hpa is created, the federation control plane will partition and
create an Hpa in all underlying Kubernetes clusters.

Please mention cluster selectors to restrict the clusters into which the HPA gets federated.


docs/tasks/administer-federation/hpa.md, line 118 at r1 (raw file):

## Deleting a Federated Hpa

You can delete a federated Hpa as you would delete a Kubernetes

I think it's worth mentioning that this will delete all underlying HPA's, if cascading deletion is used.


docs/tasks/administer-federation/hpa.md, line 131 at r1 (raw file):

To a `federation user` interacting with federated control plane (or simply federation),
the interaction is same as interacting with a normal k8s cluster (but with a limited set of

'almost identical' rather than 'the same'.


docs/tasks/administer-federation/hpa.md, line 146 at r1 (raw file):

they are needed most, or in other words where the load is more. Federated hpa feature
achieves this by manipulating the min and max replicas on the hpas it creates in the
federated clusters. It reduces the max and min replicas from those clusters which does

I think you need to be clearer here that the federation does not actually monitor the CPU utilization itself, but rather relies on the underlying cluster HPA's to do the auto-scaling, and only re-assigns min and max replicas between clusters in an attempt to prevent individual clusters from running up against their max replica limits. A brief example might help to clarify this.


Comments from Reviewable

@ghost
Copy link

ghost commented Sep 15, 2017

I made a few suggested edits. None of them are showstoppers, and can be addressed in a followup PR if necessary.

except in the number of min and max replicas. The federation control plane
will ensure that the sum of max replicas in each cluster matches the specified
max replicas on the federated hpa object and sum of min replicas will be greater
then or equal to the min specified on the federated hpa object. The sum of min
Copy link
Contributor

Choose a reason for hiding this comment

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

then -> than

will ensure that the sum of max replicas in each cluster matches the specified
max replicas on the federated hpa object and sum of min replicas will be greater
then or equal to the min specified on the federated hpa object. The sum of min
is greater or equal to specified min because an Hpa into a particular cluster
Copy link
Contributor

Choose a reason for hiding this comment

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

greater -> greater than


By default, first max replicas are spread equally in all the underlying clusters
and then min replicas are distributed to those clusters which got max. This means
that each cluster will get an hpa if the max replicas specified are greater then
Copy link
Contributor

Choose a reason for hiding this comment

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

are greater then -> is greater than

and then min replicas are distributed to those clusters which got max. This means
that each cluster will get an hpa if the max replicas specified are greater then
the total clusters participating in this federation and some clusters will be
skipped if max replicas specified are lesser then the total clusters participating
Copy link
Contributor

Choose a reason for hiding this comment

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

are lesser then -> is less than


To a `federation user` interacting with federated control plane (or simply federation),
the interaction is same as interacting with a normal k8s cluster (but with a limited set of
apis, that which are federated). As both deployments and horizontalpodautoscalers are
Copy link
Contributor

Choose a reason for hiding this comment

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

apis, that which are federated -> APIs that are federated

@irfanurrehman
Copy link
Contributor Author

I have updated the doc to fix the review comments.


Review status: 0 of 3 files reviewed at latest revision, 11 unresolved discussions.


docs/tasks/administer-federation/hpa.md, line 2 at r1 (raw file):

Previously, quinton-hoole (Quinton Hoole) wrote…

I'd spell it out: "Federated Horizontal Pod Autoscalers (HPA)"

Done.


docs/tasks/administer-federation/hpa.md, line 6 at r1 (raw file):

Previously, quinton-hoole (Quinton Hoole) wrote…

HPA's ?

made hpa -> HPA at all places in the doc.


docs/tasks/administer-federation/hpa.md, line 65 at r1 (raw file):

Previously, quinton-hoole (Quinton Hoole) wrote…

Please mention cluster selectors to restrict the clusters into which the HPA gets federated.

Done.


docs/tasks/administer-federation/hpa.md, line 79 at r1 (raw file):

Previously, tengqm (Qiming) wrote…

then -> than

Done.


docs/tasks/administer-federation/hpa.md, line 80 at r1 (raw file):

Previously, tengqm (Qiming) wrote…

greater -> greater than

Done.


docs/tasks/administer-federation/hpa.md, line 88 at r1 (raw file):

Previously, tengqm (Qiming) wrote…

are greater then -> is greater than

Updated the sentence, please check if still sounds wrong.


docs/tasks/administer-federation/hpa.md, line 90 at r1 (raw file):

Previously, tengqm (Qiming) wrote…

are lesser then -> is less than

Updated the sentence, please check if still sounds wrong.


docs/tasks/administer-federation/hpa.md, line 118 at r1 (raw file):

Previously, quinton-hoole (Quinton Hoole) wrote…

I think it's worth mentioning that this will delete all underlying HPA's, if cascading deletion is used.

Done.


docs/tasks/administer-federation/hpa.md, line 131 at r1 (raw file):

Previously, quinton-hoole (Quinton Hoole) wrote…

'almost identical' rather than 'the same'.

Done.


docs/tasks/administer-federation/hpa.md, line 132 at r1 (raw file):

Previously, tengqm (Qiming) wrote…

apis, that which are federated -> APIs that are federated

Done.


docs/tasks/administer-federation/hpa.md, line 146 at r1 (raw file):

Previously, quinton-hoole (Quinton Hoole) wrote…

I think you need to be clearer here that the federation does not actually monitor the CPU utilization itself, but rather relies on the underlying cluster HPA's to do the auto-scaling, and only re-assigns min and max replicas between clusters in an attempt to prevent individual clusters from running up against their max replica limits. A brief example might help to clarify this.

Done.


Comments from Reviewable

@irfanurrehman
Copy link
Contributor Author

irfanurrehman commented Sep 18, 2017

@quinton-hoole @zacharysarah
I think this PR should wait for kubernetes/kubernetes#49950 to get merged.
I believe that would happen when the code freeze is lifted.

@steveperry-53 steveperry-53 added this to the 1.8 milestone Sep 18, 2017
@ghost
Copy link

ghost commented Sep 22, 2017

The PR kubernetes/kubernetes#49950 has merged. All edits /lgtm. This can be merged.

@steveperry-53
Copy link
Contributor

I'll start a docs review now.

@steveperry-53
Copy link
Contributor

@irfanurrehman See 30df752 for suggested edits.

@steveperry-53
Copy link
Contributor

@irfanurrehman Ping. As far as I know, we're still shooting for a 9/27 release.

@ghost
Copy link

ghost commented Sep 25, 2017

Thanks @steveperry-53 . Yes, still aiming at 9/27 release. Perhaps @irfanurrehman was unaware that he was responsible for applying your edits. Is the documentation process that we should follow documented somewhere? Any pointers much appreciated.

@zacharysarah
Copy link
Contributor

zacharysarah commented Sep 25, 2017

@quinton-hoole 👋

Perhaps @irfanurrehman was unaware that he was responsible for applying your edits.

Generally, docs contributors provide reviews and perform small edits.* In the case of more extensive edits, docs contributors provide feedback for a PR owner to implement. In the case of this PR specifically, I edited 30df752 last week; Steve's feedback referenced that PR.

Is the documentation process that we should follow documented somewhere?

Not in terms of PR review. Looking at the README and the contribution guidelines, there's definitely room to set clearer expectations. I've opened an issue to improve the review process: #5620

For now, we need either:

[*]The GitHub UI has a known issue: edits from maintainers are allowed only if the PR owner un-checks and re-checks the "allow edits from maintainers" box after the PR is created.

@steveperry-53
Copy link
Contributor

@quinton-hoole @zacharysarah @irfanurrehman, We don't need anyone to check the Allow edits box, and we don't need @irfanurrehman to push anything. I already pushed a commit with suggested edits. All we need is for someone to agree to what I've done in 30df752.

@ghost
Copy link

ghost commented Sep 25, 2017

@steveperry-53 Yes, thanks, 30df752 looks fine.

/lgtm

Let me know if you need us to do anything else.

@steveperry-53
Copy link
Contributor

Reviewed 2 of 3 files at r1, 1 of 1 files at r4.
Review status: all files reviewed at latest revision, 11 unresolved discussions.


Comments from Reviewable

@steveperry-53
Copy link
Contributor

steveperry-53 commented Sep 26, 2017

@quinton-hoole Thanks for the lgtm.

@quinton-hoole, @zacharysarah Can one of you help get the code-review/reviewable to be green. To this day, I am mystified by Reviewable. Thanks. And if this isn't easy, I'm happy to merge this without a green check on the Reviewable line.

@steveperry-53
Copy link
Contributor

:lgtm:


Review status: all files reviewed at latest revision, 12 unresolved discussions.


Comments from Reviewable

@steveperry-53 steveperry-53 merged commit ff6d284 into kubernetes:release-1.8 Sep 26, 2017
steveperry-53 added a commit that referenced this pull request Sep 29, 2017
* GC now supports non-core resources

* Add two examples about how to analysis audits of kube-apiserver (#4264)

* Deprecate system:nodes binding

* [1.8] StatefulSet `initialized` annotation is now ignored.

* inits the kubeadm upgrade docs

addresses /issues/4689

* adds kubeadm upgrade cmd to ToC

addresses /issues/4689

* add workload placement docs

* ScaleIO - document udpate for 1.8

* Add documentation on storageClass.mountOptions and PV.mountOptions (#5254)

* Add documentation on storageClass.mountOptions and PV.mountOptions

* convert notes into callouts

* Add docs for CustomResource validation

add info about supported fields

* advanced audit beta features (#5300)

* Update job workload doc with backoff failure policy (#5319)

Add to the Jobs documentation how to use the new backoffLimit field that
limit the number of Pod failure before considering the Job as failed.

* Documented additional AWS Service annotations (#4864)

* Add device plugin doc under concepts/cluster-administration. (#5261)

* Add device plugin doc under concepts/cluster-administration.

* Update device-plugins.md

* Update device-plugins.md

Add meta description. Fix typo. Change bare metal deployment to manual deployment.

* Update device-plugins.md

Fix typo again.

* Update page.version. (#5341)

* Add documentation on storageClass.reclaimPolicy (#5171)

* [Advanced audit] use new herf for audit-api (#5349)

This tag contains all the changes in v1beta1 version. Update it now.

* Added documentation around creating the InitializerConfiguration for the persistent volume label controller in the cloud-controller-manager (#5255)

* Documentation for kubectl plugins (#5294)

* Documentation for kubectl plugins

* Update kubectl-plugins.md

* Update kubectl-plugins.md

* Updated CPU manager docs to match implementation. (#5332)

* Noted limitation of alpha static cpumanager.

* Updated CPU manager docs to match implementation.

- Removed references to CPU pressure node condition and evictions.
- Added note about new --cpu-manager-reconcile-period flag.
- Added note about node allocatable requirements for static policy.
- Noted limitation of alpha static cpumanager.

* Move cpu-manager task link to rsc mgmt section.

* init containers annotation removed in  1.8 (#5390)

* Add documentation for TaintNodesByCondition (#5352)

* Add documentation for TaintNodesByCondition

* Update nodes.md

* Update taint-and-toleration.md

* Update daemonset.md

* Update nodes.md

* Update taint-and-toleration.md

* Update daemonset.md

* Fix deployments (#5421)

* Document extended resources and OIR deprecation. (#5399)

* Document extended resources and OIR deprecation.

* Updated extended resources doc per reviews.

* reverts extra spacing in _data/tasks.yml

* addresses `kubeadm upgrade` review comments

Feedback from @chenopis, @luxas, and @steveperry-53 addressed with this commit

* HugePages documentation (#5419)

* Update cpu-management-policies.md (#5407)

Fixed the bad link.
Modified "cpu" to "CPU".
Added more 'yaml' as supplement.

* Update RBAC docs for v1 (#5445)

* Add user docs for pod priority and preemption (#5328)

* Add user docs for pod priority and preemption

* Update pod-priority-preemption.md

* More updates

* Update docs/admin/kubeadm.md for 1.8 (#5440)

- Made a couple of minor wording changes (not strictly 1.8 related).
 - Did some reformatting (not strictly 1.8 related).
 - Updated references to the default token TTL (was infinite, now 24 hours).
 - Documented the new `--discovery-token-ca-cert-hash` and `--discovery-token-unsafe-skip-ca-verification` flags for `kubeadm join`.
 - Added references to the new `--discovery-token-ca-cert-hash` flag in all the default examples.
 - Added a new _Security model_ section that describes the security tradeoffs of the various discovery modes.
 - Documented the new `--groups` flag for `kubeadm token create`.
 - Added a note of caution under _Automating kubeadm_ that references the _Security model_ section.
 - Updated the component version table to drop 1.6 and add 1.8.
 - Update `_data/reference.yml` to try to get the sidebar fixed up and more consistent with `kubefed`.

* Update StatefulSet Basics for 1.8 release (#5398)

* addresses `kubeadm upgrade` review comments

2nd iteration review comments by @luxas

* adds kubelet upgrade section to kubeadm upgrade

* Fix a bulleted list on docs/admin/kubeadm.md. (#5458)

I updated this doc yesterday and I was absolutely sure I fixed this, but I just saw that this commit got lost somehow.

This was introduced recently in #5440.

* Clarify the API to check for device plugins

* Moving Flexvolume to separate out-of-tree section

* addresses `kubeadm upgrade` review comments

CC: @luxas

* fixes kubeadm upgrade index

* Update Stackdriver Logging documentation (#5495)

* Re-update WordPress and MySQL PV doc to use apps/v1beta2 APIs (#5526)

* Update statefulset concepts doc to use apps/v1beta2 APIs (#5420)

* add document on kubectl's behavior regarding initializers (#5505)

* Update docs/admin/kubeadm.md to cover self-hosting in 1.8. (#5497)

This is a new beta feature in 1.8.

* Update kubectl patch doc to use apps/v1beta2 APIs (#5422)

* [1.8] Update "Run Applications" tasks to apps/v1beta2. (#5525)

* Update replicated stateful application task for 1.8.

* Update single instance stateful app task for 1.8.

* Update stateless app task for 1.8.

* Update kubectl patch task for 1.8.

* fix the link of persistent storage (#5515)

* update the admission-controllers.md index.md what-is-kubernetes.md link

* fix the link of persistent storage

* Add quota support for local ephemeral storage (#5493)

* Add quota support for local ephemeral storage

update the doc to this alpha feature

* Update resource-quotas.md

* Updated Deployments concepts doc (#5491)

* Updated Deployments concepts doc

* Addressed comments

* Addressed more comments

* Modify allocatable storage to ephemeral-storage (#5490)

Update the doc to use ephemeral-storage instead of storage

* Revamped concepts doc for ReplicaSet (#5463)

* Revamped concepts doc for ReplicaSet

* Minor changes to call out specific versions for selector defaulting and
immutability

* Addressed doc review comments

* Remove petset documentations (#5395)

* Update docs to use batch/v1beta1 cronjobs (#5475)

* add federation job doc (#5485)

* add federation job doc

* Update job.md

Edits for clarity and consistency

* Update job.md

Fixed a typo

* update DaemonSet concept for 1.8 release (#5397)

* update DaemonSet concept for 1.8 release

* Update daemonset.md

Fix typo. than -> then

* Update bootstrap tokens doc for 1.8. (#5479)

* Update bootstrap tokens doc for 1.8.

This has some changes I missed when I was updating the main kubeadm documention:
 - Bootstrap tokens are now beta, not alpha (kubernetes/enhancements#130)
 - The apiserver flag to enable the authenticator changedin 1.8 (kubernetes/kubernetes#51198)
 - Added `auth-extra-groups` documentaion (kubernetes/kubernetes#50933)
 - Updated the _Token Management with `kubeadm`_ section to link to the main kubeadm docs, since it was just duplicated information.

* Update bootstrap-tokens.md

* Updated the Cassandra tutorial to use apps/v1beta2 (#5548)

* add docs for AllowPrivilegeEscalation (#5448)

Signed-off-by: Jess Frazelle <[email protected]>

* Add local ephemeral storage alpha feature in managing compute resource (#5522)

* Add local ephemeral storage alpha feature in managing compute resource

Since 1.8, we add the local ephemeral storage alpha feature as one
resource type to manage. Add this feature into the doc.

* Update manage-compute-resources-container.md

* Update manage-compute-resources-container.md

* Update manage-compute-resources-container.md

* Update manage-compute-resources-container.md

* Update manage-compute-resources-container.md

* Update manage-compute-resources-container.md

* Added documentation for Metrics Server (#5560)

* authorization: improve authorization debugging docs (#5549)

* Document mount propagation (#5544)

* Update /docs/setup/independent/create-cluster-kubeadm.md for 1.8. (#5524)

This introduction needed a couple of small tweaks to cover the `--discovery-token-ca-cert-hash` flag added in kubernetes/kubernetes#49520 and some version bumps.

* Add task doc for alpha dynamic kubelet configuration (#5523)

* Fix input/output of selfsubjectaccess review (#5593)

* Add docs for implementing resize (#5528)

* Add docs for implementing resize

* Update admission-controllers.md

* Added link to PVC section

* minor typo fixes

* Update NetworkPolicy concept guide with egress and CIDR changes (#5529)

* update zookeeper tutorial for 1.8 release

* add doc for hostpath type (#5503)

* Federated Hpa feature doc (#5487)

* Federated Hpa feature doc

* Federated Hpa feature doc review fixes

* Update hpa.md

* Update hpa.md

* update cloud controller manager docs for v1.8

* Update cronjob with defaults information (#5556)

* Kubernetes 1.8 reference docs (#5632)

* Kubernetes 1.8 reference docs

* Kubectl reference docs for 1.8

* Update side bar with 1.8 kubectl and api ref docs links

* remove petset.md

* update on state of HostAlias in 1.8 with hostNetwork Pod support (#5644)

* Fix cron job deletion section (#5655)

* update imported docs (#5656)

* Add documentation for certificate rotation. (#5639)

* Link to using kubeadm page

* fix the command output

fix the command output

* fix typo in api/resources reference: "Worloads"

* Add documentation for certificate rotation.

* Create TOC entry for cloud controller manager. (#5662)

* Updates for new versions of API types

* Followup 5655: fix link to garbage collection (#5666)

* Temporarily redirect resources-reference to api-reference. (#5668)

* Update config for 1.8 release. (#5661)

* Update config for 1.8 release.

* Address reviewer comments.

* Switch references in HPA docs from alpha to beta (#5671)

The HPA docs still referenced the alpha version.  This switches them to
talk about v2beta1, which is the appropriate version for Kubernetes 1.8

* Deprecate openstack heat (#5670)

* Fix typo in pod preset conflict example

Move container port definition to the correct line.

* Highlight openstack-heat provider deprecation

The openstack-heat provider for kube-up is being deprecated and will be
removed in a future release.

* Temporarily fix broken links by redirecting. (#5672)

* Fix broken links. (#5675)

* Fix render of code block (#5674)

* Fix broken links. (#5677)

* Add a small note about auto-bootstrapped CSR ClusterRoles (#5660)

* Update kubeadm install doc for v1.8 (#5676)

* add draft workloads api content for 1.8 (#5650)

* add draft workloads api content for 1.8

* edits per review, add tables, for 1.8 workloads api doc

* fix typo

* Minor fixes to kubeadm 1.8 upgrade guide. (#5678)

- The kubelet upgrade instructions should be done on every host, not
  just worker nodes.
- We should just upgrade all packages, instead of calling out kubelet
  specifically. This will also upgrade kubectl, kubeadm, and
  kubernetes-cni, if installed.
- Draining nodes should also ignore daemonsets, and master errors can be
  ignored.
- Make sure that the new kubeadm download is chmoded correctly.
- Add a step to run `kubeadm version` to verify after downloading.
- Manually approve new kubelet CSRs if rotation is enabled (known issue).

* Release 1.8 (#5680)

* Fix versions for 1.8 API ref docs

* Updates for 1.8 kubectl reference docs

* Kubeadm /docs/admin/kubeadm.md cleanup, editing. (#5681)

* Update docs/admin/kubeadm.md (mostly 1.8 related).

This is Fabrizio's work, which I'm committing along with my edits (in a commit on top of this).

* A few of my own edits to clarify and clean up some Markdown.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants