Opctl

Opctl describing an op

Type object
File match **/.opspec/*/*.yml **/.opspec/*/*.yaml
Schema URL https://catalog.lintel.tools/schemas/schemastore/opctl/latest.json
Source https://www.schemastore.org/opspec-io-0.1.7.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Defines an op

Properties

name string required

Name of the op

description description

Description of the op

inputs object

Parameter of an op

outputs object

Parameter of an op

run object

A single node of the call graph

One of: variant, variant, variant, variant, variant, variant
7 nested properties
container object
9 nested properties
image object required
2 nested properties
ref 1 required

Reference to an image

pullCreds object

Credentials used during authentication with the source of an image or op

cmd 1[]

Command run by a container; overrides any set at the image level

dirs object

Directories in the container

envVars object | string

Environment variables in the container

files object

Files in the container

name array | boolean | number | object | string

Name the container can be referenced by from other containers

ports object

Ports bound from the container to the host

sockets object
workDir string

Working directory path (overrides any defined by image)

if object[]

If any predicate evaluates to false, the call will be skipped.

op object
4 nested properties
ref string required

Reference to an op

format=uri-reference
inputs object

Initializes INPUT_NAME from VALUE in format 'INPUT_NAME: VALUE'. If VALUE is null, it MUST be assumed VALUE == $(INPUT_NAME)

outputs object

Initializes NAME from OUTPUT_NAME in format 'NAME: OUTPUT_NAME'. If OUTPUT_NAME is null, it MUST be assumed NAME == OUTPUT_NAME

pullCreds object

Credentials used during authentication with the source of an image or op

2 nested properties
username 1 required

Expression coercible to string value

password 1 required

Expression coercible to string value

parallel run[]
parallelLoop object

Loop in which all iterations are called simultaneously.

3 nested properties
range array | object | string required

Range of the loop, i.e. the value to loop over

run object required

A single node of the call graph

One of: variant, variant, variant, variant, variant, variant
7 nested properties
container object
if object[]

If any predicate evaluates to false, the call will be skipped.

op object
parallel run[]
parallelLoop object

Loop in which all iterations are called simultaneously.

serial run[]
serialLoop object

Loop in which each iteration gets called sequentially.

One of: variant, variant
vars object

Variables added to scope on each iteration

3 nested properties
index string

Variable each iterations associated key will be made available through

pattern=^[-_.a-zA-Z0-9]+$
key string

Variable each iterations associated key will be made available through

pattern=^[-_.a-zA-Z0-9]+$
value string

Variable each iterations associated key will be made available through

pattern=^[-_.a-zA-Z0-9]+$
serial run[]
serialLoop object

Loop in which each iteration gets called sequentially.

One of: variant, variant
4 nested properties
range array | object | string

Range of the loop, i.e. the value to loop over

run object

A single node of the call graph

One of: variant, variant, variant, variant, variant, variant
7 nested properties
container object
if object[]

If any predicate evaluates to false, the call will be skipped.

op object
parallel run[]
parallelLoop object

Loop in which all iterations are called simultaneously.

serial run[]
serialLoop object

Loop in which each iteration gets called sequentially.

One of: variant, variant
until items[]

Exit condition of the loop; evaluated before each iteration.

vars object

Variables added to scope on each iteration

3 nested properties
index string

Variable each iterations associated key will be made available through

pattern=^[-_.a-zA-Z0-9]+$
key string

Variable each iterations associated key will be made available through

pattern=^[-_.a-zA-Z0-9]+$
value string

Variable each iterations associated key will be made available through

pattern=^[-_.a-zA-Z0-9]+$
version string

Version of opspec used by the op

pattern=^([0-9]+)\.([0-9]+)\.([0-9]+)(?:(-[0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*))?(?:\+[0-9A-Za-z-\-\.]+)?$
opspec string

Version of opspec used by the op

pattern=^([0-9]+)\.([0-9]+)\.([0-9]+)(?:(-[0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*))?(?:\+[0-9A-Za-z-\-\.]+)?$