v1alpha1

Documentation

Overview

Package v1alpha1 is the v1alpha1 version of the API.

Copyright 2022 The Firefly 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.

Copyright 2022 The Firefly 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.

Index

• Constants
• Variables
• func Kind(kind string) schema.GroupKind
• func Resource(resource string) schema.GroupResource
• type Foo
  • func (in *Foo) DeepCopy() *Foo
  • func (in *Foo) DeepCopyInto(out *Foo)
  • func (in *Foo) DeepCopyObject() runtime.Object
• type FooList
  • func (in *FooList) DeepCopy() *FooList
  • func (in *FooList) DeepCopyInto(out *FooList)
  • func (in *FooList) DeepCopyObject() runtime.Object
• type FooSpec
  • func (in *FooSpec) DeepCopy() *FooSpec
  • func (in *FooSpec) DeepCopyInto(out *FooSpec)
• type FooStatus
  • func (in *FooStatus) DeepCopy() *FooStatus
  • func (in *FooStatus) DeepCopyInto(out *FooStatus)
• type Manifest
  • func (in *Manifest) DeepCopy() *Manifest
  • func (in *Manifest) DeepCopyInto(out *Manifest)

Constants

const (
	// FooNamespaceLabel is added to objects to specify associated Foo's namespace.
	FooNamespaceLabel = "foo.toolkit.firefly.io/namespace"

	// FooNameLabel is added to objects to specify associated Foo's name.
	FooNameLabel = "foo.toolkit.firefly.io/name"
)

Variables

var (
	// SchemeBuilder initializes a scheme builder
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	// AddToScheme is a global function that registers this API group & version to a scheme
	AddToScheme = SchemeBuilder.AddToScheme
)

var SchemeGroupVersion = schema.GroupVersion{Group: toolkit.GroupName, Version: "v1alpha1"}

SchemeGroupVersion is group version used to register these objects

Functions

func Kind

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns back a Group qualified GroupKind

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type Foo

type Foo struct {
	metav1.TypeMeta `json:",inline"`
	// Standard object's metadata.
	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// Specification of the desired behavior of the Foo.
	// +optional
	Spec FooSpec `json:"spec"`
	// Most recently observed status of the Foo.
	// +optional
	Status FooStatus `json:"status"`
}

Foo is a specification for a Foo resource

func (*Foo) DeepCopy

func (in *Foo) DeepCopy() *Foo

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

func (*Foo) DeepCopyInto

func (in *Foo) DeepCopyInto(out *Foo)

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

func (*Foo) DeepCopyObject

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

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

type FooList

type FooList struct {
	metav1.TypeMeta `json:",inline"`
	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
	// +optional
	metav1.ListMeta `json:"metadata"`

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

FooList is a list of Foo resources

func (*FooList) DeepCopy

func (in *FooList) DeepCopy() *FooList

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

func (*FooList) DeepCopyInto

func (in *FooList) DeepCopyInto(out *FooList)

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

func (*FooList) DeepCopyObject

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

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

type FooSpec

type FooSpec struct {
	// Manifests represents a list of Kubernetes resources to be deployed on the managed cluster.
	// +optional
	Manifests []Manifest `json:"manifests,omitempty"`
}

FooSpec is the spec for a Foo resource

func (*FooSpec) DeepCopy

func (in *FooSpec) DeepCopy() *FooSpec

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

func (*FooSpec) DeepCopyInto

func (in *FooSpec) DeepCopyInto(out *FooSpec)

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

type FooStatus

type FooStatus struct{}

FooStatus is the status for a Foo resource

func (*FooStatus) DeepCopy

func (in *FooStatus) DeepCopy() *FooStatus

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

func (*FooStatus) DeepCopyInto

func (in *FooStatus) DeepCopyInto(out *FooStatus)

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

type Manifest

type Manifest struct {
	// +kubebuilder:pruning:PreserveUnknownFields
	runtime.RawExtension `json:",inline"`
}

Manifest represents a resource to be deployed on managed cluster.

func (*Manifest) DeepCopy

func (in *Manifest) DeepCopy() *Manifest

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

func (*Manifest) DeepCopyInto

func (in *Manifest) DeepCopyInto(out *Manifest)

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