Skip to content

Latest commit

 

History

History
291 lines (256 loc) · 8.82 KB

pipelines.md

File metadata and controls

291 lines (256 loc) · 8.82 KB

GST Pipelines CRD Reference

Packages:

Types

pipelines.gst.io/v1

Package v1 file doc.go required for the doc generator to register this as an API

Resource Types:

Job

Job is the Schema for the jobs API

Field Description
metadata Kubernetes metav1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.
spec JobSpec

pipelineRef metav1.PipelineReference

A reference to the pipeline for this job’s configuration.

src metav1.Object

The source object for the pipeline.

sinks metav1.Object

The output objects for the pipeline.

status JobStatus

JobSpec

(Appears on: Job)

JobSpec defines the desired state of Job

Field Description
pipelineRef metav1.PipelineReference

A reference to the pipeline for this job’s configuration.

src metav1.Object

The source object for the pipeline.

sinks metav1.Object

The output objects for the pipeline.

JobState (string alias)

JobState represents the state of a pipeline job.

SplitTransform

SplitTransform is the Schema for the splittransforms API

Field Description
metadata Kubernetes metav1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.
spec SplitTransformSpec

globals metav1.SourceSinkConfig

Global configurations to apply when omitted from the src or sink configurations.

src metav1.SourceSinkConfig

Configurations for src object to the pipeline.

video metav1.SourceSinkConfig

Configurations for video stream outputs. The linkto field in the pipeline config should be present with the value video-out to direct an element to this output.

audio metav1.SourceSinkConfig

Configurations for audio stream outputs. The linkto field in the pipeline config should be present with the value audio-out to direct an element to this output.

pipeline metav1.PipelineConfig

The configuration for the processing pipeline

status SplitTransformStatus

SplitTransformSpec

(Appears on: SplitTransform)

SplitTransformSpec defines the desired state of SplitTransform. Note that due to current implementation, the various streams can be directed to different buckets, but they have to be buckets accessible via the same MinIO/S3 server(s).

Field Description
globals metav1.SourceSinkConfig

Global configurations to apply when omitted from the src or sink configurations.

src metav1.SourceSinkConfig

Configurations for src object to the pipeline.

video metav1.SourceSinkConfig

Configurations for video stream outputs. The linkto field in the pipeline config should be present with the value video-out to direct an element to this output.

audio metav1.SourceSinkConfig

Configurations for audio stream outputs. The linkto field in the pipeline config should be present with the value audio-out to direct an element to this output.

pipeline metav1.PipelineConfig

The configuration for the processing pipeline

Transform

Transform is the Schema for the transforms API

Field Description
metadata Kubernetes metav1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.
spec TransformSpec

globals metav1.SourceSinkConfig

Global configurations to apply when omitted from the src or sink configurations.

src metav1.SourceSinkConfig

Configurations for src object to the pipeline.

sink metav1.SourceSinkConfig

Configurations for sink objects from the pipeline.

pipeline metav1.PipelineConfig

The configuration for the processing pipeline

status TransformStatus

TransformSpec

(Appears on: Transform)

TransformSpec defines the desired state of Transform

Field Description
globals metav1.SourceSinkConfig

Global configurations to apply when omitted from the src or sink configurations.

src metav1.SourceSinkConfig

Configurations for src object to the pipeline.

sink metav1.SourceSinkConfig

Configurations for sink objects from the pipeline.

pipeline metav1.PipelineConfig

The configuration for the processing pipeline


Generated with gen-crd-api-reference-docs on git commit aa0a239.