https://docs-spectrocloud.netlify.app/assets/js/08f3dbb9.dcce22db.js

1"use strict";(self.webpackChunkspectro_cloud_docs=self.webpackChunkspectro_cloud_docs||[]).push([["14080"],{844629:function(e,n,t){t.r(n),t.d(n,{frontMatter:()=>l,toc:()=>o,default:()=>h,metadata:()=>r,assets:()=>a,contentTitle:()=>c});var r=JSON.parse('{"id":"clusters/edge/cluster-management/certificate-renewal","title":"Renew Certificates for Local Clusters","description":"Learn how to renew certificates for different Kubernetes components in your cluster.","source":"@site/docs/docs-content/clusters/edge/cluster-management/certificate-renewal.md","sourceDirName":"clusters/edge/cluster-management","slug":"/clusters/edge/cluster-management/certificate-renewal","permalink":"/clusters/edge/cluster-management/certificate-renewal","draft":false,"unlisted":false,"editUrl":"https://github.com/spectrocloud/librarium/blob/master/docs/docs-content/clusters/edge/cluster-management/certificate-renewal.md","tags":[{"inline":true,"label":"edge","permalink":"/tags/edge"},{"inline":true,"label":"architecture","permalink":"/tags/architecture"}],"version":"current","lastUpdatedAt":1777826507000,"sidebarPosition":20,"frontMatter":{"sidebar_label":"Renew Certificates for Local Clusters","title":"Renew Certificates for Local Clusters","description":"Learn how to renew certificates for different Kubernetes components in your cluster.","hide_table_of_contents":false,"sidebar_position":20,"tags":["edge","architecture"]},"sidebar":"docSidebar","previous":{"title":"Edge Cluster Upgrade Behavior","permalink":"/clusters/edge/cluster-management/upgrade-behavior"},"next":{"title":"Configure Palette Agent Version","permalink":"/clusters/edge/cluster-management/agent-upgrade-airgap"}}'),i=t(474848),s=t(884429);let l={sidebar_label:"Renew Certificates for Local Clusters",title:"Renew Certificates for Local Clusters",description:"Learn how to renew certificates for different Kubernetes components in your cluster.",hide_table_of_contents:!1,sidebar_position:20,tags:["edge","architecture"]},c,a={},o=[{value:"Limitations",id:"limitations",level:2},{value:"Automatic Renewal",id:"automatic-renewal",level:2},{value:"Prerequisite",id:"prerequisite",level:3},{value:"Check Next Auto Renewal Time",id:"check-next-auto-renewal-time",level:3},{value:"Validate",id:"validate",level:3},{value:"Manual Renewal",id:"manual-renewal",level:2},{value:"Prerequisite",id:"prerequisite-1",level:3},{value:"Manually Renew Certificates",id:"manually-renew-certificates",level:3},{value:"Validate",id:"validate-1",level:3}];function d(e){let n={a:"a",code:"code",em:"em",h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,s.R)(),...e.components},{TabItem:t,Tabs:r}=n;return t||u("TabItem",!0),r||u("Tabs",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.p,{children:"Kubernetes uses SSL certificates to secure the communication between different components of a cluster. Using these\ncertificates allows Kubernetes to secure API connections, verify the authenticity of the nodes, and encrypt connections.\nAll certificates have an expiry date, and need to be renewed periodically."}),"\n",(0,i.jsxs)(n.p,{children:["This page guides you through the different methods used to renew certificates in a local Palette Edge cluster. An local\ncluster is a cluster that has no connection to a Palette instance. For information on how to renew certificates on\ncentrally managed Edge clusters, refer to\n",(0,i.jsx)(n.a,{href:"/clusters/cluster-management/certificate-management",children:"Renew Cluster PKI Certificates"}),"."]}),"\n",(0,i.jsx)(n.h2,{id:"limitations",children:"Limitations"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"The procedure described in this guide only renews certificates for control plane nodes. Certificate renewal for worker\nnodes is not supported."}),"\n",(0,i.jsx)(n.li,{children:"The certificates used are generated by Kubernetes. You cannot use your own certificates."}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"automatic-renewal",children:"Automatic Renewal"}),"\n",(0,i.jsx)(n.p,{children:"Palette Edge will automatically renew all control plane certificates your cluster uses for you 30 days before they\nexpire. You can follow the steps below to check when the next automatic renew

1al will happen."}),"\n",(0,i.jsx)(n.h3,{id:"prerequisite",children:"Prerequisite"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"You have an active cluster in a locally managed Edge host."}),"\n",(0,i.jsxs)(n.li,{children:["You have access to Local UI for the Edge host. For more information, refer to\n",(0,i.jsx)(n.a,{href:"/clusters/edge/local-ui/host-management/access-console",children:"Access Local UI"}),"."]}),"\n"]}),"\n",(0,i.jsx)(n.h3,{id:"check-next-auto-renewal-time",children:"Check Next Auto Renewal Time"}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:["Log in to ",(0,i.jsx)(n.a,{href:"/clusters/edge/local-ui/host-management/access-console",children:"Local UI"}),"."]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:["From the left ",(0,i.jsx)(n.strong,{children:"Main Menu"}),", select ",(0,i.jsx)(n.strong,{children:"Cluster"}),"."]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:["Select the ",(0,i.jsx)(n.strong,{children:"Overview"})," tab on the ",(0,i.jsx)(n.strong,{children:"Cluster"})," page."]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:["In ",(0,i.jsx)(n.strong,{children:"Overview"}),", click ",(0,i.jsx)(n.strong,{children:"View Certificates"})," in the ",(0,i.jsx)(n.strong,{children:"Kubernetes Certificates"})," row. This will display all the\ncertificates currently in use by your cluster."]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:"The next renewal time, which is 30 days before the expiry date, for your certificates is at the top of the pop-up\nbox."}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.h3,{id:"validate",children:"Validate"}),"\n",(0,i.jsxs)(n.p,{children:["In ",(0,i.jsx)(n.strong,{children:"Overview"}),", click ",(0,i.jsx)(n.strong,{children:"View Certificates"})," in the ",(0,i.jsx)(n.strong,{children:"Kubernetes Certificates"})," row. This will display all the\ncertificates currently in use by your cluster. You can confirm that the certificates have been renewed by looking at the\n",(0,i.jsx)(n.em,{children:"expiry"})," date of certificates. The issue date of the certificates will not change after certificate renewal."]}),"\n",(0,i.jsx)(n.h2,{id:"manual-renewal",children:"Manual Renewal"}),"\n",(0,i.jsx)(n.p,{children:"You can also manually renew your certificates whenever you want. You can do this through Local UI or through the Edge\nManagement API."}),"\n",(0,i.jsx)(n.h3,{id:"prerequisite-1",children:"Prerequisite"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"You have an active local Edge cluster."}),"\n",(0,i.jsxs)(n.li,{children:["You have access to Local UI for the Edge host. For more information, refer to\n",(0,i.jsx)(n.a,{href:"/clusters/edge/local-ui/host-management/access-console",children:"Access Local UI"}),"."]}),"\n"]}),"\n",(0,i.jsx)(n.h3,{id:"manually-renew-certificates",children:"Manually Renew Certificates"}),"\n",(0,i.jsxs)(r,{group:"methods",children:[(0,i.jsx)(t,{label:"Local UI",value:"ui",children:(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:["Log in to ",(0,i.jsx)(n.a,{href:"/clusters/edge/local-ui/host-management/access-console",children:"Local UI"}),"."]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:["From the left ",(0,i.jsx)(n.strong,{children:"Main Menu"}),", select ",(0,i.jsx)(n.strong,{children:"Cluster"}),"."]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:["Select the ",(0,i.jsx)(n.strong,{children:"Overview"})," tab on the ",(0,i.jsx)(n.strong,{children:"Cluster"})," page."]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:["In ",(0,i.jsx)(n.strong,{children:"Overview"}),", click ",(0,i.jsx)(n.strong,{children:"View Certificates"})," in the ",(0,i.jsx)(n.strong,{children:"Kubernetes Certificates"})," row. This will display all the\ncertificates currently in use by your cluster."]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:["Click ",(0,i.jsx)(n.strong,{children:"Renew"})," to renew all certificates used by the cluster."]}),"\n"]}),"\n"]})}),(0,i.jsx)(t,{label:"API",value:"api",children:(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:["Issue the following command to call the Edge Management authentication API. Replace ",(0,i.jsx)(n.code,{children:"edge-host-ip"})," with the IP of\nyour Edge host and replace ",(0,i.jsx)(n.code,{children:"os-username"})," and ",(0,i.jsx)(n.code,{children:"os-password"})," with your Operating System (OS) user credentials."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-shell",children:'curl --location \'https://edge-host-ip:5080/v1/users/default/login\' \\\n--header \'Content-Type: application/json\' \\\n--data \'{\n   "username": "os-username",\n   "password": "os-password"\n}\'\n'})}),"\n",(0,i.jsx)(n.p,{children:"This will return an authentication token."}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-json",children:'{\n  "Token": {\n    "Authorization": "******"\n  }\n}\n'})}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:"Issue the following command to call the endpoint to renew your control plane node certificates. Put the\nauthentication token you obtained in the previous step in the header."}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-shell",children:'curl -X POST "https://edge-host-ip:5080/v1/edge-mgmt/cluster/renew-certificates" \\\n  --header "Authorization: *******"\n'})}),"\n",(0,i.jsx)(n.p,{children:"This will renew all certificates on the control plane nodes."}),"\n"]}),"\n"]})})]}),"\n",(0,i.jsx)(n.h3,{id:"validate-1",children:"Validate"}),"\n",(0,i.jsxs)(n.p,{children:["In ",(0,i.jsx)(n.strong,{children:"Overview"}),", click ",(0,i.jsx)(n.strong,{children:"View Certificates"})," in the ",(0,i.jsx)(n.strong,{children:"Kubernetes Certificates"})," row. This will display all the\ncertificates currently in use by your cluster. You can confirm that the certificates have been renewed by looking at the\n",(0,i.jsx)(n.em,{children:"expiry"})," date of certificates. The issue date of the certificates will not change after certificate renewal."]})]})}function h(e={}){let{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}function u(e,n){throw Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},884429:function(e,n,t){t.d(n,{R:()=>l,x:()=>c});var r=t(296540);let i={},s=r.createContext(i);function l(e){let n=r.useContext(s);return r.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:l(e.components),r.createElement(s.Provider,{value:n},e.children)}}}]);