1"use strict";(self.webpackChunkspectro_cloud_docs=self.webpackChunkspectro_cloud_docs||[]).push([["13543"],{896185:function(e,n,t){t.r(n),t.d(n,{frontMatter:()=>s,toc:()=>d,default:()=>u,metadata:()=>o,assets:()=>l,contentTitle:()=>a});var o=JSON.parse('{"id":"clusters/edge/edge-configuration/edge-configuration","title":"Install Configuration","description":"Learn about the possible Palette Edge install configurations available.","source":"@site/docs/docs-content/clusters/edge/edge-configuration/edge-configuration.md","sourceDirName":"clusters/edge/edge-configuration","slug":"/clusters/edge/edge-configuration/","permalink":"/clusters/edge/edge-configuration/","draft":false,"unlisted":false,"editUrl":"https://github.com/spectrocloud/librarium/blob/master/docs/docs-content/clusters/edge/edge-configuration/edge-configuration.md","tags":[{"inline":true,"label":"edge","permalink":"/tags/edge"}],"version":"current","lastUpdatedAt":1777826507000,"frontMatter":{"sidebar_label":"Install Configuration","title":"Install Configuration","description":"Learn about the possible Palette Edge install configurations available.","hide_table_of_contents":false,"tags":["edge"]},"sidebar":"docSidebar","previous":{"title":"Update Cluster","permalink":"/clusters/edge/trusted-boot/deployment-day2/upgrade-cluster"},"next":{"title":"Cloud Init Stages","permalink":"/clusters/edge/edge-configuration/cloud-init"}}'),r=t(474848),i=t(884429);let s={sidebar_label:"Install Configuration",title:"Install Configuration",description:"Learn about the possible Palette Edge install configurations available.",hide_table_of_contents:!1,tags:["edge"]},a,l={},d=[{value:"Order of Operations",id:"order-of-operations",level:3},{value:"Edge Installer Configuration",id:"edge-installer-configuration",level:2},{value:"Installer Example Configuration",id:"installer-example-configuration",level:2},{value:"Additional Configurations",id:"additional-configurations",level:2},{value:"Resources",id:"resources",level:2}];function c(e){let n={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",img:"img",li:"li",ol:"ol",p:"p",pre:"pre",ul:"ul",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsxs)(n.p,{children:["The Edge Installer is responsible for preparing the Edge host to be ready for assignment to cluster workloads. The Edge\nInstaller supports the ability to specify a configuration file named ",(0,r.jsx)(n.code,{children:"user-data"}),". You can use this configuration file to\ncustomize the installation and ensure your Edge host has all the required dependencies and settings to work properly in\nyour environment. For more information about all the available parameters in the installer configuration, refer to\n",(0,r.jsx)(n.a,{href:"/clusters/edge/edge-configuration/installer-reference",children:"Installer Reference"}),"."]}),"\n",(0,r.jsx)(n.p,{children:"To better understand the Edge installation process, review the order of operations from installation to Edge host\nregistration."}),"\n",(0,r.jsx)(n.h3,{id:"order-of-operations",children:"Order of Operations"}),"\n",(0,r.jsxs)(n.ol,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:"Boot device with Edge Installer."}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:"Edge Installer installs Palette Edge onto the Edge host."}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:"Device powers off or reboots to registration mode based on the user data configuration."}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:["Upon boot up or reboot, cloud-init stages that are specified in the ",(0,r.jsx)(n.code,{children:"user-data"})," file take effect."]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:"Edge Host Registers with Palette and is ready to be part of a cluster."}),"\n"]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.img,{alt:"The boot order sequence, listing steps that flow in a sequential order.",src:t(319406).A+"",width:"1515",height:"890"})}),"\n",(0,r.jsxs)(n.p,{children:["Palette Edge allows you to use cloud-init stages to declaratively configure your Operating System (OS) of your Edge host\nboth using the installer configuration ",(0,r.jsx)(n.code,{children:"user-data"})," file and in the OS pack. For more information about cloud-init\nstages, refer to ",(0,r.jsx)(n.a,{href:"/clusters/edge/edge-configuration/cloud-init",children:"Cloud-init Stages"}),"."]}),"\n",(0,r.jsx)(n.h2,{id:"edge-installer-configuration",children:"Edge Installer Configuration"}),"\n",(0,r.jsxs)(n.p,{children:["The Edge installation process expects you to specify installation parameters. You can supply the install parameters in\nmultiple stages. You can provide common installation configurations during EdgeForge for all your sites during the\nmanufacturing or provide site-specific configuration during on-site deployment. For more information, refer to\n",(0,r.jsx)(n.a,{href:"/clusters/edge/edgeforge-workflow/prepare-user-data",children:"Prepare User Data"})," and\n",(0,r.jsx)(n.a,{href:"/clusters/edge/site-deployment/site-installation/site-user-data",children:"Apply Site User Data"}
1),". The install configurations provided in\nvarious stages are merged to create the Edge host's final configuration."]}),"\n",(0,r.jsx)(n.h2,{id:"installer-example-configuration",children:"Installer Example Configuration"}),"\n",(0,r.jsxs)(n.p,{children:["The following example shows how the ",(0,r.jsx)(n.code,{children:"user-data"})," file is used to customize the Edge host installation process."]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"#cloud-config\nstylus:\n site:\n paletteEndpoint: api.spectrocloud.com\n edgeHostToken: yourEdgeRegistrationTokenHere\n projectUid: 12345677788\n tags:\n env: east\n terraform_managed: true\n os: ubuntu\n name: edge-59d3f182-35fe-4e10-b0a0-d7f761f1a142\n\n network:\n httpProxy: http://proxy.example.com\n httpsProxy: https://proxy.example.com\n noProxy: 10.10.128.10,10.0.0.0/8\n nameserver: 1.1.1.1\n interfaces:\n enp0s3:\n type: static\n ipAddress: 10.0.10.25/24\n gateway: 10.0.10.1\n nameserver: 10.10.128.8\n enp0s4:\n type: dhcp\n caCerts:\n - |\n ------BEGIN CERTIFICATE------\n *****************************\n *****************************\n ------END CERTIFICATE------\n - |\n ------BEGIN CERTIFICATE------\n *****************************\n *****************************\n ------END CERTIFICATE------\n"})}),"\n",(0,r.jsx)(n.admonition,{type:"info",children:(0,r.jsxs)(n.p,{children:["Check out the ",(0,r.jsx)(n.a,{href:"/clusters/edge/edgeforge-workflow/prepare-user-data",children:"Prepare User Data"})," resource for more examples."]})}),"\n",(0,r.jsx)(n.h2,{id:"additional-configurations",children:"Additional Configurations"}),"\n",(0,r.jsxs)(n.p,{children:["The Edge Installer will honor other Kairos parameters, such as ",(0,r.jsx)(n.code,{children:"install"}),", and ",(0,r.jsx)(n.code,{children:"options"}),". To learn more about Kairos\nparameters, refer to the ",(0,r.jsx)(n.a,{href:"https://kairos.io/docs/reference/configuration/",children:"Kairos configuration"})," page."]}),"\n",(0,r.jsxs)(n.p,{children:["The following is an example Edge installer configuration that is using the ",(0,r.jsx)(n.code,{children:"install"})," parameter block to power off the\ndevice upon completion of the installation process."]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"#cloud-config\nstylus:\n site:\n paletteEndpoint: api.spectrocloud.com\n registrationURL: https://edge-registration.vercel.app\n projectUid: yourProjectIdHere\n edgeHostToken: yourEdgeRegistrationTokenHere\n tags:\n myTag: myValue\n myOtherTag: myOtherValue\n tagsFromScript:\n scriptName: /etc/palette/tags.sh\n timeout: 30\n reboot: false\n\nstages:\n initramfs:\n - users:\n palette:\n groups:\n - sudo\n passwd: palette\n name: Create Palette user\n\ninstall:\n poweroff: true\n"})}),"\n",(0,r.jsx)(n.h2,{id:"resources",children:"Resources"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/clusters/edge/edge-configuration/cloud-init",children:"Cloud-Init Stages"})}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/clusters/edge/edge-configuration/installer-reference",children:"Edge Install Configuration"})}),"\n"]}),"\n"]})]})}function u(e={}){let{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(c,{...e})}):c(e)}},319406:function(e,n,t){t.d(n,{A:()=>o});let o=t.p+"assets/images/clusters_edge_cloud-init_boot-order-squence-df0fe1c82acdaab4a9a61b79655fb11d.webp"},884429:function(e,n,t){t.d(n,{R:()=>s,x:()=>a});var o=t(296540);let r={},i=o.createContext(r);function s(e){let n=o.useContext(i);return o.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:s(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.