Operation v1alpha1 (v1.0.5)

proto source

Operation

Operation is a specification for a Operation CRD

FieldTypeLabelDescription
typek8s.io.apimachinery.pkg.apis.meta.v1.TypeMetaType of this resource
metadatak8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta(required)
specOperationSpecSpec of this resource (required)
statusOperationStatusStatus of this resource

OperationList

OperationList is a struct holding items of this resource

FieldTypeLabelDescription
typek8s.io.apimachinery.pkg.apis.meta.v1.TypeMetaType of this resource (required)
metadatak8s.io.apimachinery.pkg.apis.meta.v1.ListMeta(required)
itemsOperationrepeatedItems is a list of this resource (required)

OperationSpec

OperationSpec contains the spec of a Operation

FieldTypeLabelDescription
agentNamestringAgentName is a request to schedule this operation onto a specific agent. If it is non-empty, an agent responsible (by matching metadata of this operation) simply assigns this onto itself.
procedureKindstringProcedureKind is a request to schedule this operation onto a specific agent capable of running this procedure kind. If it is non-empty, the agent responsible assigns his type.
procedurestringProcedure is the requested command or referenced identifier (depending on the implementation) to be executed. (required)
argumentsgoogle.protobuf.ValueArguments for the procedure (schemaless)
versionstringVersion defines the interface version for the procedure-arguments signature
cancelboolCancel forces the execution of the procedure to be forcefully stopped, if already running. If not yet running, the assigned operator ignores the execution and set it to Closed.

OperationStatus

NodeStatus is the status for this resource

FieldTypeLabelDescription
conditionsStatusConditionrepeatedConditions for the status
phasestringPhase represent the current state of the operation (required)
valuesgoogle.protobuf.ValueThe procedure on the agent returned the following additional data. How they are collected is documented in the used agent. What data is expected and how they are used is defined by the procedure interface. (schemaless)
closedboolClosed marks this operation closed and agents must not process this resource

StatusCondition

StatusCondition contains details for the current condition of this resource.

FieldTypeLabelDescription
typestringType is the type of the condition. (required)
satisfiedstringSatisfied is the status of the condition. Can be True, False, Unknown. (required)
reasonstringUnique, one-word, CamelCase reason for the condition's last transition.
messagestringHuman-readable message indicating details about last transition.

Scalar Value Types

.proto TypeNotesC++JavaPythonGoC#PHPRuby
doubledoubledoublefloatfloat64doublefloatFloat
floatfloatfloatfloatfloat32floatfloatFloat
int32Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.int32intintint32intintegerBignum or Fixnum (as required)
int64Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.int64longint/longint64longinteger/stringBignum
uint32Uses variable-length encoding.uint32intint/longuint32uintintegerBignum or Fixnum (as required)
uint64Uses variable-length encoding.uint64longint/longuint64ulonginteger/stringBignum or Fixnum (as required)
sint32Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.int32intintint32intintegerBignum or Fixnum (as required)
sint64Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.int64longint/longint64longinteger/stringBignum
fixed32Always four bytes. More efficient than uint32 if values are often greater than 2^28.uint32intintuint32uintintegerBignum or Fixnum (as required)
fixed64Always eight bytes. More efficient than uint64 if values are often greater than 2^56.uint64longint/longuint64ulonginteger/stringBignum
sfixed32Always four bytes.int32intintint32intintegerBignum or Fixnum (as required)
sfixed64Always eight bytes.int64longint/longint64longinteger/stringBignum
boolboolbooleanbooleanboolboolbooleanTrueClass/FalseClass
stringA string must always contain UTF-8 encoded or 7-bit ASCII text.stringStringstr/unicodestringstringstringString (UTF-8)
bytesMay contain any arbitrary sequence of bytes.stringByteStringstr[]byteByteStringstringString (ASCII-8BIT)