6.11. Service

Defines a long running container application which can support multiple operators in parallel. Clara Deploy SDK will ensure that any service declared as required by a pipeline’s operator(s) is running before starting the execution of any of a pipeline’s operator(s).

The service type is derived from the document type.

6.11.1. Properties

6.11.1.1. api-version

type: string

Version of Clara Deploy SDK expected by the service.

See document (inherited) for details.

6.11.1.2. connections

type: object

Declares the methods by which an operator can communicate with a service. Clara Deploy SDK supports HTTP/network and volume mounted connections.

6.11.1.3. container

type: object

Required information necessary for Clara Deploy SDK to locate, initialize, and execute the services’s container application.

See container for details.

6.11.1.4. description

type: string

Human readable description of the service.

6.11.1.5. name

type: string

Unique name of the service. When imported into a pipeline, can be overwritten by the local name property value.

See document (inherited) for details.

See names for additional information about name in Clara Deploy SDK pipeline definitions.

6.11.1.6. requests

type: object

Hardware minimum requirements required by the service to function.

See requests for details.

6.11.1.7. variables

type: object

Set of environment variables which will be available to the services container application.

See variables for details.