1"use strict";(self.webpackChunkbackstage_microsite=self.webpackChunkbackstage_microsite||[]).push([["12849"],{744687(e,t,i){i.r(t),i.d(t,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>s,metadata:()=>r,toc:()=>l});var r=i(500100),n=i(474848),o=i(28453);let s={id:"locations",title:"Gerrit Locations",sidebar_label:"Locations",description:"Integrating source code stored in Gerrit into the Backstage catalog"},a,c={},l=[{value:"Configuration",id:"configuration",level:2}];function d(e){let t={a:"a",code:"code",h2:"h2",li:"li",p:"p",pre:"pre",ul:"ul",...(0,o.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsxs)(t.p,{children:["The Gerrit integration supports loading catalog entities from Gerrit hosted gits. Entities can\nbe added to ",(0,n.jsx)(t.a,{href:"/docs/next/features/software-catalog/configuration",children:"static catalog configuration"}),",\nor registered with the\n",(0,n.jsx)(t.a,{href:"https://github.com/backstage/backstage/tree/master/plugins/catalog-import",children:"catalog-import"}),"\nplugin."]}),"\n",(0,n.jsxs)(t.p,{children:["Gerrit 3.9+ supports inline editing via URL. The integration enables this by default, following Gerrit's ",(0,n.jsx)(t.a,{href:"https://gerrit-review.googlesource.com/Documentation/user-inline-edit.html#create_from_url",children:"official URL pattern"})," for inline edits."]}),"\n",(0,n.jsx)(t.h2,{id:"configuration",children:"Configuration"}),"\n",(0,n.jsxs)(t.p,{children:["To use this integration, add at least one Gerrit configuration to your root ",(0,n.jsx)(t.code,{children:"app-config.yaml"}),":"]}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-yaml",children:"integrations:\n gerrit:\n - host: gerrit.company.com\n gitilesBaseUrl: https://gerrit.company.com/gitiles\n baseUrl: https://gerrit.company.com/gerrit\n cloneUrl: https://gerrit.company.com/clone\n disableEditUrl: false\n username: ${GERRIT_USERNAME}\n password: ${GERRIT_PASSWORD}\n"})}),"\n",(0,n.jsxs)(t.p,{children:["Directly under the ",(0,n.jsx)(t.code,{children:"gerrit"})," key is a list of provider configurations, where\nyou can list the Gerrit instances you want to fetch data from. Each entry is\na structure with up to six elements:"]}),"\n",(0,n.jsxs)(t.ul,{children:["\n",(0,n.jsxs)(t.li,{children:[(0,n.jsx)(t.code,{children:"host"}),": The host of the Gerrit instance, e.g. ",(0,n.jsx)(t.code,{children:"gerrit.company.com"}),"."]}),"\n",(0,n.jsxs)(t.li,{children:[(0,n.jsx)(t.code,{children:"gitilesBaseUrl"}),": The base url of the Gitiles instance."]}),"\n",(0,n.jsxs)(t.li,{children:[(0,n.jsx)(t.code,{children:"baseUrl"})," (optional): Needed if the Gerrit instance is not reachable at\nthe base of the ",(0,n.jsx)(t.code,{children:"host"})," option (e.g. ",(0,n.jsx)(t.code,{children:"https://gerrit.company.com"}),") set the\naddress here. This is the address that you would open in a browser."]}),"\n",(0,n.jsxs)(t.li,{children:[(0,n.jsx)(t.code,{children:"cloneUrl"})," (optional): The base URL for HTTP clones. Will default to ",(0,n.jsx)(t.code,{children:"baseUrl"})," if\nnot set. The address used to clone a repo is the ",(0,n.jsx)(t.code,{children:"cloneUrl"})," plus the repo name."]}),"\n",(0,n.jsxs)(t.li,{children:[(0,n.jsx)(t.code,{children:"disableEditUrl"})," (optional): Disable the edit mode."]}),"\n",(0,n.jsxs)(t.li,{children:[(0,n.jsx)(t.code,{children:"username"})," (optional): The Gerrit username to use in API requests. If\nneither a username nor password are supplied, anonymous access will be used."]}),"\n",(0,n.jsxs)(t.li,{children:[(0,n.jsx)(t.code,{children:"password"})," (optional): The password or http token for the Gerrit user."]}),"\n"]})]})}function h(e={}){let{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},28453(e,t,i){i.d(t,{R:()=>s,x:()=>a});var r=i(296540);let n={},o=r.createContext(n);function s(e){let t=r.useContext(o);return r.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:s(e.components),r.createElement(o.Provider,{value:t},e.children)}},500100(e){e.exports=JSON.parse('{"id":"integrations/gerrit/locations","title":"Gerrit Locations","description":"Integrating source code stored in Gerrit into the Backstage catalog","source":"@site/../docs/integrations/gerrit/locations.md","sourceDirName":"integrations/gerrit","slug":"/integrations/gerrit/locations","permalink":"/docs/next/integrations/gerrit/locations","draft":false,"unlisted":false,"editUrl":"https://github.com/backstage/backstage/edit/master/docs/integrations/gerrit/locations.md","tags":[],"version":"current","frontMatter":{"id":"locations","title":"Gerrit Locations","sidebar_label":"Locations","description":"Integrating source code stored in Gerrit into the Backstage catalog"},"sidebar":"docs","previous":{"title":"Gerrit","permalink":"/docs/next/gerrit/generated-index"},"next":{"title":"Discovery","permalink":"/docs/next/integrations/gerrit/discovery"}}')}}]);
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.