Aligned attributes of CDS components
[ccsdk/cds.git] / components / model-catalog / definition-type / starter-type / node_type / component-remote-ansible-executor.json
1 {
2   "description": "This is Remote Ansible Playbook (AWX) Execution Component.",
3   "version": "1.0.0",
4   "attributes": {
5     "ansible-command-status": {
6       "required": true,
7       "type": "string"
8     },
9     "ansible-command-logs": {
10       "required": true,
11       "type": "string"
12     },
13     "ansible-artifacts": {
14       "required": false,
15       "type": "json"
16     }
17   },
18   "capabilities": {
19     "component-node": {
20       "type": "tosca.capabilities.Node"
21     }
22   },
23   "interfaces": {
24     "ComponentRemoteAnsibleExecutor": {
25       "operations": {
26         "process": {
27           "inputs": {
28             "job-template-name": {
29               "description": "Primary key or name of the job template to launch new job.",
30               "required": false,
31               "type": "string"
32             },
33             "ansible-fire-failure": {
34               "description": "ansible fire failue status ",
35               "required": false,
36               "type": "boolean"
37             },
38             "workflow-job-template-id": {
39               "description": "Primary key (name not supported) of the workflow job template to launch new job.",
40               "required": false,
41               "type": "string"
42             },
43             "limit": {
44               "description": "Specify host limit for job template to run.",
45               "required": false,
46               "type": "string"
47             },
48             "inventory": {
49               "description": "Specify inventory for job template to run.",
50               "required": false,
51               "type": "string"
52             },
53             "extra-vars" : {
54               "required" : false,
55               "type" : "json",
56               "description": "json formatted text that contains extra variables to pass on."
57             },
58             "tags": {
59               "description": "Specify tagged actions in the playbook to run.",
60               "required": false,
61               "type": "string"
62             },
63             "skip-tags": {
64               "description": "Specify tagged actions in the playbook to omit.",
65               "required": false,
66               "type": "string"
67             },
68             "endpoint-selector": {
69               "description": "Remote AWX Server selector name.",
70               "required": true,
71               "type": "string"
72             }
73           },
74           "outputs": {
75             "response-data": {
76               "description": "Execution Response Data.",
77               "required": false,
78               "type": "string"
79             },
80             "status": {
81               "description": "Status of the Component Execution ( success or failure )",
82               "required": true,
83               "type": "string"
84             }
85           }
86         }
87       }
88     }
89   },
90   "derived_from": "tosca.nodes.Component"
91 }