v1alpha1

package
v1.4.3 Latest Latest
Warning

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

 Go to latest Published: Apr 10, 2024 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Copyright 2023 The OpenYurt Authors.

Licensed under the Apache License, Version 2.0 (the License); you may not use this file except in compliance with the License. You may obtain a copy of the License at 

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an AS IS BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

+groupName=iot.openyurt.io

Index

Constants

View Source 
const (
	// ConfigmapAvailableCondition documents the status of the PlatformAdmin configmap.
	ConfigmapAvailableCondition PlatformAdminConditionType = "ConfigmapAvailable"

	ConfigmapProvisioningReason = "ConfigmapProvisioning"

	ConfigmapProvisioningFailedReason = "ConfigmapProvisioningFailed"
	// ServiceAvailableCondition documents the status of the PlatformAdmin service.
	ServiceAvailableCondition PlatformAdminConditionType = "ServiceAvailable"

	ServiceProvisioningReason = "ServiceProvisioning"

	ServiceProvisioningFailedReason = "ServiceProvisioningFailed"
	// DeploymentAvailableCondition documents the status of the PlatformAdmin deployment.
	DeploymentAvailableCondition PlatformAdminConditionType = "DeploymentAvailable"

	DeploymentProvisioningReason = "DeploymentProvisioning"

	DeploymentProvisioningFailedReason = "DeploymentProvisioningFailed"

	// DeviceSyncedCondition indicates that the device exists in both OpenYurt and edge platform
	DeviceSyncedCondition DeviceConditionType = "DeviceSynced"

	DeviceManagingReason = "This device is not managed by openyurt"

	DeviceCreateSyncedReason = "Failed to create device on edge platform"

	// DeviceManagingCondition indicates that the device is being managed by cloud and its properties are being reconciled
	DeviceManagingCondition DeviceConditionType = "DeviceManaging"

	DeviceVistedCoreMetadataSyncedReason = "Failed to visit the EdgeX core-metadata-service"

	DeviceUpdateStateReason = "Failed to update AdminState or OperatingState of device on edge platform"

	// DeviceServiceSyncedCondition indicates that the deviceService exists in both OpenYurt and edge platform
	DeviceServiceSyncedCondition DeviceServiceConditionType = "DeviceServiceSynced"

	DeviceServiceManagingReason = "This deviceService is not managed by openyurt"

	// DeviceServiceManagingCondition indicates that the deviceService is being managed by cloud and its field are being reconciled
	DeviceServiceManagingCondition DeviceServiceConditionType = "DeviceServiceManaging"

	DeviceServiceCreateSyncedReason = "Failed to add DeviceService to EdgeX"

	DeviceServiceUpdateStatusSyncedReason = "Failed to update DeviceService status"
)
View Source 
const (
	// name of finalizer
	EdgexFinalizer = "edgex.edgexfoundry.org"

	LabelEdgeXGenerate = "www.edgexfoundry.org/generate"
)
View Source 
const (
	DeviceFinalizer = "iot.openyurt.io/device"
)
View Source 
const (
	DeviceProfileFinalizer = "iot.openyurt.io/deviceprofile"
)
View Source 
const (
	DeviceServiceFinalizer = "iot.openyurt.io/deviceservice"
)

Variables

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

	SchemeGroupVersion = GroupVersion

	// 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

func Resource 

func Resource(resource string) schema.GroupResource

Resource is required by pkg/client/listers/...

func SetDefaultsPlatformAdmin 

func SetDefaultsPlatformAdmin(obj *PlatformAdmin)

SetDefaultsPlatformAdmin set default values for PlatformAdmin.

Types

type ActualPropertyState 

type ActualPropertyState struct {
	Name        string `json:"name"`
	GetURL      string `json:"getURL,omitempty"`
	ActualValue string `json:"actualValue"`
}

func (*ActualPropertyState) DeepCopy 

func (in *ActualPropertyState) DeepCopy() *ActualPropertyState

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

func (*ActualPropertyState) DeepCopyInto 

func (in *ActualPropertyState) DeepCopyInto(out *ActualPropertyState)

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

type AdminState 

type AdminState string
const (
	Locked   AdminState = "LOCKED"
	UnLocked AdminState = "UNLOCKED"
)

type DeploymentTemplateSpec 

type DeploymentTemplateSpec struct {
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              appsv1.DeploymentSpec `json:"spec"`
}

DeploymentTemplateSpec defines the pool template of Deployment.

func (*DeploymentTemplateSpec) DeepCopy 

func (in *DeploymentTemplateSpec) DeepCopy() *DeploymentTemplateSpec

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

func (*DeploymentTemplateSpec) DeepCopyInto 

func (in *DeploymentTemplateSpec) DeepCopyInto(out *DeploymentTemplateSpec)

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

type DesiredPropertyState 

type DesiredPropertyState struct {
	Name         string `json:"name"`
	PutURL       string `json:"putURL,omitempty"`
	DesiredValue string `json:"desiredValue"`
}

func (*DesiredPropertyState) DeepCopy 

func (in *DesiredPropertyState) DeepCopy() *DesiredPropertyState

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

func (*DesiredPropertyState) DeepCopyInto 

func (in *DesiredPropertyState) DeepCopyInto(out *DesiredPropertyState)

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

type Device 

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

	Spec   DeviceSpec   `json:"spec,omitempty"`
	Status DeviceStatus `json:"status,omitempty"`
}

Device is the Schema for the devices API

func (*Device) DeepCopy 

func (in *Device) DeepCopy() *Device

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

func (*Device) DeepCopyInto 

func (in *Device) DeepCopyInto(out *Device)

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

func (*Device) DeepCopyObject 

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

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

func (*Device) GetConditions 

func (d *Device) GetConditions() []DeviceCondition

func (*Device) IsAddedToEdgeX 

func (d *Device) IsAddedToEdgeX() bool

func (*Device) SetConditions 

func (d *Device) SetConditions(conditions []DeviceCondition)

type DeviceCommand 

type DeviceCommand struct {
	Name               string              `json:"name"`
	IsHidden           bool                `json:"isHidden"`
	ReadWrite          string              `json:"readWrite"`
	ResourceOperations []ResourceOperation `json:"resourceOperations"`
}

func (*DeviceCommand) DeepCopy 

func (in *DeviceCommand) DeepCopy() *DeviceCommand

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

func (*DeviceCommand) DeepCopyInto 

func (in *DeviceCommand) DeepCopyInto(out *DeviceCommand)

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

type DeviceCondition 

type DeviceCondition struct {
	// Type of in place set condition.
	Type DeviceConditionType `json:"type,omitempty"`

	// Status of the condition, one of True, False, Unknown.
	Status corev1.ConditionStatus `json:"status,omitempty"`

	// Last time the condition transitioned from one status to another.
	LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"`

	// The reason for the condition's last transition.
	Reason string `json:"reason,omitempty"`

	// A human readable message indicating details about the transition.
	Message string `json:"message,omitempty"`
}

DeviceCondition describes current state of a Device.

func (*DeviceCondition) DeepCopy 

func (in *DeviceCondition) DeepCopy() *DeviceCondition

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

func (*DeviceCondition) DeepCopyInto 

func (in *DeviceCondition) DeepCopyInto(out *DeviceCondition)

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

type DeviceConditionType 

type DeviceConditionType string

DeviceConditionType indicates valid conditions type of a Device.

type DeviceList 

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

DeviceList contains a list of Device

func (*DeviceList) DeepCopy 

func (in *DeviceList) DeepCopy() *DeviceList

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

func (*DeviceList) DeepCopyInto 

func (in *DeviceList) DeepCopyInto(out *DeviceList)

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

func (*DeviceList) DeepCopyObject 

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

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

type DeviceProfile 

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

	Spec   DeviceProfileSpec   `json:"spec,omitempty"`
	Status DeviceProfileStatus `json:"status,omitempty"`
}

DeviceProfile represents the attributes and operational capabilities of a device. It is a template for which there can be multiple matching devices within a given system. NOTE This struct is derived from edgex/go-mod-core-contracts/models/deviceprofile.go

func (*DeviceProfile) DeepCopy 

func (in *DeviceProfile) DeepCopy() *DeviceProfile

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

func (*DeviceProfile) DeepCopyInto 

func (in *DeviceProfile) DeepCopyInto(out *DeviceProfile)

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

func (*DeviceProfile) DeepCopyObject 

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

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

func (*DeviceProfile) IsAddedToEdgeX 

func (dp *DeviceProfile) IsAddedToEdgeX() bool

type DeviceProfileList 

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

DeviceProfileList contains a list of DeviceProfile

func (*DeviceProfileList) DeepCopy 

func (in *DeviceProfileList) DeepCopy() *DeviceProfileList

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

func (*DeviceProfileList) DeepCopyInto 

func (in *DeviceProfileList) DeepCopyInto(out *DeviceProfileList)

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

func (*DeviceProfileList) DeepCopyObject 

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

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

type DeviceProfileSpec 

type DeviceProfileSpec struct {
	// NodePool specifies which nodePool the deviceProfile belongs to
	NodePool    string `json:"nodePool,omitempty"`
	Description string `json:"description,omitempty"`
	// Manufacturer of the device
	Manufacturer string `json:"manufacturer,omitempty"`
	// Model of the device
	Model string `json:"model,omitempty"`
	// Labels used to search for groups of profiles on EdgeX Foundry
	Labels          []string         `json:"labels,omitempty"`
	DeviceResources []DeviceResource `json:"deviceResources,omitempty"`
	DeviceCommands  []DeviceCommand  `json:"deviceCommands,omitempty"`
}

DeviceProfileSpec defines the desired state of DeviceProfile

func (*DeviceProfileSpec) DeepCopy 

func (in *DeviceProfileSpec) DeepCopy() *DeviceProfileSpec

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

func (*DeviceProfileSpec) DeepCopyInto 

func (in *DeviceProfileSpec) DeepCopyInto(out *DeviceProfileSpec)

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

type DeviceProfileStatus 

type DeviceProfileStatus struct {
	EdgeId string `json:"id,omitempty"`
	Synced bool   `json:"synced,omitempty"`
}

DeviceProfileStatus defines the observed state of DeviceProfile

func (*DeviceProfileStatus) DeepCopy 

func (in *DeviceProfileStatus) DeepCopy() *DeviceProfileStatus

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

func (*DeviceProfileStatus) DeepCopyInto 

func (in *DeviceProfileStatus) DeepCopyInto(out *DeviceProfileStatus)

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

type DeviceResource 

type DeviceResource struct {
	Description string             `json:"description"`
	Name        string             `json:"name"`
	Tag         string             `json:"tag,omitempty"`
	IsHidden    bool               `json:"isHidden"`
	Properties  ResourceProperties `json:"properties"`
	Attributes  map[string]string  `json:"attributes,omitempty"`
}

func (*DeviceResource) DeepCopy 

func (in *DeviceResource) DeepCopy() *DeviceResource

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

func (*DeviceResource) DeepCopyInto 

func (in *DeviceResource) DeepCopyInto(out *DeviceResource)

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

type DeviceService 

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

	Spec   DeviceServiceSpec   `json:"spec,omitempty"`
	Status DeviceServiceStatus `json:"status,omitempty"`
}

DeviceService is the Schema for the deviceservices API

func (*DeviceService) DeepCopy 

func (in *DeviceService) DeepCopy() *DeviceService

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

func (*DeviceService) DeepCopyInto 

func (in *DeviceService) DeepCopyInto(out *DeviceService)

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

func (*DeviceService) DeepCopyObject 

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

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

func (*DeviceService) GetConditions 

func (ds *DeviceService) GetConditions() []DeviceServiceCondition

func (*DeviceService) SetConditions 

func (ds *DeviceService) SetConditions(conditions []DeviceServiceCondition)

type DeviceServiceCondition 

type DeviceServiceCondition struct {
	// Type of in place set condition.
	Type DeviceServiceConditionType `json:"type,omitempty"`

	// Status of the condition, one of True, False, Unknown.
	Status corev1.ConditionStatus `json:"status,omitempty"`

	// Last time the condition transitioned from one status to another.
	LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"`

	// The reason for the condition's last transition.
	Reason string `json:"reason,omitempty"`

	// A human readable message indicating details about the transition.
	Message string `json:"message,omitempty"`
}

DeviceServiceCondition describes current state of a Device.

func (*DeviceServiceCondition) DeepCopy 

func (in *DeviceServiceCondition) DeepCopy() *DeviceServiceCondition

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

func (*DeviceServiceCondition) DeepCopyInto 

func (in *DeviceServiceCondition) DeepCopyInto(out *DeviceServiceCondition)

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

type DeviceServiceConditionType 

type DeviceServiceConditionType string

DeviceServiceConditionType indicates valid conditions type of a Device Service.

type DeviceServiceList 

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

DeviceServiceList contains a list of DeviceService

func (*DeviceServiceList) DeepCopy 

func (in *DeviceServiceList) DeepCopy() *DeviceServiceList

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

func (*DeviceServiceList) DeepCopyInto 

func (in *DeviceServiceList) DeepCopyInto(out *DeviceServiceList)

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

func (*DeviceServiceList) DeepCopyObject 

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

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

type DeviceServiceSpec 

type DeviceServiceSpec struct {
	BaseAddress string `json:"baseAddress"`
	// Information describing the device
	Description string `json:"description,omitempty"`
	// tags or other labels applied to the device service for search or other
	// identification needs on the EdgeX Foundry
	Labels []string `json:"labels,omitempty"`
	// Device Service Admin State
	AdminState AdminState `json:"adminState,omitempty"`
	// True means deviceService is managed by cloud, cloud can update the related fields
	// False means cloud can't update the fields
	Managed bool `json:"managed,omitempty"`
	// NodePool indicates which nodePool the deviceService comes from
	NodePool string `json:"nodePool,omitempty"`
}

DeviceServiceSpec defines the desired state of DeviceService

func (*DeviceServiceSpec) DeepCopy 

func (in *DeviceServiceSpec) DeepCopy() *DeviceServiceSpec

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

func (*DeviceServiceSpec) DeepCopyInto 

func (in *DeviceServiceSpec) DeepCopyInto(out *DeviceServiceSpec)

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

type DeviceServiceStatus 

type DeviceServiceStatus struct {
	// Synced indicates whether the device already exists on both OpenYurt and edge platform
	Synced bool `json:"synced,omitempty"`
	// the Id assigned by the edge platform
	EdgeId string `json:"edgeId,omitempty"`
	// time in milliseconds that the device last reported data to the core
	LastConnected int64 `json:"lastConnected,omitempty"`
	// time in milliseconds that the device last reported data to the core
	LastReported int64 `json:"lastReported,omitempty"`
	// Device Service Admin State
	AdminState AdminState `json:"adminState,omitempty"`
	// current deviceService state
	// +optional
	Conditions []DeviceServiceCondition `json:"conditions,omitempty"`
}

DeviceServiceStatus defines the observed state of DeviceService

func (*DeviceServiceStatus) DeepCopy 

func (in *DeviceServiceStatus) DeepCopy() *DeviceServiceStatus

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

func (*DeviceServiceStatus) DeepCopyInto 

func (in *DeviceServiceStatus) DeepCopyInto(out *DeviceServiceStatus)

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

type DeviceSpec 

type DeviceSpec struct {
	// Information describing the device
	Description string `json:"description,omitempty"`
	// Admin state (locked/unlocked)
	AdminState AdminState `json:"adminState,omitempty"`
	// Operating state (enabled/disabled)
	OperatingState OperatingState `json:"operatingState,omitempty"`
	// A map of supported protocols for the given device
	Protocols map[string]ProtocolProperties `json:"protocols,omitempty"`
	// Other labels applied to the device to help with searching
	Labels []string `json:"labels,omitempty"`
	// Device service specific location (interface{} is an empty interface so
	// it can be anything)
	// TODO: location type in edgex is interface{}
	Location string `json:"location,omitempty"`
	// Associated Device Service - One per device
	Service string `json:"serviceName"`
	// Associated Device Profile - Describes the device
	Profile string `json:"profileName"`
	Notify  bool   `json:"notify"`
	// True means device is managed by cloud, cloud can update the related fields
	// False means cloud can't update the fields
	Managed bool `json:"managed,omitempty"`
	// NodePool indicates which nodePool the device comes from
	NodePool string `json:"nodePool,omitempty"`
	// TODO support the following field
	// A list of auto-generated events coming from the device
	// AutoEvents     []AutoEvent                   `json:"autoEvents"`
	// DeviceProperties represents the expected state of the device's properties
	DeviceProperties map[string]DesiredPropertyState `json:"deviceProperties,omitempty"`
}

DeviceSpec defines the desired state of Device

func (*DeviceSpec) DeepCopy 

func (in *DeviceSpec) DeepCopy() *DeviceSpec

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

func (*DeviceSpec) DeepCopyInto 

func (in *DeviceSpec) DeepCopyInto(out *DeviceSpec)

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

type DeviceStatus 

type DeviceStatus struct {
	// Time (milliseconds) that the device last provided any feedback or
	// responded to any request
	LastConnected int64 `json:"lastConnected,omitempty"`
	// Time (milliseconds) that the device reported data to the core
	// microservice
	LastReported int64 `json:"lastReported,omitempty"`
	// Synced indicates whether the device already exists on both OpenYurt and edge platform
	Synced bool `json:"synced,omitempty"`
	// it represents the actual state of the device's properties
	DeviceProperties map[string]ActualPropertyState `json:"deviceProperties,omitempty"`
	EdgeId           string                         `json:"edgeId,omitempty"`
	// Admin state (locked/unlocked)
	AdminState AdminState `json:"adminState,omitempty"`
	// Operating state (up/down/unknown)
	OperatingState OperatingState `json:"operatingState,omitempty"`
	// current device state
	// +optional
	Conditions []DeviceCondition `json:"conditions,omitempty"`
}

DeviceStatus defines the observed state of Device

func (*DeviceStatus) DeepCopy 

func (in *DeviceStatus) DeepCopy() *DeviceStatus

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

func (*DeviceStatus) DeepCopyInto 

func (in *DeviceStatus) DeepCopyInto(out *DeviceStatus)

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

type OperatingState 

type OperatingState string
const (
	Unknown OperatingState = "UNKNOWN"
	Up      OperatingState = "UP"
	Down    OperatingState = "DOWN"
)

type PlatformAdmin 

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

	Spec   PlatformAdminSpec   `json:"spec,omitempty"`
	Status PlatformAdminStatus `json:"status,omitempty"`
}

PlatformAdmin is the Schema for the samples API

func (*PlatformAdmin) ConvertFrom 

func (dst *PlatformAdmin) ConvertFrom(srcRaw conversion.Hub) error

func (*PlatformAdmin) ConvertTo 

func (src *PlatformAdmin) ConvertTo(dstRaw conversion.Hub) error

func (*PlatformAdmin) DeepCopy 

func (in *PlatformAdmin) DeepCopy() *PlatformAdmin

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

func (*PlatformAdmin) DeepCopyInto 

func (in *PlatformAdmin) DeepCopyInto(out *PlatformAdmin)

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

func (*PlatformAdmin) DeepCopyObject 

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

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

func (*PlatformAdmin) GetConditions 

func (c *PlatformAdmin) GetConditions() []PlatformAdminCondition

func (*PlatformAdmin) SetConditions 

func (c *PlatformAdmin) SetConditions(conditions []PlatformAdminCondition)

type PlatformAdminCondition 

type PlatformAdminCondition struct {
	// Type of in place set condition.
	Type PlatformAdminConditionType `json:"type,omitempty"`

	// Status of the condition, one of True, False, Unknown.
	Status corev1.ConditionStatus `json:"status,omitempty"`

	// Last time the condition transitioned from one status to another.
	LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"`

	// The reason for the condition's last transition.
	Reason string `json:"reason,omitempty"`

	// A human readable message indicating details about the transition.
	Message string `json:"message,omitempty"`
}

PlatformAdminCondition describes current state of a PlatformAdmin.

func (*PlatformAdminCondition) DeepCopy 

func (in *PlatformAdminCondition) DeepCopy() *PlatformAdminCondition

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

func (*PlatformAdminCondition) DeepCopyInto 

func (in *PlatformAdminCondition) DeepCopyInto(out *PlatformAdminCondition)

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

type PlatformAdminConditionSeverity 

type PlatformAdminConditionSeverity string

type PlatformAdminConditionType 

type PlatformAdminConditionType string

PlatformAdminConditionType indicates valid conditions type of a iot platform.

type PlatformAdminList 

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

PlatformAdminList contains a list of PlatformAdmin

func (*PlatformAdminList) DeepCopy 

func (in *PlatformAdminList) DeepCopy() *PlatformAdminList

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

func (*PlatformAdminList) DeepCopyInto 

func (in *PlatformAdminList) DeepCopyInto(out *PlatformAdminList)

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

func (*PlatformAdminList) DeepCopyObject 

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

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

type PlatformAdminSpec 

type PlatformAdminSpec struct {
	Version string `json:"version,omitempty"`

	ImageRegistry string `json:"imageRegistry,omitempty"`

	PoolName string `json:"poolName,omitempty"`

	ServiceType corev1.ServiceType `json:"serviceType,omitempty"`
	// +optional
	AdditionalService []ServiceTemplateSpec `json:"additionalServices,omitempty"`

	// +optional
	AdditionalDeployment []DeploymentTemplateSpec `json:"additionalDeployments,omitempty"`
}

PlatformAdminSpec defines the desired state of PlatformAdmin

func (*PlatformAdminSpec) DeepCopy 

func (in *PlatformAdminSpec) DeepCopy() *PlatformAdminSpec

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

func (*PlatformAdminSpec) DeepCopyInto 

func (in *PlatformAdminSpec) DeepCopyInto(out *PlatformAdminSpec)

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

type PlatformAdminStatus 

type PlatformAdminStatus struct {
	// +optional
	Ready bool `json:"ready,omitempty"`
	// +optional
	Initialized bool `json:"initialized,omitempty"`
	// +optional
	ServiceReplicas int32 `json:"serviceReplicas,omitempty"`
	// +optional
	ServiceReadyReplicas int32 `json:"serviceReadyReplicas,omitempty"`
	// +optional
	DeploymentReplicas int32 `json:"deploymentReplicas,omitempty"`
	// +optional
	DeploymentReadyReplicas int32 `json:"deploymentReadyReplicas,omitempty"`

	// Current PlatformAdmin state
	// +optional
	Conditions []PlatformAdminCondition `json:"conditions,omitempty"`
}

PlatformAdminStatus defines the observed state of PlatformAdmin

func (*PlatformAdminStatus) DeepCopy 

func (in *PlatformAdminStatus) DeepCopy() *PlatformAdminStatus

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

func (*PlatformAdminStatus) DeepCopyInto 

func (in *PlatformAdminStatus) DeepCopyInto(out *PlatformAdminStatus)

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

type ProtocolProperties 

type ProtocolProperties map[string]string

func (ProtocolProperties) DeepCopy 

func (in ProtocolProperties) DeepCopy() ProtocolProperties

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

func (ProtocolProperties) DeepCopyInto 

func (in ProtocolProperties) DeepCopyInto(out *ProtocolProperties)

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

type ResourceOperation 

type ResourceOperation struct {
	DeviceResource string            `json:"deviceResource,omitempty"`
	Mappings       map[string]string `json:"mappings,omitempty"`
	DefaultValue   string            `json:"defaultValue"`
}

func (*ResourceOperation) DeepCopy 

func (in *ResourceOperation) DeepCopy() *ResourceOperation

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

func (*ResourceOperation) DeepCopyInto 

func (in *ResourceOperation) DeepCopyInto(out *ResourceOperation)

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

type ResourceProperties 

type ResourceProperties struct {
	ReadWrite    string `json:"readWrite,omitempty"`    // Read/Write Permissions set for this property
	Minimum      string `json:"minimum,omitempty"`      // Minimum value that can be get/set from this property
	Maximum      string `json:"maximum,omitempty"`      // Maximum value that can be get/set from this property
	DefaultValue string `json:"defaultValue,omitempty"` // Default value set to this property if no argument is passed
	Mask         string `json:"mask,omitempty"`         // Mask to be applied prior to get/set of property
	Shift        string `json:"shift,omitempty"`        // Shift to be applied after masking, prior to get/set of property
	Scale        string `json:"scale,omitempty"`        // Multiplicative factor to be applied after shifting, prior to get/set of property
	Offset       string `json:"offset,omitempty"`       // Additive factor to be applied after multiplying, prior to get/set of property
	Base         string `json:"base,omitempty"`         // Base for property to be applied to, leave 0 for no power operation (i.e. base ^ property: 2 ^ 10)
	Assertion    string `json:"assertion,omitempty"`
	MediaType    string `json:"mediaType,omitempty"`
	Units        string `json:"units,omitempty"`
	ValueType    string `json:"valueType,omitempty"`
}

func (*ResourceProperties) DeepCopy 

func (in *ResourceProperties) DeepCopy() *ResourceProperties

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

func (*ResourceProperties) DeepCopyInto 

func (in *ResourceProperties) DeepCopyInto(out *ResourceProperties)

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

type ServiceTemplateSpec 

type ServiceTemplateSpec struct {
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              corev1.ServiceSpec `json:"spec"`
}

DeploymentTemplateSpec defines the pool template of Deployment.

func (*ServiceTemplateSpec) DeepCopy 

func (in *ServiceTemplateSpec) DeepCopy() *ServiceTemplateSpec

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

func (*ServiceTemplateSpec) DeepCopyInto 

func (in *ServiceTemplateSpec) DeepCopyInto(out *ServiceTemplateSpec)

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.