6.4 Catalog

Catalog definitions and definition examples are shown below. For details of the service catalog, see “Service catalog” and “Designing a data model”.

(Table) Catalog definitions

Label			Required^*	Description
apiVersion:			Yes	API version Specify 1.0.
kind:			Yes	Specify "catalog".
type:			No	Specify "resource". It indicates a new definition to be added to the operational function of Ops I.
name:			Yes	Internal name of the Catalog definition. "name" should follow the conventions shown below: Specify the directory name of this YAML file. The following characters can be entered: Single-byte alphanumeric characters: a–z A–Z 0–9 Single-byte special characters: _ . ( ) - The first character must be a single-byte alphanumeric character or an underscore (_). For other precautions, see "Notes on creating YAML files" 2–4.
label:			Yes	Display name of the operational function to be written in the YAML file
includes:			No	List the related YAML files for use in this YAML file. Tips Before this YAML file is registered, the YAML file to be written to must be registered in Ops I. By specifying the "includes" label, you can import information defined in another YAML file. For example, this can be used to import the YAML file for "Workflow", which defines the workflow to be executed from the service catalog.
	- kind:		Yes	Type of YAML file to be loaded
	name:		Yes	Internal name of YAML file to be loaded
description:			No	Detailed description of this YAML file. This can be written using the template function.
order:			No	Category display order priority to be set in this YAML file Specify an integer between 0 and 2147483647. If not specified, and if the same value is set, YAML files in Catalog are displayed in the order in which they were registered.
customers:			No	Specify whether to restrict the display of categories and catalog items set in this YAML file by the customer. Customer users cannot reference the category of this YAML file and the catalog items if the customer specified for themselves is not included in the customers specified here.
	- (string)		Yes	Customer name for which to display categories and catalog items
groups:			No	Specify whether to restrict the display of categories and catalog items set in this YAML file by group. If none of the groups assigned to a user include any of the groups specified here, the user cannot view the categories and catalog items in this YAML file.
	- (string)		Yes	Group name for which to display categories and catalog items
categories:			Yes	Sets the category
	- name:		Yes	Internal name of the category
	label:		No	Display name of the category
	description:		No	Detailed description of the category
	items:		No	Define individual catalog items to be placed under a category.
		- workflow:	No	Define catalog items to implement the workflow. Specify the workflow name.
		label:	No	Display name of the catalog item
		description:	No	Detailed description of the catalog item
		image:	No	File name of the icon image. An image in the same directory as this YAML file can be specified.
	sub:		No	Set subcategories when hierarchizing categories.
		- name:	Yes	-
		…	No	-
		(sub):	No	-

*If a label that is not nested has its "Required" field set to "No", the definition is not required. For nested labels, the "Required" setting of a lower-level label applies only when the "Required" setting of its upper-level label is set to "Yes".

apiVersion: 1.0
kind: catalog
type: resource
name: demo_catalog
label: Service catalog for demonstration
description: |
  A service catalog for demonstration
includes:
  - kind: workflow
    name: create_vm_wf

categories:
  - name: demo_catalog
    label: Catalog item for demonstration
    sub:
     - name: request_operation
       label: Request task
       items:
         - workflow: create_vm_wf
           label: Lend VM
           description: Make VM lending application
           image: sample1.png