API Reference
Packages
tensorstack.dev/v1beta1
Package v1beta1 contains API Schema definitions for the v1beta1 API group
Resource Types
DataCube
DataCube is the Schema for the datacubes API
Appears in:
| Field | Description |
|---|---|
apiVersion string | tensorstack.dev/v1beta1 |
kind string | DataCube |
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. |
spec DataCubeSpec | |
status DataCubeStatus |
DataCubeCondition
DataCubeCondition contains details for the current condition of this datacube
Appears in:
| Field | Description |
|---|---|
type DataCubeConditionType | Type is the type of the condition. |
status ConditionStatus | Status is the status of the condition. Can be True, False, Unknown. |
lastProbeTime Time | Last time we probed the condition. |
lastTransitionTime Time | Last time the condition transitioned from one status to another. |
reason string | Unique, one-word, CamelCase reason for the condition's last transition. |
message string | Human-readable message indicating details about last transition. |
DataCubeConditionType
Underlying type: string
DataCubeConditionType defines all possible types of DataCubeStatus. Can be one of: Initialized, Complete, or Failed.
Appears in:
DataCubeList
DataCubeList contains a list of DataCube
| Field | Description |
|---|---|
apiVersion string | tensorstack.dev/v1beta1 |
kind string | DataCubeList |
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. |
items DataCube array |
DataCubePhase
Underlying type: string
Appears in:
DataCubeSpec
DataCubeSpec defines the desired state of DataCube
Appears in:
| Field | Description |
|---|---|
source DataReference | Source defines where the data is stored |
sink DataReference | Sink defines where the data will be transferred to |
executor ExecutorReference | Executor defines how the data will be transferred |
DataCubeStatus
DataCubeStatus defines the observed state of DataCube
Appears in:
| Field | Description |
|---|---|
phase DataCubePhase | The phase of this datacube. |
conditions DataCubeCondition array | Conditions represent an array of current conditions observed within the system. |
pod PodStatus | The status of the underlying Pod |
DataReference
Appears in:
| Field | Description |
|---|---|
type DataType | Type of the data |
options EnvVar array | Options for the data |
pvc PVCReference | Data in pvc |
DataType
Underlying type: string
Appears in:
ExecutorOptions
Appears in:
| Field | Description |
|---|---|
sync boolean | Whether to sync data, if false, use copy |
backoffLimit integer | Specifies the number of retries before marking this datacube failed. Defaults to 0. |
activeDeadlineSeconds integer | Specifies the duration in seconds relative to the startTime that the datacube may be active before the system tries to terminate it; value must be positive integer |
extraArgs string array | Extra args appended to executed command |
ExecutorReference
Appears in:
| Field | Description |
|---|---|
options ExecutorOptions | Options of executor |
env EnvVar array | Env of executor's contianer |
securityContext PodSecurityContext | SecurityContext of executor's container |
PVCReference
Appears in:
| Field | Description |
|---|---|
name string | Name of PVC |
subPath string | Path within PVC |
template PersistentVolumeClaimTemplate | Template to create pvc if not exist, only avaliable when uploading |
PodReference
PodReference references a K8s v1.Pod.
Appears in:
| Field | Description |
|---|---|
name string | Name of the Pod. |
uid string | UID of the Pod. |
PodStatus
PodStatus defines the observed status of the Pod running file transfer.
Appears in:
| Field | Description |
|---|---|
reference PodReference | References to the subordinate v1.Pod. |
phase PodPhase | Replicated from the corresponding field in the subordinate v1.Pod. |
status string |