v1alpha1

package
v0.0.0-...-5ccf328 Latest Latest
Warning

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

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

Documentation

Index

Constants

View Source 
const Version = "v1alpha1"

Version of group.

+k8s:deepcopy-gen=package +k8s:openapi-gen=true +groupName=tko.nephio.org

Variables

View Source 
var AddInternalToScheme = internalSchemeBuilder.AddToScheme

Adds all our internally-versioned types to a scheme.

View Source 
var AddToScheme = schemeBuilder.AddToScheme

Adds all our types to a scheme. Note: kube_codegen *requires* it to be named "AddToScheme".

View Source 
var InternalSchemeGroupVersion = schema.GroupVersion{Group: krmgroup.GroupName, Version: runtime.APIVersionInternal}

Internal Group-Version.

View Source 
var SchemeGroupVersion = schema.GroupVersion{Group: krmgroup.GroupName, Version: Version}

Group-Version. Note: kube_codegen *requires* it to be named "SchemeGroupVersion".

Functions

func Kind 

func Kind(kind string) schema.GroupKind

Kind to Group-Kind. Note: kube_codegen *requires* it to be called "Kind".

func Resource 

func Resource(resource string) schema.GroupResource

Resource name to Group-Resource. For both singular and plural resource names. Note: kube_codegen *requires* it to be named "Resource".

Types

type Deployment 

type Deployment struct {
	meta.TypeMeta   `json:",inline"`
	meta.ObjectMeta `json:"metadata,omitempty"`

	Spec   DeploymentSpec   `json:"spec,omitempty"`
	Status DeploymentStatus `json:"status,omitempty"`
}

TKO deployment.

Note that the deployment metadata is represented as ObjectMeta labels.

+genclient +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

func (*Deployment) DeepCopy 

func (in *Deployment) DeepCopy() *Deployment

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

func (*Deployment) DeepCopyInto 

func (in *Deployment) DeepCopyInto(out *Deployment)

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

func (*Deployment) DeepCopyObject 

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

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

type DeploymentList 

type DeploymentList struct {
	meta.TypeMeta `json:",inline"`
	meta.ListMeta `json:"metadata,omitempty"`

	Items []Deployment `json:"items"`
}

+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

func (*DeploymentList) DeepCopy 

func (in *DeploymentList) DeepCopy() *DeploymentList

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

func (*DeploymentList) DeepCopyInto 

func (in *DeploymentList) DeepCopyInto(out *DeploymentList)

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

func (*DeploymentList) DeepCopyObject 

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

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

type DeploymentSpec 

type DeploymentSpec struct {
	// (Read only) Deployment ID. A random UUID generated when the
	// deployment is created.
	// +optional
	DeploymentId *string `json:"deploymentId,omitempty"`

	// ID of the deployment that created this deployment during the
	// preparation process.
	// +optional
	ParentDeploymentId *string `json:"parentDeploymentId,omitempty"`

	// ID of the template from which this deployment was created.
	// +optional
	TemplateId *string `json:"templateId,omitempty"`

	// ID of the site with which this deployment is associated.
	// +optional
	SiteId *string `json:"siteId,omitempty"`

	// Deployment KRM package. When "prepared" is true the KRM must be
	// completely valid. Otherwise, the KRM must be at least *partially*
	// valid, meaning that required properties at any level of nesting are
	// allowed to be missing, but properties that are assigned must have
	// valid values.
	// +optional
	Package *Package `json:"package,omitempty"`
}

func (*DeploymentSpec) DeepCopy 

func (in *DeploymentSpec) DeepCopy() *DeploymentSpec

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

func (*DeploymentSpec) DeepCopyInto 

func (in *DeploymentSpec) DeepCopyInto(out *DeploymentSpec)

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

type DeploymentStatus 

type DeploymentStatus struct {
	// True if this deployment is prepared.
	// +optional
	Prepared *bool `json:"prepared"`

	// True if this deployment is approved. Cannot be true if
	// "prepared" is false.
	// +optional
	Approved *bool `json:"approved"`
}

func (*DeploymentStatus) DeepCopy 

func (in *DeploymentStatus) DeepCopy() *DeploymentStatus

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

func (*DeploymentStatus) DeepCopyInto 

func (in *DeploymentStatus) DeepCopyInto(out *DeploymentStatus)

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

type Package 

type Package struct {
	// KRM package contents.
	Resources []ard.StringMap `json:"resources,omitempty"`
}

KRM package.

func (*Package) DeepCopy 

func (self *Package) DeepCopy() *Package

func (*Package) DeepCopyInto 

func (self *Package) DeepCopyInto(out *Package)

func (Package) OpenAPIDefinition 

func (_ Package) OpenAPIDefinition() openapi.OpenAPIDefinition

type Plugin 

type Plugin struct {
	meta.TypeMeta   `json:",inline"`
	meta.ObjectMeta `json:"metadata,omitempty"`

	Spec   PluginSpec   `json:"spec,omitempty"`
	Status PluginStatus `json:"status,omitempty"`
}

TKO plugin.

+genclient +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

func (*Plugin) DeepCopy 

func (in *Plugin) DeepCopy() *Plugin

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

func (*Plugin) DeepCopyInto 

func (in *Plugin) DeepCopyInto(out *Plugin)

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

func (*Plugin) DeepCopyObject 

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

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

type PluginList 

type PluginList struct {
	meta.TypeMeta `json:",inline"`
	meta.ListMeta `json:"metadata,omitempty"`

	Items []Plugin `json:"items"`
}

+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

func (*PluginList) DeepCopy 

func (in *PluginList) DeepCopy() *PluginList

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

func (*PluginList) DeepCopyInto 

func (in *PluginList) DeepCopyInto(out *PluginList)

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

func (*PluginList) DeepCopyObject 

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

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

type PluginSpec 

type PluginSpec struct {
	// Can be "validate", "prepare", or "schedule".
	Type *string `json:"type,omitempty"`

	// Plugin ID. Must be unique per "type" per TKO instance.
	// +optional
	PluginId *string `json:"pluginId,omitempty"`

	// Plugin executor. Each executor has its own requirements for
	// "arguments" and "properties".
	Executor *string `json:"executor,omitempty"`

	// Sequence of arguments for the executor.
	// +optional
	Arguments []string `json:"arguments,omitempty"`

	// Map of properties for the executor.
	// +optional
	Properties map[string]string `json:"properties,omitempty"`

	// List of KRM types (GVK) that trigger this plugin.
	// +optional
	Triggers []Trigger `json:"triggers,omitempty"`
}

func (*PluginSpec) DeepCopy 

func (in *PluginSpec) DeepCopy() *PluginSpec

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

func (*PluginSpec) DeepCopyInto 

func (in *PluginSpec) DeepCopyInto(out *PluginSpec)

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

type PluginStatus 

type PluginStatus struct {
}

func (*PluginStatus) DeepCopy 

func (in *PluginStatus) DeepCopy() *PluginStatus

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

func (*PluginStatus) DeepCopyInto 

func (in *PluginStatus) DeepCopyInto(out *PluginStatus)

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

type Site 

type Site struct {
	meta.TypeMeta   `json:",inline"`
	meta.ObjectMeta `json:"metadata,omitempty"`

	Spec   SiteSpec   `json:"spec,omitempty"`
	Status SiteStatus `json:"status,omitempty"`
}

TKO site.

Note that the site metadata is represented as ObjectMeta labels.

+genclient +genclient:nonNamespaced +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

func (*Site) DeepCopy 

func (in *Site) DeepCopy() *Site

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

func (*Site) DeepCopyInto 

func (in *Site) DeepCopyInto(out *Site)

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

func (*Site) DeepCopyObject 

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

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

type SiteList 

type SiteList struct {
	meta.TypeMeta `json:",inline"`
	meta.ListMeta `json:"metadata,omitempty"`

	Items []Site `json:"items"`
}

+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

func (*SiteList) DeepCopy 

func (in *SiteList) DeepCopy() *SiteList

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

func (*SiteList) DeepCopyInto 

func (in *SiteList) DeepCopyInto(out *SiteList)

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

func (*SiteList) DeepCopyObject 

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

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

type SiteSpec 

type SiteSpec struct {
	// Site ID. Must be unique per TKO instance.
	// +optional
	SiteId *string `json:"siteId,omitempty"`

	// ID of the template from which this site was created.
	// +optional
	TemplateId *string `json:"templateId,omitempty"`

	// Site KRM package. The KRM must be completely valid.
	// +optional
	Package *Package `json:"package,omitempty"`
}

func (*SiteSpec) DeepCopy 

func (in *SiteSpec) DeepCopy() *SiteSpec

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

func (*SiteSpec) DeepCopyInto 

func (in *SiteSpec) DeepCopyInto(out *SiteSpec)

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

type SiteStatus 

type SiteStatus struct {
	// (Read only) IDs of deployments associated with this site.
	// +optional
	DeploymentIds []string `json:"deploymentIds,omitempty"`
}

func (*SiteStatus) DeepCopy 

func (in *SiteStatus) DeepCopy() *SiteStatus

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

func (*SiteStatus) DeepCopyInto 

func (in *SiteStatus) DeepCopyInto(out *SiteStatus)

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

type Template 

type Template struct {
	meta.TypeMeta   `json:",inline"`
	meta.ObjectMeta `json:"metadata,omitempty"`

	Spec   TemplateSpec   `json:"spec,omitempty"`
	Status TemplateStatus `json:"status,omitempty"`
}

TKO template.

Note that the template metadata is represented as ObjectMeta labels.

+genclient +genclient:nonNamespaced +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

func (*Template) DeepCopy 

func (in *Template) DeepCopy() *Template

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

func (*Template) DeepCopyInto 

func (in *Template) DeepCopyInto(out *Template)

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

func (*Template) DeepCopyObject 

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

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

type TemplateList 

type TemplateList struct {
	meta.TypeMeta `json:",inline"`
	meta.ListMeta `json:"metadata,omitempty"`

	Items []Template `json:"items"`
}

+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

func (*TemplateList) DeepCopy 

func (in *TemplateList) DeepCopy() *TemplateList

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

func (*TemplateList) DeepCopyInto 

func (in *TemplateList) DeepCopyInto(out *TemplateList)

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

func (*TemplateList) DeepCopyObject 

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

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

type TemplateSpec 

type TemplateSpec struct {
	// Template ID. Must be unique per TKO instance.
	// +optional
	TemplateId *string `json:"templateId,omitempty"`

	// Template KRM package. The KRM must be at least *partially* valid,
	// meaning that required properties at any level of nesting are allowed
	// to be missing, but properties that are assigned must have valid
	// values.
	// +optional
	Package *Package `json:"package,omitempty"`
}

func (*TemplateSpec) DeepCopy 

func (in *TemplateSpec) DeepCopy() *TemplateSpec

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

func (*TemplateSpec) DeepCopyInto 

func (in *TemplateSpec) DeepCopyInto(out *TemplateSpec)

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

type TemplateStatus 

type TemplateStatus struct {
	// (Read only) IDs of deployments created from this template.
	// +optional
	DeploymentIds []string `json:"deploymentIds,omitempty"`
}

func (*TemplateStatus) DeepCopy 

func (in *TemplateStatus) DeepCopy() *TemplateStatus

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

func (*TemplateStatus) DeepCopyInto 

func (in *TemplateStatus) DeepCopyInto(out *TemplateStatus)

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

type Trigger 

type Trigger struct {
	Group   string `json:"group"`
	Version string `json:"version"`
	Kind    string `json:"kind"`
}

func (*Trigger) DeepCopy 

func (in *Trigger) DeepCopy() *Trigger

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

func (*Trigger) DeepCopyInto 

func (in *Trigger) DeepCopyInto(out *Trigger)

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.