https://backstage.io/assets/js/899f136e.281e549d.js

1"use strict";(self.webpackChunkbackstage_microsite=self.webpackChunkbackstage_microsite||[]).push([["141"],{518186(e,t,n){n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>l,default:()=>h,frontMatter:()=>a,metadata:()=>i,toc:()=>r});var i=n(392498),s=n(474848),o=n(28453);let a={id:"viewing-catalog",title:"Viewing the Catalog",sidebar_label:"Viewing the Catalog",description:"Viewing the Catalog"},l,c={},r=[{value:"Overview",id:"overview",level:2},{value:"Informational columns for each entity",id:"informational-columns-for-each-entity",level:2},{value:"Catalog Actions",id:"catalog-actions",level:2},{value:"Viewing entity details",id:"viewing-entity-details",level:2}];function d(e){let t={a:"a",code:"code",h2:"h2",img:"img",li:"li",p:"p",ul:"ul",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.p,{children:"Audience: All"}),"\n",(0,s.jsx)(t.h2,{id:"overview",children:"Overview"}),"\n",(0,s.jsxs)(t.p,{children:["Initially, when you log into your standalone Backstage App, ",(0,s.jsx)(t.code,{children:"Home"})," is selected in the sidebar, which displays the Catalog in the main panel."]}),"\n",(0,s.jsx)(t.p,{children:"There are four main entities that you should become familiar with:"}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.code,{children:"Components"})," - Individual pieces of software that can be tracked in source control and can implement APIs for other components to consume."]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.code,{children:"Resources"})," - The physical or virtual infrastructure needed to operate a component."]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.code,{children:"Systems"})," - A collection of resources and components that cooperate to perform a function by exposing one or several public APIs. It hides the resources and private APIs between the components from the consumer."]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.code,{children:"Domains"})," - A collection of systems that share terminology, domain models, metrics, KPIs, business purpose, or documentation."]}),"\n"]}),"\n",(0,s.jsxs)(t.p,{children:["The ",(0,s.jsx)(t.a,{href:"/docs/overview/technical-overview#software-catalog-system-model",children:"Technical Overview"})," provides a description of all of the types of entities displayed in the Catalog."]}),"\n",(0,s.jsxs)(t.p,{children:["It should be noted that you can also ",(0,s.jsx)(t.a,{href:"/docs/features/software-catalog/extending-the-model#adding-a-new-kind",children:"create your own kinds of entities"}),", if you need to model something in your organization that does not map to one of the existing entity types."]}),"\n",(0,s.jsx)(t.p,{children:"Initially, the Catalog displays registered entities matching the following filter settings:"}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.code,{children:"Kind"})," - Component"]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.code,{children:"Type"})," - all"]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.code,{children:"Owner"})," - Owned"]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.code,{children:"Lifecycle"})," - list of ",(0,s.jsx)(t.a,{href:"/docs/features/software-catalog/descriptor-format#speclifecycle-required",children:"lifecycle"})," values of entities in the Catalog"]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.code,{children:"Processing Status"})," - normal"]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.code,{children:"Namespace"})," - The ID of a ",(0,s.jsx)(t.a,{href:"/docs/features/software-catalog/descriptor-format#namespace-optional",children:"namespace"})," to which the entity belongs"]}),"\n"]}),"\n",(0,s.jsxs)(t.p,{children:["You can change the initial setting for the ",(0,s.jsx)(t.a,{href:"/docs/features/software-catalog/catalog-customization#catalog-filters",children:"Owner"})," and ",(0,s.jsx)(t.a,{href:"/docs/features/software-catalog/catalog-customization#catalog-filters",children:"Kind"})," filters."]}),"\n",(0,s.jsx)(t.h2,{id:"informational-columns-for-each-entity",children:"Informational columns for each entity"}),"\n",(0,s.jsxs)(t.p,{children:["For each kind of entity, a set of columns display information regarding the entity. For example, the default set of information for a ",(0,s.jsx)(t.code,{children:"Component"})," is:"]}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.code,{children:"Name"})," - the name of the component"]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.code,{children:"System"})," - an optional field that references the system to which the component belongs"]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.code,{children:"Owner"})," - the owner of the component"]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.code,{children:"Type"})," - common types are as follows, but you can ",(0,s.jsx)(t.a,{href:"/docs/features/software-catalog/extending-the-model#adding-a-new-type-of-an-existing-kind",children:"create a new type"})," to meet your organization's needs\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.code,{children:"service"})," - a backend service, typically exposing an API"]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.code,{children:"website"})," - a website"]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.code,{children:"library"})," - a software library, such as an npm module or a Java library"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.code,{children:"Lifecycle"}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.code,{children:"experimental"})," - an experiment or early, non-production component, signaling\nthat users may not prefer to consume it over other more established\ncomponents, or that there are low or no reliability guarantees"]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.code,{children:"production"})," - an established, owned, maintained component"]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.code,{children:"deprecated"})," - a component that is at the end of its lifecycle, and may\ndisappear at a later point in t

1ime"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.code,{children:"Description"})," - an optional field that describes the component."]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.code,{children:"Tags"})," - an optional field that can be used for searching"]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.code,{children:"Actions"})," - see ",(0,s.jsx)(t.a,{href:"#catalog-actions",children:"Catalog Actions"})]}),"\n"]}),"\n",(0,s.jsxs)(t.p,{children:["You can modify the columns associated with each kind of entity, following the instructions in ",(0,s.jsx)(t.a,{href:"/docs/features/software-catalog/catalog-customization#customizing-columns-actions-and-table-options",children:"Customizing columns, actions, and table options"}),"."]}),"\n",(0,s.jsx)(t.h2,{id:"catalog-actions",children:"Catalog Actions"}),"\n",(0,s.jsx)(t.p,{children:"For each entity, there are a set of actions that are available."}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.img,{alt:"Screenshot explaining entity actions.",src:n(139243).A+"",width:"82",height:"47"})}),"\n",(0,s.jsx)(t.p,{children:"From left to right, the actions are:"}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:["View - View the ",(0,s.jsx)(t.code,{children:"catalog-info.yaml"})," file that defines the entity."]}),"\n",(0,s.jsxs)(t.li,{children:["Edit - Edit the ",(0,s.jsx)(t.code,{children:"catalog-info.yaml"})," file that defines the entity. See ",(0,s.jsx)(t.a,{href:"/docs/getting-started/update-a-component",children:"Updating a Component"})]}),"\n",(0,s.jsxs)(t.li,{children:["Star - Designate the entity as a favorite. You can ",(0,s.jsx)(t.a,{href:"/docs/getting-started/filter-catalog",children:"filter"})," the catalog for starred entities."]}),"\n"]}),"\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.a,{href:"/docs/features/software-catalog/catalog-customization#customizing-columns-actions-and-table-options",children:"Customizing columns, actions, and table options"})," describes how you can modify the actions that are displayed."]}),"\n",(0,s.jsx)(t.h2,{id:"viewing-entity-details",children:"Viewing entity details"}),"\n",(0,s.jsxs)(t.p,{children:["Selecting an entity in the main panel displays details of the entity. The type of details depends on the type of entity. For example, selecting a Component, such as ",(0,s.jsx)(t.code,{children:"example-website"}),", displays the following details:"]}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.code,{children:"About"})," - Metadata for the entity, such as description, owner, tags, and domain."]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.code,{children:"Relations"})," - see ",(0,s.jsx)(t.a,{href:"/docs/getting-started/viewing-entity-relationships",children:"Viewing entity relationships"})]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.code,{children:"Links"})," - any links associated with the entity"]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.code,{children:"Has subcomponents"})," - An entity reference to another component of which the component is a part"]}),"\n"]}),"\n",(0,s.jsxs)(t.p,{children:["Selecting a System, such as ",(0,s.jsx)(t.code,{children:"examples"}),", displays ",(0,s.jsx)(t.code,{children:"About"}),", ",(0,s.jsx)(t.code,{children:"Relations"}),", and ",(0,s.jsx)(t.code,{children:"Links"})," similar to a Component, but it also includes ",(0,s.jsx)(t.code,{children:"Has components"}),", ",(0,s.jsx)(t.code,{children:"APIs"})," and ",(0,s.jsx)(t.code,{children:"Has Resources"}),"."]}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.img,{alt:"Details of system entity.",src:n(753522).A+"",width:"1102",height:"891"})})]})}function h(e={}){let{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},753522(e,t,n){n.d(t,{A:()=>i});let i=n.p+"assets/images/details-system-entity-407600fbd65ef56ea836b90f3aaacb02.png"},139243(e,t,n){n.d(t,{A:()=>i});let i="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAFIAAAAvCAYAAABwkJ2EAAAACXBIWXMAAA7EAAAOxAGVKw4bAAAAB3RJTUUH6gILFhQwxhZ+HgAABBNJREFUaIHtmk0ofF0cx7+DBRtFI8rqXhohZZAxCQlTMspGiiQsrAZ5K0lRYkFJ2JGZhbfJW16XSDENSRqjzIgFWRhTIwsL/J7F81DTjH/j3tOjP+dTt+aee+73/PrMvad75o6CiAgc2QR9dwE/BS6SEVwkI7hIRnCRjOAiGcFFMoKLZAQXyQgukhFcJCO4SEZwkYz4tSLLysqY5kkW2dbWBlEUfTYAMBgMftvlotfrMTIyIjvn+PgYp6enmJmZYVDVv4RIPXF5eRlNTU3QaDQ+xxobG1FVVYXR0VEcHBzIKvAdg8EAu90Ou92O19dXtLS0SM6anp4GAJhMJlRWVjKpDyQRQRBoc3Pz0+NjY2MkCALV1taSIAhShyEiouHhYXK5XFRUVESCIFB+fr6svISEBOrv7ydBEOjk5ERW1juyRG5sbPg9Njk5SaIo0uzsLK2vr8sSqdPpSBAEam1tpYeHByovL5ecRUQ0MTFBWq2WXl5eqLq6mtrb22XlvSP51gYAhULh02Y0GtHX14eBgQFUVFTAYrH4vf0DQafTwel0AgCWlpYQEREBs9kc8Pk9PT24v7+H2+2Gy+WCy+WCx+NBZ2cngoOD0dDQgOrqamxtbUGpVCIqKgqRkZFQKpWoq6v72twu9Rvwd0WazWYSRZEWFxdlf8MFBQUkCMLHlpqaShcXF1/K2NnZocT

1ERFKpVDQ1NUUWi4Xu7u68+rjdbjo+PqaFhQXKyMggURTJaDR+uV5mIldWViguLs5HopRbOy8vz0tiWlralyW+c35+TlqtloqLi30kvvP8/Ez19fWUlJREu7u7ksZhInJzc5Pi4+NpdXXVp99XRfqTeHl5KbXMD0pKSkij0dDV1ZVX+9PTE+n1esrMzCSbzSY5n8kcGR4ejsHBQZSWln7aJxBycnJwe3v7sa9UKjE3N8fkOXR9fR2iKOLx8dGrPSgoCHa7HePj40hOTpacL2tlQ/+9Es/Ozv50pUABvjbPzc31khgdHQ2r1crsYX5rawuhoaFITk6Gy+VCd3c3HA4HwsLCkJKSgrOzM1n5kq9IhUIBh8MBi8Xyx35OpzOgq/Lm5ubjc0xMDPb396WW5her1Qq1Wo21tTX09vYiLCwM8/PzaG5uRmpqKqxWq6x8ySJzc3MDXq4VFhYGnBsbG4u9vT2pZX3K4eEhrq+vYbPZ0NHRgaqqKmxvb6Orqwsejwdvb2/yBpA1g/9FxMfHf/rwPTQ0RCqVio6OjiTnK4h+/n9/nE4nPB4P0tPT/9jPYrEgKytL0hi/QuT/wa/9PZI1XCQjuEhGcJGM4CIZwUUygouUiMPh8NoPMZlM31TK301NTY3Xfoharf6mUn4WfGXDCD5HMoKLZAQXyQgukhFcJCO4SEZwkYz4B3IC0tEQ849vAAAAAElFTkSuQmCC"},28453(e,t,n){n.d(t,{R:()=>a,x:()=>l});var i=n(296540);let s={},o=i.createContext(s);function a(e){let t=i.useContext(o);return i.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),i.createElement(o.Provider,{value:t},e.children)}},392498(e){e.exports=JSON.parse('{"id":"getting-started/viewing-catalog","t

1itle":"Viewing the Catalog","description":"Viewing the Catalog","source":"@site/versioned_docs/version-stable/getting-started/viewing-catalog.md","sourceDirName":"getting-started","slug":"/getting-started/viewing-catalog","permalink":"/docs/getting-started/viewing-catalog","draft":false,"unlisted":false,"editUrl":"https://github.com/backstage/backstage/edit/master/docs/getting-started/viewing-catalog.md","tags":[],"version":"stable","frontMatter":{"id":"viewing-catalog","title":"Viewing the Catalog","sidebar_label":"Viewing the Catalog","description":"Viewing the Catalog"},"sidebar":"docs","previous":{"title":"Logging into Backstage","permalink":"/docs/getting-started/logging-in"},"next":{"title":"Viewing what you own","permalink":"/docs/getting-started/view-what-you-own"}}')}}]);