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”.
| Label | Default value | Required | Description | ||
|---|---|---|---|---|---|
| apiVersion: | 1.0 | Yes | API version | ||
| kind: | Yes | Specify "catalog" for service catalog. | |||
| type: | No | Only "resource" can be specified for service catalog. | |||
| name: | Yes | Internal name of the Catalog definition. Specify the directory name for this YAML file. | |||
| label: | Yes | YAML file display name | |||
| includes: | No | List the related YAML files for use in this YAML file. | |||
| - kind: | Yes | Type of YAML file to be loaded | |||
| name: | Yes | Internal name of YAML file to be loaded | |||
| 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. | |||
| - (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. | |||
| - (string): | Yes | Group name for which to display categories and catalog items | |||
| description: | No | Detailed description | |||
| 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 | - | |||
<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