mirror of
https://github.com/rancher/rancher-docs.git
synced 2026-11-09 10:19:16 +00:00
1 line
9.7 KiB
JavaScript
1 line
9.7 KiB
JavaScript
"use strict";(self.webpackChunkrancher_docs=self.webpackChunkrancher_docs||[]).push([[19123],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>m});var a=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function i(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?o(Object(n),!0).forEach((function(t){r(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):o(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function l(e,t){if(null==e)return{};var n,a,r=function(e,t){if(null==e)return{};var n,a,r={},o=Object.keys(e);for(a=0;a<o.length;a++)n=o[a],t.indexOf(n)>=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a<o.length;a++)n=o[a],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var s=a.createContext({}),d=function(e){var t=a.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},p=function(e){var t=d(e.components);return a.createElement(s.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},c=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,o=e.originalType,s=e.parentName,p=l(e,["components","mdxType","originalType","parentName"]),c=d(n),m=r,g=c["".concat(s,".").concat(m)]||c[m]||u[m]||o;return n?a.createElement(g,i(i({ref:t},p),{},{components:n})):a.createElement(g,i({ref:t},p))}));function m(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=n.length,i=new Array(o);i[0]=c;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l.mdxType="string"==typeof e?e:r,i[1]=l;for(var d=2;d<o;d++)i[d]=n[d];return a.createElement.apply(null,i)}return a.createElement.apply(null,n)}c.displayName="MDXCreateElement"},88323:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>i,default:()=>u,frontMatter:()=>o,metadata:()=>l,toc:()=>d});var a=n(87462),r=(n(67294),n(3905));const o={title:"HTTP Proxy Configuration"},i=void 0,l={unversionedId:"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/rke-add-on/proxy",id:"version-2.0-2.4/getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/rke-add-on/proxy",title:"HTTP Proxy Configuration",description:"#### Important: RKE add-on install is only supported up to Rancher v2.0.8",source:"@site/versioned_docs/version-2.0-2.4/getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/rke-add-on/proxy.md",sourceDirName:"getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/rke-add-on",slug:"/getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/rke-add-on/proxy",permalink:"/v2.0-v2.4/getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/rke-add-on/proxy",draft:!1,editUrl:"https://github.com/rancher/rancher-docs/edit/main/versioned_docs/version-2.0-2.4/getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/rke-add-on/proxy.md",tags:[],version:"2.0-2.4",lastUpdatedAt:1663953084,formattedLastUpdatedAt:"Sep 23, 2022",frontMatter:{title:"HTTP Proxy Configuration"},sidebar:"tutorialSidebar",previous:{title:"NGINX Configuration",permalink:"/v2.0-v2.4/getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/rke-add-on/layer-7-lb/nginx"},next:{title:"Enable API Auditing",permalink:"/v2.0-v2.4/getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/helm2/rke-add-on/api-auditing"}},s={},d=[{value:"Kubernetes installation",id:"kubernetes-installation",level:2}],p={toc:d};function u(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("blockquote",null,(0,r.kt)("h4",{parentName:"blockquote",id:"important-rke-add-on-install-is-only-supported-up-to-rancher-v208"},(0,r.kt)("strong",{parentName:"h4"},"Important: RKE add-on install is only supported up to Rancher v2.0.8")),(0,r.kt)("p",{parentName:"blockquote"},"Please use the Rancher Helm chart to install Rancher on a Kubernetes cluster. For details, see the ",(0,r.kt)("a",{parentName:"p",href:"/v2.0-v2.4/getting-started/installation-and-upgrade/resources/choose-a-rancher-version"},"Kubernetes Install "),"."),(0,r.kt)("p",{parentName:"blockquote"},"If you are currently using the RKE add-on install method, see ",(0,r.kt)("a",{parentName:"p",href:"/v2.0-v2.4/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades/migrating-from-rke-add-on"},"Migrating from a Kubernetes Install with an RKE Add-on")," for details on how to move to using the helm chart.")),(0,r.kt)("p",null,"If you operate Rancher behind a proxy and you want to access services through the proxy (such as retrieving catalogs), you must provide Rancher information about your proxy. As Rancher is written in Go, it uses the common proxy environment variables as shown below."),(0,r.kt)("p",null,"Make sure ",(0,r.kt)("inlineCode",{parentName:"p"},"NO_PROXY")," contains the network addresses, network address ranges and domains that should be excluded from using the proxy."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Environment variable"),(0,r.kt)("th",{parentName:"tr",align:null},"Purpose"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"HTTP_PROXY"),(0,r.kt)("td",{parentName:"tr",align:null},"Proxy address to use when initiating HTTP connection(s)")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"HTTPS_PROXY"),(0,r.kt)("td",{parentName:"tr",align:null},"Proxy address to use when initiating HTTPS connection(s)")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"NO_PROXY"),(0,r.kt)("td",{parentName:"tr",align:null},"Network address(es), network address range(s) and domains to exclude from using the proxy when initiating connection(s)")))),(0,r.kt)("blockquote",null,(0,r.kt)("p",{parentName:"blockquote"},(0,r.kt)("strong",{parentName:"p"},"Note")," NO_PROXY must be in uppercase to use network range (CIDR) notation.")),(0,r.kt)("h2",{id:"kubernetes-installation"},"Kubernetes installation"),(0,r.kt)("p",null,"When using Kubernetes installation, the environment variables need to be added to the RKE Config File template."),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/v2.0-v2.4/pages-for-subheaders/helm2-rke-add-on-layer-4-lb#5-download-rke-config-file-template"},"Kubernetes Installation with External Load Balancer (TCP/Layer 4) RKE Config File Template")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/v2.0-v2.4/pages-for-subheaders/helm2-rke-add-on-layer-7-lb#5-download-rke-config-file-template"},"Kubernetes Installation with External Load Balancer (HTTPS/Layer 7) RKE Config File Template"))),(0,r.kt)("p",null,"The environment variables should be defined in the ",(0,r.kt)("inlineCode",{parentName:"p"},"Deployment")," inside the RKE Config File Template. You only have to add the part starting with ",(0,r.kt)("inlineCode",{parentName:"p"},"env:")," to (but not including) ",(0,r.kt)("inlineCode",{parentName:"p"},"ports:"),". Make sure the indentation is identical to the preceding ",(0,r.kt)("inlineCode",{parentName:"p"},"name:"),". Required values for ",(0,r.kt)("inlineCode",{parentName:"p"},"NO_PROXY")," are:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"localhost")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"127.0.0.1")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"0.0.0.0")),(0,r.kt)("li",{parentName:"ul"},"Configured ",(0,r.kt)("inlineCode",{parentName:"li"},"service_cluster_ip_range")," (default: ",(0,r.kt)("inlineCode",{parentName:"li"},"10.43.0.0/16"),")")),(0,r.kt)("p",null,"The example below is based on a proxy server accessible at ",(0,r.kt)("inlineCode",{parentName:"p"},"http://192.168.0.1:3128"),", and excluding usage of the proxy when accessing network range ",(0,r.kt)("inlineCode",{parentName:"p"},"192.168.10.0/24"),", the configured ",(0,r.kt)("inlineCode",{parentName:"p"},"service_cluster_ip_range")," (",(0,r.kt)("inlineCode",{parentName:"p"},"10.43.0.0/16"),") and every hostname under the domain ",(0,r.kt)("inlineCode",{parentName:"p"},"example.com"),". If you have changed the ",(0,r.kt)("inlineCode",{parentName:"p"},"service_cluster_ip_range"),", you have to update the value below accordingly."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-yaml"},'...\n---\n kind: Deployment\n apiVersion: extensions/v1beta1\n metadata:\n namespace: cattle-system\n name: cattle\n spec:\n replicas: 1\n template:\n metadata:\n labels:\n app: cattle\n spec:\n serviceAccountName: cattle-admin\n containers:\n - image: rancher/rancher:latest\n imagePullPolicy: Always\n name: cattle-server\n env:\n - name: HTTP_PROXY\n value: "http://192.168.10.1:3128"\n - name: HTTPS_PROXY\n value: "http://192.168.10.1:3128"\n - name: NO_PROXY\n value: "localhost,127.0.0.1,0.0.0.0,10.43.0.0/16,192.168.10.0/24,example.com"\n ports:\n...\n')))}u.isMDXComponent=!0}}]); |