Opspec

Opspec (portmanteau of operation specification) is a language designed to portably and fully define operations (ops).

Structure

Each op is defined as a directory.

Reference:

• {OP_DIRECTORY}
  • op.yml

    • name

    • description

    • inputs/outputs

      • {PARAMETER_NAME}

        • description

        and one of...

        • array
          • constraints
          • default
          • isSecret
        • boolean
          • default
        • dir
          • default
          • isSecret
        • file
          • default
          • isSecret
        • number
          • constraints
          • default
          • isSecret
        • object
          • constraints
          • default
          • isSecret
        • socket
          • isSecret
        • string
          • constraints
          • default
          • isSecret

    • opspec

    • run

      • if

        one of...

        • eq
        • exists
        • gt
        • gte
        • lt
        • lte
        • ne
        • notExists

      • name

      • needs

      one of...

      • container
        • cmd
        • dirs
        • envVars
        • files
        • image
          • ref
          • platform
          • pullCreds
        • name
        • sockets
        • workDir
      • op
        • inputs
        • outputs
        • pullCreds
        • ref
      • parallel
      • parallelLoop
        • range
        • run
        • vars
      • serial
      • serialLoop
        • range
        • run
        • until
        • vars

    • version

  • icon.svg

Types

Values in opspec are typed.

Reference:

• array
• boolean
• dir
• file
• number
• object
• socket
• string

Scoping

Variables in opspec are scoped to each operation. Parameters allow passing values into or out of this scope.