v1alpha1

package
v0.3.0-rc2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 12, 2022 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the shifu v1alpha1 API group +kubebuilder:object:generate=true +groupName=shifu.edgenesis.io

Index

Constants

This section is empty.

Variables

View Source 
var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "shifu.edgenesis.io", Version: "v1alpha1"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

Functions

This section is empty.

Types

type Connection 

type Connection string

Connection specifies the EdgeDevice-EdgeNode connection type. 

const (
	// ConnectionEthernet String
	ConnectionEthernet Connection = "Ethernet"
)

type EdgeDevice 

type EdgeDevice struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   EdgeDeviceSpec   `json:"spec,omitempty"`
	Status EdgeDeviceStatus `json:"status,omitempty"`
}

EdgeDevice is the Schema for the edgedevices API

func (*EdgeDevice) DeepCopy 

func (in *EdgeDevice) DeepCopy() *EdgeDevice

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EdgeDevice.

func (*EdgeDevice) DeepCopyInto 

func (in *EdgeDevice) DeepCopyInto(out *EdgeDevice)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*EdgeDevice) DeepCopyObject 

func (in *EdgeDevice) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type EdgeDeviceList 

type EdgeDeviceList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []EdgeDevice `json:"items"`
}

EdgeDeviceList contains a list of EdgeDevice

func (*EdgeDeviceList) DeepCopy 

func (in *EdgeDeviceList) DeepCopy() *EdgeDeviceList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EdgeDeviceList.

func (*EdgeDeviceList) DeepCopyInto 

func (in *EdgeDeviceList) DeepCopyInto(out *EdgeDeviceList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*EdgeDeviceList) DeepCopyObject 

func (in *EdgeDeviceList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type EdgeDevicePhase 

type EdgeDevicePhase string

EdgeDevicePhase is a simple, high-level summary of where the EdgeDevice is in its lifecycle. 

const (
	// EdgeDevicePending means the EdgeDevice has been accepted by the system but not ready yet.
	EdgeDevicePending EdgeDevicePhase = "Pending"
	// EdgeDeviceRunning means the EdgeDevice is able to interact with the system and user applications.
	EdgeDeviceRunning EdgeDevicePhase = "Running"
	// EdgeDeviceFailed means the EdgeDevice is failed state.
	EdgeDeviceFailed EdgeDevicePhase = "Failed"
	// EdgeDeviceUnknown means the EdgeDevice's info could not be obtained.
	// This is typically due to communication failures.
	EdgeDeviceUnknown EdgeDevicePhase = "Unknown"
)

type EdgeDeviceSpec 

type EdgeDeviceSpec struct {

	// Sku specifies the EdgeDevice's SKU.
	Sku              *string            `json:"sku,omitempty"`
	Connection       *Connection        `json:"connection,omitempty"`
	Address          *string            `json:"address,omitempty"`
	Protocol         *Protocol          `json:"protocol,omitempty"`
	ProtocolSettings *ProtocolSettings  `json:"protocolSettings,omitempty"`
	CustomMetadata   *map[string]string `json:"customMetadata,omitempty"`
}

EdgeDeviceSpec defines the desired state of EdgeDevice

func (*EdgeDeviceSpec) DeepCopy 

func (in *EdgeDeviceSpec) DeepCopy() *EdgeDeviceSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EdgeDeviceSpec.

func (*EdgeDeviceSpec) DeepCopyInto 

func (in *EdgeDeviceSpec) DeepCopyInto(out *EdgeDeviceSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type EdgeDeviceStatus 

type EdgeDeviceStatus struct {
	EdgeDevicePhase *EdgeDevicePhase `json:"edgedevicephase,omitempty"`
}

EdgeDeviceStatus defines the observed state of EdgeDevice

func (*EdgeDeviceStatus) DeepCopy 

func (in *EdgeDeviceStatus) DeepCopy() *EdgeDeviceStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EdgeDeviceStatus.

func (*EdgeDeviceStatus) DeepCopyInto 

func (in *EdgeDeviceStatus) DeepCopyInto(out *EdgeDeviceStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Encoding added in v0.2.0 

type Encoding string
const (
	UTF8 Encoding = "utf-8"
	HEX  Encoding = "hex"
)

SocketEncodingStr

type HTTPSetting 

type HTTPSetting struct {
	Username *string `json:"username,omitempty"`
	Password *string `json:"password,omitempty"`
}

HTTPSetting defines HTTP specific settings when connecting to an EdgeDevice

func (*HTTPSetting) DeepCopy 

func (in *HTTPSetting) DeepCopy() *HTTPSetting

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HTTPSetting.

func (*HTTPSetting) DeepCopyInto 

func (in *HTTPSetting) DeepCopyInto(out *HTTPSetting)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type MQTTSetting 

type MQTTSetting struct {
	MQTTTopic         *string `json:"MQTTTopic,omitempty"`
	MQTTServerAddress *string `json:"MQTTServerAddress,omitempty"`
	MQTTServerSecret  *string `json:"MQTTServerSecret,omitempty"`
}

MQTTSetting defines MQTT specific settings when connecting to an EdgeDevice

func (*MQTTSetting) DeepCopy 

func (in *MQTTSetting) DeepCopy() *MQTTSetting

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MQTTSetting.

func (*MQTTSetting) DeepCopyInto 

func (in *MQTTSetting) DeepCopyInto(out *MQTTSetting)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type OPCUASetting 

type OPCUASetting struct {
	OPCUAEndpoint                   *string `json:"OPCUAEndpoint,omitempty"`
	SecurityMode                    *string `json:"SecurityMode,omitempty"`
	AuthenticationMode              *string `json:"AuthenticationMode,omitempty"`
	CertificateFileName             *string `json:"CertificateFileName,omitempty"`
	PrivateKeyFileName              *string `json:"PrivateKeyFileName,omitempty"`
	ConfigmapName                   *string `json:"ConfigmapName,omitempty"`
	IssuedToken                     *string `json:"IssuedToken,omitempty"`
	SecurityPolicy                  *string `json:"SecurityPolicy,omitempty"`
	Username                        *string `json:"Username,omitempty"`
	Password                        *string `json:"Password,omitempty"`
	ConnectionTimeoutInMilliseconds *int64  `json:"ConnectionTimeoutInMilliseconds,omitempty"`
}

OPCUASetting defines OPC UA specific settings when connecting to an OPC UA endpoint

func (*OPCUASetting) DeepCopy 

func (in *OPCUASetting) DeepCopy() *OPCUASetting

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OPCUASetting.

func (*OPCUASetting) DeepCopyInto 

func (in *OPCUASetting) DeepCopyInto(out *OPCUASetting)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type PLC4XSetting added in v0.3.0 

type PLC4XSetting struct {
	Protocol *Plc4xProtocol `json:"protocol,omitempty"`
}

func (*PLC4XSetting) DeepCopy added in v0.3.0 

func (in *PLC4XSetting) DeepCopy() *PLC4XSetting

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PLC4XSetting.

func (*PLC4XSetting) DeepCopyInto added in v0.3.0 

func (in *PLC4XSetting) DeepCopyInto(out *PLC4XSetting)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Plc4xProtocol added in v0.3.0 

type Plc4xProtocol string
const (
	Plc4xProtocolS7          Plc4xProtocol = "s7"
	Plc4xProtocolADS         Plc4xProtocol = "ads"
	Plc4xProtocolBACnet      Plc4xProtocol = "bacnet"
	Plc4xProtocolCBus        Plc4xProtocol = "cbus"
	Plc4xProtocolEip         Plc4xProtocol = "eip"
	Plc4xProtocolKnx         Plc4xProtocol = "knx"
	Plc4xProtocolModbusAscii Plc4xProtocol = "modbus-ascii"
	Plc4xProtocolModbusRTU   Plc4xProtocol = "modbus-rtu"
	Plc4xProtocolModbusTcp   Plc4xProtocol = "modbus-tcp"
)

type Protocol 

type Protocol string

Protocol specifies the EdgeDevice's communication protocol. 

const (
	ProtocolHTTP            Protocol = "HTTP"
	ProtocolHTTPCommandline Protocol = "HTTPCommandline"
	ProtocolMQTT            Protocol = "MQTT"
	ProtocolOPCUA           Protocol = "OPCUA"
	ProtocolSocket          Protocol = "Socket"
	ProtocolPLC4X           Protocol = "PLC4X"
	ProtocolUSB             Protocol = "USB"
)

Protocol String

type ProtocolSettings 

type ProtocolSettings struct {
	MQTTSetting   *MQTTSetting   `json:"MQTTSetting,omitempty"`
	OPCUASetting  *OPCUASetting  `json:"OPCUASetting,omitempty"`
	SocketSetting *SocketSetting `json:"SocketSetting,omitempty"`
	PLC4XSetting  *PLC4XSetting  `json:"PLC4XSetting,omitempty"`
}

ProtocolSettings defines protocol settings when connecting to an EdgeDevice

func (*ProtocolSettings) DeepCopy 

func (in *ProtocolSettings) DeepCopy() *ProtocolSettings

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProtocolSettings.

func (*ProtocolSettings) DeepCopyInto 

func (in *ProtocolSettings) DeepCopyInto(out *ProtocolSettings)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ServiceSettings 

type ServiceSettings struct {
	HTTPSetting *HTTPSetting `json:"HTTPSetting,omitempty"`
}

ServiceSettings defines service settings on telemetry

func (*ServiceSettings) DeepCopy 

func (in *ServiceSettings) DeepCopy() *ServiceSettings

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ServiceSettings.

func (*ServiceSettings) DeepCopyInto 

func (in *ServiceSettings) DeepCopyInto(out *ServiceSettings)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type SocketSetting 

type SocketSetting struct {
	// +kubebuilder:default="utf-8"
	Encoding *Encoding `json:"encoding,omitempty"`
	// +kubebuilder:default=1024
	BufferLength *int    `json:"bufferLength,omitempty"`
	NetworkType  *string `json:"networkType,omitempty"`
}

SocketSetting defines Socket specific settings when connecting to an EdgeDevice

func (*SocketSetting) DeepCopy 

func (in *SocketSetting) DeepCopy() *SocketSetting

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SocketSetting.

func (*SocketSetting) DeepCopyInto 

func (in *SocketSetting) DeepCopyInto(out *SocketSetting)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type TelemetryService 

type TelemetryService struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   TelemetryServiceSpec   `json:"spec,omitempty"`
	Status TelemetryServiceStatus `json:"status,omitempty"`
}

TelemetryService is the Schema for the telemetryservices API

func (*TelemetryService) DeepCopy 

func (in *TelemetryService) DeepCopy() *TelemetryService

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TelemetryService.

func (*TelemetryService) DeepCopyInto 

func (in *TelemetryService) DeepCopyInto(out *TelemetryService)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*TelemetryService) DeepCopyObject 

func (in *TelemetryService) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type TelemetryServiceList 

type TelemetryServiceList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []TelemetryService `json:"items"`
}

TelemetryServiceList contains a list of TelemetryService

func (*TelemetryServiceList) DeepCopy 

func (in *TelemetryServiceList) DeepCopy() *TelemetryServiceList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TelemetryServiceList.

func (*TelemetryServiceList) DeepCopyInto 

func (in *TelemetryServiceList) DeepCopyInto(out *TelemetryServiceList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*TelemetryServiceList) DeepCopyObject 

func (in *TelemetryServiceList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type TelemetryServiceSpec 

type TelemetryServiceSpec struct {
	Type            *string            `json:"type,omitempty"`
	Address         *string            `json:"address,omitempty"`
	ServiceSettings *ServiceSettings   `json:"serviceSettings,omitempty"`
	CustomMetadata  *map[string]string `json:"customMetadata,omitempty"`
}

TelemetryServiceSpec defines the desired state of TelemetryService

func (*TelemetryServiceSpec) DeepCopy 

func (in *TelemetryServiceSpec) DeepCopy() *TelemetryServiceSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TelemetryServiceSpec.

func (*TelemetryServiceSpec) DeepCopyInto 

func (in *TelemetryServiceSpec) DeepCopyInto(out *TelemetryServiceSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type TelemetryServiceStatus 

type TelemetryServiceStatus struct {
	// INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
	// Important: Run "make" to regenerate code after modifying this file
	TelemetryServicePhase *EdgeDevicePhase `json:"telemetryservicephase,omitempty"`
}

TelemetryServiceStatus defines the observed state of TelemetryService

func (*TelemetryServiceStatus) DeepCopy 

func (in *TelemetryServiceStatus) DeepCopy() *TelemetryServiceStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TelemetryServiceStatus.

func (*TelemetryServiceStatus) DeepCopyInto 

func (in *TelemetryServiceStatus) DeepCopyInto(out *TelemetryServiceStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.