v1alpha2

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
• Variables
• func Resource(resource string) schema.GroupResource
• func SetDefaultsPlatformAdmin(obj *PlatformAdmin)
• type Component
  • func (in *Component) DeepCopy() *Component
  • func (in *Component) DeepCopyInto(out *Component)
• type PlatformAdmin
  • func (in *PlatformAdmin) DeepCopy() *PlatformAdmin
  • func (in *PlatformAdmin) DeepCopyInto(out *PlatformAdmin)
  • func (in *PlatformAdmin) DeepCopyObject() runtime.Object
  • func (c *PlatformAdmin) GetConditions() []PlatformAdminCondition
  • func (*PlatformAdmin) Hub()
  • func (c *PlatformAdmin) SetConditions(conditions []PlatformAdminCondition)
• type PlatformAdminCondition
  • func (in *PlatformAdminCondition) DeepCopy() *PlatformAdminCondition
  • func (in *PlatformAdminCondition) DeepCopyInto(out *PlatformAdminCondition)
• type PlatformAdminConditionSeverity
• type PlatformAdminConditionType
• type PlatformAdminList
  • func (in *PlatformAdminList) DeepCopy() *PlatformAdminList
  • func (in *PlatformAdminList) DeepCopyInto(out *PlatformAdminList)
  • func (in *PlatformAdminList) DeepCopyObject() runtime.Object
• type PlatformAdminSpec
  • func (in *PlatformAdminSpec) DeepCopy() *PlatformAdminSpec
  • func (in *PlatformAdminSpec) DeepCopyInto(out *PlatformAdminSpec)
• type PlatformAdminStatus
  • func (in *PlatformAdminStatus) DeepCopy() *PlatformAdminStatus
  • func (in *PlatformAdminStatus) DeepCopyInto(out *PlatformAdminStatus)

Constants

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

	ConfigmapProvisioningReason = "ConfigmapProvisioning"

	ConfigmapProvisioningFailedReason = "ConfigmapProvisioningFailed"
	// ComponentAvailableCondition documents the status of the PlatformAdmin component.
	ComponentAvailableCondition PlatformAdminConditionType = "ComponentAvailable"

	ComponentProvisioningReason = "ComponentProvisioning"

	ComponentProvisioningFailedReason = "ComponentProvisioningFailed"
)

const (
	// name of finalizer
	PlatformAdminFinalizer = "iot.openyurt.io"

	LabelPlatformAdminGenerate = "iot.openyurt.io/generate"
)

const (
	PlatformAdminPlatformEdgeX = "edgex"
)

PlatformAdmin platform supported by openyurt

Variables

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

	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 Component

type Component struct {
	Name string `json:"name"`
}

Component defines the components of EdgeX

func (*Component) DeepCopy

func (in *Component) DeepCopy() *Component

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

func (*Component) DeepCopyInto

func (in *Component) DeepCopyInto(out *Component)

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

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) 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) Hub

func (*PlatformAdmin) Hub()

Hub marks this type as a conversion hub.

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 PlatformAdmin.

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"`

	// +optional
	Platform string `json:"platform,omitempty"`

	// +optional
	Components []Component `json:"components,omitempty"`

	// +optional
	Security bool `json:"security,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
	ReadyComponentNum int32 `json:"readyComponentNum,omitempty"`

	// +optional
	UnreadyComponentNum int32 `json:"unreadyComponentNum,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.