Skip to content

Latest commit

 

History

History
403 lines (224 loc) · 14.2 KB

api-docs.md

File metadata and controls

403 lines (224 loc) · 14.2 KB

API Reference

Packages

operator.tinysystems.io/v1alpha1

Package v1alpha1 contains API Schema definitions for the operator v1alpha1 API group

Resource Types

Position

Underlying type: integer

Appears in:

TinyModule

TinyModule is the Schema for the tinymodules API

Appears in:

Field Description
apiVersion string operator.tinysystems.io/v1alpha1
kind string TinyModule
kind string Kind is a string value representing the REST resource this object represents.

Servers may infer this from the endpoint the client submits requests to.

Cannot be updated.

In CamelCase.

More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
apiVersion string APIVersion defines the versioned schema of this representation of an object.

Servers should convert recognized schemas to the latest internal value, and

may reject unrecognized values.

More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec TinyModuleSpec
status TinyModuleStatus

TinyModuleComponentStatus

Appears in:

Field Description
name string
description string
info string
tags string array

TinyModuleList

TinyModuleList contains a list of TinyModule

Field Description
apiVersion string operator.tinysystems.io/v1alpha1
kind string TinyModuleList
kind string Kind is a string value representing the REST resource this object represents.

Servers may infer this from the endpoint the client submits requests to.

Cannot be updated.

In CamelCase.

More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
apiVersion string APIVersion defines the versioned schema of this representation of an object.

Servers should convert recognized schemas to the latest internal value, and

may reject unrecognized values.

More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
metadata ListMeta Refer to Kubernetes API documentation for fields of metadata.
items TinyModule array

TinyModuleSpec

TinyModuleSpec defines the desired state of TinyModule

Appears in:

Field Description
image string Foo is an example field of TinyModule. Edit tinymodule_types.go to remove/update

TinyModuleStatus

TinyModuleStatus defines the observed state of TinyModule

Appears in:

Field Description
addr string INSERT ADDITIONAL STATUS FIELD - define observed state of cluster

Important: Run "make" to regenerate code after modifying this file
name string
version string
components TinyModuleComponentStatus array

TinyNode

TinyNode is the Schema for the tinynodes API

Appears in:

Field Description
apiVersion string operator.tinysystems.io/v1alpha1
kind string TinyNode
kind string Kind is a string value representing the REST resource this object represents.

Servers may infer this from the endpoint the client submits requests to.

Cannot be updated.

In CamelCase.

More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
apiVersion string APIVersion defines the versioned schema of this representation of an object.

Servers should convert recognized schemas to the latest internal value, and

may reject unrecognized values.

More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec TinyNodeSpec
status TinyNodeStatus

TinyNodeComponentStatus

Appears in:

Field Description
description string
info string
tags string array

TinyNodeEdge

Appears in:

Field Description
id string Edge id
port string Current node's port name

Source port
to string Other node's full port name
flowID string

TinyNodeList

TinyNodeList contains a list of TinyNode

Field Description
apiVersion string operator.tinysystems.io/v1alpha1
kind string TinyNodeList
kind string Kind is a string value representing the REST resource this object represents.

Servers may infer this from the endpoint the client submits requests to.

Cannot be updated.

In CamelCase.

More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
apiVersion string APIVersion defines the versioned schema of this representation of an object.

Servers should convert recognized schemas to the latest internal value, and

may reject unrecognized values.

More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
metadata ListMeta Refer to Kubernetes API documentation for fields of metadata.
items TinyNode array

TinyNodeModuleStatus

Appears in:

Field Description
name string
version string

TinyNodePortConfig

Appears in:

Field Description
from string Settings depend on a sender
port string
schema byte array Schema JSON schema of the port
configuration byte array Configuration JSON data of the port's configuration
flowID string

TinyNodePortStatus

Appears in:

Field Description
name string
label string
position Position
source boolean
schema byte array
configuration byte array

TinyNodeSpec

TinyNodeSpec defines the desired state of TinyNode

Appears in:

Field Description
module string Module name - container image repo + tag
module_version string Module version semver v2 compatible (without v prefix)
component string Component name within a module
ports TinyNodePortConfig array Port configurations
edges TinyNodeEdge array Edges to send message next

TinyNodeStatus

TinyNodeStatus defines the observed state of TinyNode

Appears in:

Field Description
module TinyNodeModuleStatus
component TinyNodeComponentStatus
ports TinyNodePortStatus array
status string
error boolean

TinySignal

TinySignal is the Schema for the tinysignals API

Appears in:

Field Description
apiVersion string operator.tinysystems.io/v1alpha1
kind string TinySignal
kind string Kind is a string value representing the REST resource this object represents.

Servers may infer this from the endpoint the client submits requests to.

Cannot be updated.

In CamelCase.

More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
apiVersion string APIVersion defines the versioned schema of this representation of an object.

Servers should convert recognized schemas to the latest internal value, and

may reject unrecognized values.

More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec TinySignalSpec
status TinySignalStatus

TinySignalList

TinySignalList contains a list of TinySignal

Field Description
apiVersion string operator.tinysystems.io/v1alpha1
kind string TinySignalList
kind string Kind is a string value representing the REST resource this object represents.

Servers may infer this from the endpoint the client submits requests to.

Cannot be updated.

In CamelCase.

More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
apiVersion string APIVersion defines the versioned schema of this representation of an object.

Servers should convert recognized schemas to the latest internal value, and

may reject unrecognized values.

More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
metadata ListMeta Refer to Kubernetes API documentation for fields of metadata.
items TinySignal array

TinySignalSpec

TinySignalSpec defines the desired state of TinySignal

Appears in:

Field Description
node string Foo is an example field of TinySignal. Edit tinysignal_types.go to remove/update
port string
data byte array

TinySignalStatus

TinySignalStatus defines the observed state of TinySignal

Appears in:

TinyTracker

TinyTracker is the Schema for the tinytrackers API

Appears in:

Field Description
apiVersion string operator.tinysystems.io/v1alpha1
kind string TinyTracker
kind string Kind is a string value representing the REST resource this object represents.

Servers may infer this from the endpoint the client submits requests to.

Cannot be updated.

In CamelCase.

More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
apiVersion string APIVersion defines the versioned schema of this representation of an object.

Servers should convert recognized schemas to the latest internal value, and

may reject unrecognized values.

More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec TinyTrackerSpec
status TinyTrackerStatus

TinyTrackerList

TinyTrackerList contains a list of TinyTracker

Field Description
apiVersion string operator.tinysystems.io/v1alpha1
kind string TinyTrackerList
kind string Kind is a string value representing the REST resource this object represents.

Servers may infer this from the endpoint the client submits requests to.

Cannot be updated.

In CamelCase.

More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
apiVersion string APIVersion defines the versioned schema of this representation of an object.

Servers should convert recognized schemas to the latest internal value, and

may reject unrecognized values.

More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
metadata ListMeta Refer to Kubernetes API documentation for fields of metadata.
items TinyTracker array

TinyTrackerSpec

TinyTrackerSpec defines the desired state of Tracker

Appears in:

TinyTrackerStatus

TinyTrackerStatus defines the observed state of TinyTracker

Appears in: