mirror of
https://github.com/rancher/rancher-docs.git
synced 2026-10-11 12:26:04 +00:00
1 line
8.7 KiB
JavaScript
1 line
8.7 KiB
JavaScript
"use strict";(self.webpackChunkrancher_docs=self.webpackChunkrancher_docs||[]).push([[83470],{3905:(e,t,o)=>{o.d(t,{Zo:()=>c,kt:()=>m});var r=o(67294);function a(e,t,o){return t in e?Object.defineProperty(e,t,{value:o,enumerable:!0,configurable:!0,writable:!0}):e[t]=o,e}function n(e,t){var o=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),o.push.apply(o,r)}return o}function s(e){for(var t=1;t<arguments.length;t++){var o=null!=arguments[t]?arguments[t]:{};t%2?n(Object(o),!0).forEach((function(t){a(e,t,o[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(o)):n(Object(o)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(o,t))}))}return e}function l(e,t){if(null==e)return{};var o,r,a=function(e,t){if(null==e)return{};var o,r,a={},n=Object.keys(e);for(r=0;r<n.length;r++)o=n[r],t.indexOf(o)>=0||(a[o]=e[o]);return a}(e,t);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);for(r=0;r<n.length;r++)o=n[r],t.indexOf(o)>=0||Object.prototype.propertyIsEnumerable.call(e,o)&&(a[o]=e[o])}return a}var i=r.createContext({}),u=function(e){var t=r.useContext(i),o=t;return e&&(o="function"==typeof e?e(t):s(s({},t),e)),o},c=function(e){var t=u(e.components);return r.createElement(i.Provider,{value:t},e.children)},p={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},d=r.forwardRef((function(e,t){var o=e.components,a=e.mdxType,n=e.originalType,i=e.parentName,c=l(e,["components","mdxType","originalType","parentName"]),d=u(o),m=a,h=d["".concat(i,".").concat(m)]||d[m]||p[m]||n;return o?r.createElement(h,s(s({ref:t},c),{},{components:o})):r.createElement(h,s({ref:t},c))}));function m(e,t){var o=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var n=o.length,s=new Array(n);s[0]=d;var l={};for(var i in t)hasOwnProperty.call(t,i)&&(l[i]=t[i]);l.originalType=e,l.mdxType="string"==typeof e?e:a,s[1]=l;for(var u=2;u<n;u++)s[u]=o[u];return r.createElement.apply(null,s)}return r.createElement.apply(null,o)}d.displayName="MDXCreateElement"},39380:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>i,contentTitle:()=>s,default:()=>p,frontMatter:()=>n,metadata:()=>l,toc:()=>u});var r=o(87462),a=(o(67294),o(3905));const n={title:"Background Information on HPAs"},s=void 0,l={unversionedId:"how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/about-hpas",id:"version-2.0-2.4/how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/about-hpas",title:"Background Information on HPAs",description:"The Horizontal Pod Autoscaler (HPA) is a Kubernetes feature that allows you to configure your cluster to automatically scale the services it's running up or down. This section provides explanation on how HPA works with Kubernetes.",source:"@site/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/about-hpas.md",sourceDirName:"how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler",slug:"/how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/about-hpas",permalink:"/v2.0-v2.4/how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/about-hpas",draft:!1,editUrl:"https://github.com/rancher/rancher-docs/edit/main/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/about-hpas.md",tags:[],version:"2.0-2.4",lastUpdatedAt:1663953084,formattedLastUpdatedAt:"Sep 23, 2022",frontMatter:{title:"Background Information on HPAs"},sidebar:"tutorialSidebar",previous:{title:"Manual HPA Installation for Clusters Created Before Rancher v2.0.7",permalink:"/v2.0-v2.4/how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/hpa-for-rancher-before-2.0.7"},next:{title:"Managing HPAs with the Rancher UI",permalink:"/v2.0-v2.4/how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/manage-hpas-with-ui"}},i={},u=[{value:"Why Use Horizontal Pod Autoscaler?",id:"why-use-horizontal-pod-autoscaler",level:2},{value:"How HPA Works",id:"how-hpa-works",level:2},{value:"Horizontal Pod Autoscaler API Objects",id:"horizontal-pod-autoscaler-api-objects",level:2}],c={toc:u};function p(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,"The ",(0,a.kt)("a",{parentName:"p",href:"https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/"},"Horizontal Pod Autoscaler")," (HPA) is a Kubernetes feature that allows you to configure your cluster to automatically scale the services it's running up or down. This section provides explanation on how HPA works with Kubernetes."),(0,a.kt)("h2",{id:"why-use-horizontal-pod-autoscaler"},"Why Use Horizontal Pod Autoscaler?"),(0,a.kt)("p",null,"Using HPA, you can automatically scale the number of pods within a replication controller, deployment, or replica set up or down. HPA automatically scales the number of pods that are running for maximum efficiency. Factors that affect the number of pods include:"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"A minimum and maximum number of pods allowed to run, as defined by the user."),(0,a.kt)("li",{parentName:"ul"},"Observed CPU/memory use, as reported in resource metrics."),(0,a.kt)("li",{parentName:"ul"},"Custom metrics provided by third-party metrics application like Prometheus, Datadog, etc.")),(0,a.kt)("p",null,"HPA improves your services by:"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Releasing hardware resources that would otherwise be wasted by an excessive number of pods."),(0,a.kt)("li",{parentName:"ul"},"Increase/decrease performance as needed to accomplish service level agreements.")),(0,a.kt)("h2",{id:"how-hpa-works"},"How HPA Works"),(0,a.kt)("p",null,(0,a.kt)("img",{alt:"HPA Schema",src:o(5276).Z,width:"1200",height:"862"})),(0,a.kt)("p",null,"HPA is implemented as a control loop, with a period controlled by the ",(0,a.kt)("inlineCode",{parentName:"p"},"kube-controller-manager")," flags below:"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:null},"Flag"),(0,a.kt)("th",{parentName:"tr",align:null},"Default"),(0,a.kt)("th",{parentName:"tr",align:null},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("inlineCode",{parentName:"td"},"--horizontal-pod-autoscaler-sync-period")),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("inlineCode",{parentName:"td"},"30s")),(0,a.kt)("td",{parentName:"tr",align:null},"How often HPA audits resource/custom metrics in a deployment.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("inlineCode",{parentName:"td"},"--horizontal-pod-autoscaler-downscale-delay")),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("inlineCode",{parentName:"td"},"5m0s")),(0,a.kt)("td",{parentName:"tr",align:null},"Following completion of a downscale operation, how long HPA must wait before launching another downscale operations.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("inlineCode",{parentName:"td"},"--horizontal-pod-autoscaler-upscale-delay")),(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("inlineCode",{parentName:"td"},"3m0s")),(0,a.kt)("td",{parentName:"tr",align:null},"Following completion of an upscale operation, how long HPA must wait before launching another upscale operation.")))),(0,a.kt)("p",null,"For full documentation on HPA, refer to the ",(0,a.kt)("a",{parentName:"p",href:"https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/"},"Kubernetes Documentation"),"."),(0,a.kt)("h2",{id:"horizontal-pod-autoscaler-api-objects"},"Horizontal Pod Autoscaler API Objects"),(0,a.kt)("p",null,"HPA is an API resource in the Kubernetes ",(0,a.kt)("inlineCode",{parentName:"p"},"autoscaling")," API group. The current stable version is ",(0,a.kt)("inlineCode",{parentName:"p"},"autoscaling/v1"),", which only includes support for CPU autoscaling. To get additional support for scaling based on memory and custom metrics, use the beta version instead: ",(0,a.kt)("inlineCode",{parentName:"p"},"autoscaling/v2beta1"),"."),(0,a.kt)("p",null,"For more information about the HPA API object, see the ",(0,a.kt)("a",{parentName:"p",href:"https://git.k8s.io/community/contributors/design-proposals/autoscaling/horizontal-pod-autoscaler.md#horizontalpodautoscaler-object"},"HPA GitHub Readme"),"."))}p.isMDXComponent=!0},5276:(e,t,o)=>{o.d(t,{Z:()=>r});const r=o.p+"assets/images/horizontal-pod-autoscaler-73e94153b61adc40a276899a326addc9.jpg"}}]); |