6.4 Catalog
Catalog definitions and definition examples are shown below. For details of the service catalog, see “Service catalog” and “Designing a service catalog”.
| Label | Default value | 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:
|
|||
| 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
|
|||
| - 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. Up to 2 lines can be displayed in tile view, and up to 5 lines in list view. Even if the number of lines exceeds the display limit, you can view the content via a tooltip. |
|||
| order: | No | Priority order for category display as configured in this YAML file Specify an integer between 0 and 2147483647. Items are displayed in ascending order. If the same value is specified, they are displayed in random order. If not specified, the items are displayed after those with specified values. |
|||
| 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: | Yes | 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.
Tips
|
|||
| parameters: | No | Parameters for workflow execution. Set in key-value format. | |||
| 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".
<Definition example>
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