package api.v1.pipeline

Get desktop application:
View/edit binary Protocol Buffers messages

The service for interacting with the operator pipeline

• rpc WatchObjectStatus (WatchObjectStatusRequest, stream WatchObjectStatusResponse)

  service.proto:9

  message WatchObjectStatusRequest

  service.proto:17

  • string namespace = 1

  message WatchObjectStatusResponse

  service.proto:21

  • optional ObjectStatusChange change = 1

• rpc DryRun (DryRunRequest, DryRunResponse)

  service.proto:12

  message DryRunRequest

  service.proto:25

  • string namespace = 1

  • string capsule = 2

  • string operator_config = 3

    A YAML encoded OperatorConfig, to be used when processing the pipeline.

  • string capsule_spec = 4

    An optional YAML encoded capsule spec, to be used instead of the current one.

  • bool force = 5

    If force is enabled, existing resources will be handled as if they were supposed to be replaced.

  • repeated Object additional_objects = 6

    Additional objects to be considered materialized when performing the dryrun

  message DryRunResponse

  service.proto:40

  • repeated Object input_objects = 1

  • repeated ObjectChange output_objects = 2

• rpc DryRunPluginConfig (DryRunPluginConfigRequest, DryRunPluginConfigResponse)

  service.proto:13

  message DryRunPluginConfigRequest

  service.proto:65

  • string namespace = 1

  • string capsule = 2

  • string operator_config = 3

  • string capsule_spec = 4

  message DryRunPluginConfigResponse

  service.proto:72

  • repeated StepConfig steps = 1

Used in: PlatformObjectStatus

(message has no fields)

Used in: PlatformObjectStatus

(message has no fields)

Used in: PlatformObjectStatus

• uint32 restart_count = 1

• optional ContainerStatus.ContainerTermination last_termination = 2

• optional google.protobuf.Timestamp started_at = 3

• string image = 4

• ContainerType type = 5

Information about the last container termination.

Used in: ContainerStatus

• int32 exit_code = 1

  Exit status from the last termination of the container

• int32 signal = 2

  Signal from the last termination of the container

• string reason = 3

  (brief) reason from the last termination of the container

• string message = 4

  Message regarding the last termination of the container

• optional google.protobuf.Timestamp started_at = 5

  Time at which previous execution of the container started

• optional google.protobuf.Timestamp finished_at = 6

  Time at which the container last terminated

• string container_id = 7

  Container's ID in the format 'type://container_id'

Used in: capsule.instance.ContainerInfo, ContainerStatus

• CONTAINER_TYPE_UNSPECIFIED = 0

• CONTAINER_TYPE_MAIN = 1

• CONTAINER_TYPE_SIDECAR = 2

• CONTAINER_TYPE_INIT = 3

Used in: PlatformObjectStatus

• string schedule = 1

Used in: Object, ObjectRef

• string group = 1

• string version = 2

• string kind = 3

Used in: PlatformObjectStatus

• uint64 rollout_id = 1

• string node = 2

Used in: PlatformObjectStatus

• uint32 port = 2

Different states a job execution can be in

Used in: JobExecutionStatus

• JOB_STATE_UNSPECIFIED = 0

  Default value.

• JOB_STATE_ONGOING = 1

  The job is running.

• JOB_STATE_COMPLETED = 2

  The job completed successfully.

• JOB_STATE_FAILED = 3

  The job failed.

• JOB_STATE_TERMINATED = 4

  The job was terminated.

Used in: PlatformObjectStatus

• string job_name = 1

• uint64 rollout_id = 2

• int32 retries = 3

• optional google.protobuf.Timestamp created_at = 4

• optional google.protobuf.Timestamp finished_at = 5

• JobExecutionState state = 6

Used in: DryRunRequest, DryRunResponse, ObjectChange

• optional GVK gvk = 1

• string name = 2

• string content = 3

Used in: DryRunResponse

• optional Object object = 1

• ObjectOutcome outcome = 2

Used in: ObjectStatusInfo, SubObjectStatus

• string name = 1

• optional google.protobuf.Timestamp updated_at = 2

• ObjectState state = 3

• string message = 4

Used in: ObjectChange

• OBJECT_OUTCOME_UNSPECIFIED = 0

• OBJECT_OUTCOME_CREATE = 1

• OBJECT_OUTCOME_UPDATE = 2

• OBJECT_OUTCOME_DELETE = 3

• OBJECT_OUTCOME_UNCHANGED = 4

• OBJECT_OUTCOME_ALREADY_EXISTS = 5

Used in: ObjectStatus, ObjectStatusChange, plugin.ObjectStatusChange

• optional GVK gvk = 1

• string namespace = 2

• string name = 3

Used in: capsule.CronJobStatus, ObjectCondition

• OBJECT_STATE_UNSPECIFIED = 0

• OBJECT_STATE_HEALTHY = 1

• OBJECT_STATE_PENDING = 2

• OBJECT_STATE_ERROR = 3

Used in: capsule.CapsuleStatus, capsule.ConfigFileStatus, capsule.InterfaceStatus, capsule.InterfaceStatus.Route, ObjectStatusChange, plugin.ObjectStatusChange, plugin.ObjectStatusChange.AllObjects

• optional ObjectRef object_ref = 1

• optional ObjectStatusInfo info = 2

• optional google.protobuf.Timestamp created_at = 5

  The createdTimestamp from the kubernetes object.

• optional google.protobuf.Timestamp updated_at = 3

• optional google.protobuf.Timestamp deletion_at = 6

• optional ObjectRef parent = 4

Used in: WatchObjectStatusResponse

• string capsule = 1

• oneof change

  • ObjectStatus updated = 2

  • ObjectRef deleted = 3

  • ObjectStatusChange.Checkpoint checkpoint = 4

    Checkpoint events indicates that all existing object statuses for this namespace has been sent in the current "watch" session.

Used in: ObjectStatusChange

(message has no fields)

Used in: ObjectStatus

• repeated ObjectCondition conditions = 1

• map<string, string> properties = 2

• repeated SubObjectStatus sub_objects = 3

• repeated PlatformObjectStatus platform_status = 4

Used in: ObjectStatusInfo, SubObjectStatus

• string name = 1

• oneof kind

  • RouteStatus route = 2

  • InstanceStatus instance = 3

  • ContainerStatus container = 4

  • ConfigFileStatus config_file = 5

  • CronjobStatus cronjob = 6

  • CapsuleStatus capsule = 7

  • InterfaceStatus interface = 8

  • JobExecutionStatus job_execution = 9

  • VerticalPodAutoscalerStatus vpa = 10

Used in: StepConfig

• string name = 1

• string config = 2

• string err = 3

Used in: VerticalPodAutoscalerStatus

• uint64 lower_bound = 1

• uint64 target = 2

• uint64 upper_bound = 3

Used in: PlatformObjectStatus

• string id = 1

• string host = 2

• string interface_name = 3

Used in: DryRunPluginConfigResponse

• string name = 1

• repeated PluginConfig plugins = 2

Used in: ObjectStatusInfo

• string name = 1

• repeated ObjectCondition conditions = 3

• map<string, string> properties = 4

• repeated PlatformObjectStatus platform_status = 5

Used in: PlatformObjectStatus

• optional Recommendation cpu_millis = 1

• optional Recommendation memory_bytes = 2