1"use strict";(self.webpackChunktroubleshoot_docs=self.webpackChunktroubleshoot_docs||[]).push([["540"],{6892(e,n,a){a.r(n),a.d(n,{metadata:()=>l,default:()=>h,frontMatter:()=>s,contentTitle:()=>i,toc:()=>m,assets:()=>r});var l=JSON.parse('{"id":"collect/longhorn","title":"Longhorn","description":"Include information about Longhorn CSI","source":"@site/docs/collect/longhorn.md","sourceDirName":"collect","slug":"/collect/longhorn","permalink":"/docs/collect/longhorn","draft":false,"unlisted":false,"editUrl":"https://github.com/replicatedhq/troubleshoot/tree/main/docs/docs/collect/longhorn.md","tags":[{"inline":true,"label":"collect","permalink":"/docs/tags/collect"}],"version":"current","frontMatter":{"title":"Longhorn","description":"Include information about Longhorn CSI","tags":["collect"]},"sidebar":"docs","previous":{"title":"Goldpinger","permalink":"/docs/collect/goldpinger"},"next":{"title":"MS SQL","permalink":"/docs/collect/mssql"}}'),o=a(4848),c=a(8453);let s={title:"Longhorn",description:"Include information about Longhorn CSI",tags:["collect"]},i,r={},m=[{value:"Parameters",id:"parameters",level:2},{value:"<code>collectorName</code> (Optional)",id:"collectorname-optional",level:4},{value:"<code>namespace</code> (Optional)",id:"namespace-optional",level:4},{value:"Example Collector Definition",id:"example-collector-definition",level:2},{value:"Included resources",id:"included-resources",level:2},{value:"<code>/longhorn/[namespace]/settings.yaml</code>",id:"longhornnamespacesettingsyaml",level:3},{value:"<code>/longhorn/[namespace]/logs/[pod]</code>",id:"longhornnamespacelogspod",level:3},{value:"<code>/longhorn/[namespace]/volumes/[volume-name]/replicachecksums/[replica].txt</code>",id:"longhornnamespacevolumesvolume-namereplicachecksumsreplicatxt",level:3},{value:"Custom Resources",id:"custom-resources",level:3},{value:"<code>/longhorn/[namespace]/nodes/[node-name].yaml</code>",id:"longhornnamespacenodesnode-nameyaml",level:4},{value:"<code>/longhorn/[namespace]/volumes/[volume-name].yaml</code>",id:"longhornnamespacevolumesvolume-nameyaml",level:4},{value:"<code>/longhorn/[namespace]/replicas/[replica-name].yaml</code>",id:"longhornnamespacereplicasreplica-nameyaml",level:4},{value:"<code>/longhorn/[namespace]/engines/[engine-name].yaml</code>",id:"longhornnamespaceenginesengine-nameyaml",level:4},{value:"<code>/longhorn/[namespace]/engineimages/[engineimage-name].yaml</code>",id:"longhornnamespaceengineimagesengineimage-nameyaml",level:4},{value:"<code>/longhorn/[namespace]/instancemanagers/[instancemanager-name].yaml</code>",id:"longhornnamespaceinstancemanagersinstancemanager-nameyaml",level:4},{value:"<code>/longhorn/[namespace]/backingimagemanagers/[backingimagemanager-name].yaml</code>",id:"longhornnamespacebackingimagemanagersbackingimagemanager-nameyaml",level:4},{value:"<code>/longhorn/[namespace]/backingimages/[backingimages-name].yaml</code>",id:"longhornnamespacebackingimagesbackingimages-nameyaml",level:4},{value:"<code>/longhorn/[namespace]/sharemanagers/[sharemanagers-name].yaml</code>",id:"longhornnamespacesharemanagerssharemanagers-nameyaml",level:4}];function t(e){let n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",li:"li",ol:"ol",p:"p",pre:"pre",...(0,c.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsxs)(n.p,{children:["This collector will add information about the ",(0,o.jsx)(n.a,{href:"https://longhorn.io/",children:"longhorn"})," storage provider in a cluster."]}),"\n",(0,o.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,o.jsx)(n.p,{children:"The longhorn collector has the following parameters:"}),"\n",(0,o.jsxs)(n.h4,{id:"collectorname-optional",children:[(0,o.jsx)(n.code,{children:"collectorName"})," (Optional)"]}),"\n",(0,o.jsx)(n.p,{children:"The name of the collector."}),"\n",(0,o.jsxs)(n.h4,{id:"namespace-optional",children:[(0,o.jsx)(n.code,{children:"namespace"})," (Optional)"]}),"\n",(0,o.jsxs)(n.p,{children:["The namespace where longhorn is running.\nIf this is not provided, it will default to ",(0,o.jsx)(n.code,{children:"longhorn-system"}),"."]}),"\n",(0,o.jsx)(n.h2,{id:"example-collector-definition",children:"Example Collector Definition"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:"apiVersion: troubleshoot.sh/v1beta2\nkind: SupportBun
1dle\nmetadata:\n name: sample\nspec:\n collectors:\n - longhorn: {}\n"})}),"\n",(0,o.jsx)(n.h2,{id:"included-resources",children:"Included resources"}),"\n",(0,o.jsx)(n.h3,{id:"longhornnamespacesettingsyaml",children:(0,o.jsx)(n.code,{children:"/longhorn/[namespace]/settings.yaml"})}),"\n",(0,o.jsx)(n.p,{children:"A copy of all settings.longhorn.io will be aggregated into a single yaml file."}),"\n",(0,o.jsx)(n.h3,{id:"longhornnamespacelogspod",children:(0,o.jsx)(n.code,{children:"/longhorn/[namespace]/logs/[pod]"})}),"\n",(0,o.jsx)(n.p,{children:"A separate file for the logs of every container of every pod in the namespace will be found in the logs directory."}),"\n",(0,o.jsx)(n.h3,{id:"longhornnamespacevolumesvolume-namereplicachecksumsreplicatxt",children:(0,o.jsx)(n.code,{children:"/longhorn/[namespace]/volumes/[volume-name]/replicachecksums/[replica].txt"})}),"\n",(0,o.jsx)(n.p,{children:"Checksums of each replica of a volume will be collected if the following conditions are met:"}),"\n",(0,o.jsxs)(n.ol,{children:["\n",(0,o.jsx)(n.li,{children:"The volume is in a detached state. To put a volume into detached state delete any pods consuming the volume's PVC prior to running the collector."}),"\n",(0,o.jsx)(n.li,{children:"The volume has multiple replicas. Volumes in single-node Kubernetes clusters will not have multiple replicas."}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://longhorn.io/docs/1.1.1/advanced-resources/data-recovery/corrupted-replica/",children:"More information"})}),"\n",(0,o.jsx)(n.h3,{id:"custom-resources",children:"Custom Resources"}),"\n",(0,o.jsx)(n.h4,{id:"longhornnamespacenodesnode-nameyaml",children:(0,o.jsx)(n.code,{children:"/longhorn/[namespace]/nodes/[node-name].yaml"})}),"\n",(0,o.jsx)(n.p,{children:"Each nodes.longhorn.io resource in the namespace will be in a separate yaml file."}),"\n",(0,o.jsx)(n.h4,{id:"longhornnamespacevolumesvolume-nameyaml",children:(0,o.jsx)(n.code,{children:"/longhorn/[namespace]/volumes/[volume-name].yaml"})}),"\n",(0,o.jsx)(n.p,{children:"Each volumes.longhorn.io resource in the namespace will be in a separate yaml file."}),"\n",(0,o.jsx)(n.h4,{id:"longhornnamespacereplicasreplica-nameyaml",children:(0,o.jsx)(n.code,{children:"/longhorn/[namespace]/replicas/[replica-name].yaml"})}),"\n",(0,o.jsx)(n.p,{children:"Each replicas.longhorn.io resource in the namespace will be in a separate yaml file."}),"\n",(0,o.jsx)(n.h4,{id:"longhornnamespaceenginesengine-nameyaml",children:(0,o.jsx)(n.code,{children:"/longhorn/[namespace]/engines/[engine-name].yaml"})}),"\n",(0,o.jsx)(n.p,{children:"Each engines.longhorn.io resource in the namespace will be in a separate yaml file."}),"\n",(0,o.jsx)(n.h4,{id:"longhornnamespaceengineimagesengineimage-nameyaml",children:(0,o.jsx)(n.code,{children:"/longhorn/[namespace]/engineimages/[engineimage-name].yaml"})}),"\n",(0,o.jsx)(n.p,{children:"Each engineimages.longhorn.io resource in the namespace will be in a separate yaml file."}),"\n",(0,o.jsx)(n.h4,{id:"longhornnamespaceinstancemanagersinstancemanager-nameyaml",children:(0,o.jsx)(n.code,{children:"/longhorn/[namespace]/instancemanagers/[instancemanager-name].yaml"})}),"\n",(0,o.jsx)(n.p,{children:"Each instancemanagers.longhorn.io resource in the namespace will be in a separate yaml file."}),"\n",(0,o.jsx)(n.h4,{id:"longhornnamespacebackingimagemanagersbackingimagemanager-nameyaml",children:(0,o.jsx)(n.code,{children:"/longhorn/[namespace]/backingimagemanagers/[backingimagemanager-name].yaml"})}),"\n",(0,o.jsx)(n.p,{children:"Each backingimagemanagers.longhorn.io resource in the namespace will be in a separate yaml file."}),"\n",(0,o.jsx)(n.h4,{id:"longhornnamespacebackingimagesbackingimages-nameyaml",children:(0,o.jsx)(n.code,{children:"/longhorn/[namespace]/backingimages/[backingimages-name].yaml"})}),"\n",(0,o.jsx)(n.p,{children:"Each backingimages.longhorn.io resource in the namespace will be in a separate yaml file."}),"\n",(0,o.jsx)(n.h4,{id:"longhornnamespacesharemanagerssharemanagers-nameyaml",children:(0,o.jsx)(n.code,{children:"/longhorn/[namespace]/sharemanagers/[sharemanagers-name].yaml"})}),"\n",(0,o.jsx)(n.p,{children:"Each sharemanagers.longhorn.io resource in the namespace will be in a separate yaml file."})]})}function h(e={}){let{wrapper:n}={...(0,c.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(t,{...e})}):t(e)}},8453(e,n,a){a.d(n,{R:()=>s,x:()=>i});var l=a(6540);let o={},c=l.createContext(o);function s(e){let n=l.useContext(c);return l.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),l.createElement(c.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.