v1

Documentation

Overview

Copyright 2019 The Kubernetes 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.

Package v1 contains API Schema definitions for the apps v1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:defaulter-gen=TypeMet +groupName=apps.open-cluster-management.io

Package v1 contains API Schema definitions for the apps v1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:defaulter-gen=TypeMeta +groupName=apps.open-cluster-management.io

Index

• Constants
• Variables
• func GetOpenAPIDefinitions(ref common.ReferenceCallback) map[string]common.OpenAPIDefinition
• func Resource(resource string) schema.GroupResource
• type Channel
  • func (in *Channel) DeepCopy() *Channel
  • func (in *Channel) DeepCopyInto(out *Channel)
  • func (in *Channel) DeepCopyObject() runtime.Object
• type ChannelGate
  • func (in *ChannelGate) DeepCopy() *ChannelGate
  • func (in *ChannelGate) DeepCopyInto(out *ChannelGate)
• type ChannelList
  • func (in *ChannelList) DeepCopy() *ChannelList
  • func (in *ChannelList) DeepCopyInto(out *ChannelList)
  • func (in *ChannelList) DeepCopyObject() runtime.Object
• type ChannelSpec
  • func (in *ChannelSpec) DeepCopy() *ChannelSpec
  • func (in *ChannelSpec) DeepCopyInto(out *ChannelSpec)
• type ChannelStatus
  • func (in *ChannelStatus) DeepCopy() *ChannelStatus
  • func (in *ChannelStatus) DeepCopyInto(out *ChannelStatus)
• type ChannelType

Constants

const (
	// ChannelTypeNamespace defines type name of namespace channel
	ChannelTypeNamespace = "namespace"
	// ChannelTypeHelmRepo defines type name of helm repository channel
	ChannelTypeHelmRepo = "helmrepo"
	// ChannelTypeObjectBucket defines type name of bucket in object store
	ChannelTypeObjectBucket = "objectbucket"
	// ChannelTypeGitHub defines type name of GitHub repository
	ChannelTypeGitHub = "github"
)

Variables

var (
	// KeyChannelSource is namespacedname tells the source of the deployable
	KeyChannelSource = SchemeGroupVersion.Group + "/hosting-deployable"
	// KeyChannel is namespacedname tells the source of the channel
	KeyChannel = SchemeGroupVersion.Group + "/channel"
	// KeyChannelType is the type of the source of the channel
	KeyChannelType = SchemeGroupVersion.Group + "/channel-type"
	// KeyChannelPath is the filter reference path of GitHub type channel
	KeyChannelPath = SchemeGroupVersion.Group + "/channel-path"
	// ServingChannel tells the channel that the secrect or configMap refers to
	ServingChannel = SchemeGroupVersion.Group + "/serving-channel"
)

EDIT THIS FILE! THIS IS SCAFFOLDING FOR YOU TO OWN! NOTE: json tags are required. Any new fields you add must have json tags for the fields to be serialized.

var (
	// SchemeGroupVersion is group version used to register these objects
	SchemeGroupVersion = schema.GroupVersion{Group: apiGroup, Version: "v1"}

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

	// AddToScheme is required by pkg/client/...
	AddToScheme = SchemeBuilder.AddToScheme
)

Functions

func GetOpenAPIDefinitions

func GetOpenAPIDefinitions(ref common.ReferenceCallback) map[string]common.OpenAPIDefinition

func Resource

func Resource(resource string) schema.GroupResource

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

Types

type Channel

type Channel struct {
	Status            ChannelStatus `json:"status,omitempty"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              ChannelSpec `json:"spec,omitempty"`
	metav1.TypeMeta   `json:",inline"`
}

Channel is the Schema for the channels API +k8s:openapi-gen=true +kubebuilder:printcolumn:name="Type",type="string",JSONPath=".spec.type",description="type of the channel" +kubebuilder:printcolumn:name="Pathname",type="string",JSONPath=".spec.pathname",description="pathname of the channel" +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp" +kubebuilder:resource:scope=Namespaced

func (*Channel) DeepCopy

func (in *Channel) DeepCopy() *Channel

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

func (*Channel) DeepCopyInto

func (in *Channel) DeepCopyInto(out *Channel)

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

func (*Channel) DeepCopyObject

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

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

type ChannelGate

type ChannelGate struct {
	Name          string                `json:"name,omitempty"`
	LabelSelector *metav1.LabelSelector `json:"labelSelector,omitempty"`
	Annotations   map[string]string     `json:"annotations,omitempty"`
}

ChannelGate defines criteria for promote to channel

func (*ChannelGate) DeepCopy

func (in *ChannelGate) DeepCopy() *ChannelGate

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

func (*ChannelGate) DeepCopyInto

func (in *ChannelGate) DeepCopyInto(out *ChannelGate)

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

type ChannelList

type ChannelList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	// +listType=set
	Items []Channel `json:"items"`
}

ChannelList contains a list of Channel

func (*ChannelList) DeepCopy

func (in *ChannelList) DeepCopy() *ChannelList

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

func (*ChannelList) DeepCopyInto

func (in *ChannelList) DeepCopyInto(out *ChannelList)

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

func (*ChannelList) DeepCopyObject

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

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

type ChannelSpec

type ChannelSpec struct {
	// INSERT ADDITIONAL SPEC FIELDS - desired state of cluster
	// Important: Run "make" to regenerate code after modifying this file
	// +kubebuilder:validation:Enum={Namespace,HelmRepo,ObjectBucket,GitHub,namespace,helmrepo,objectbucket,github}
	Type         ChannelType             `json:"type"`
	Pathname     string                  `json:"pathname"`
	SecretRef    *corev1.ObjectReference `json:"secretRef,omitempty"`
	ConfigMapRef *corev1.ObjectReference `json:"configMapRef,omitempty"`
	Gates        *ChannelGate            `json:"gates,omitempty"`
	// +listType=set
	SourceNamespaces []string `json:"sourceNamespaces,omitempty"`
}

ChannelSpec defines the desired state of Channel

func (*ChannelSpec) DeepCopy

func (in *ChannelSpec) DeepCopy() *ChannelSpec

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

func (*ChannelSpec) DeepCopyInto

func (in *ChannelSpec) DeepCopyInto(out *ChannelSpec)

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

type ChannelStatus

type ChannelStatus struct {
}

ChannelStatus defines the observed state of Channel

func (*ChannelStatus) DeepCopy

func (in *ChannelStatus) DeepCopy() *ChannelStatus

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

func (*ChannelStatus) DeepCopyInto

func (in *ChannelStatus) DeepCopyInto(out *ChannelStatus)

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

type ChannelType

type ChannelType string

ChannelType defines types of channel