v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the config.porch.kpt.dev v1alpha1 API group +kubebuilder:object:generate=true +groupName=config.porch.kpt.dev

Index

• Variables
• type AggregatedStatus
  • func (in *AggregatedStatus) DeepCopy() *AggregatedStatus
  • func (in *AggregatedStatus) DeepCopyInto(out *AggregatedStatus)
• type ClusterRef
  • func (in *ClusterRef) DeepCopy() *ClusterRef
  • func (in *ClusterRef) DeepCopyInto(out *ClusterRef)
  • func (r *ClusterRef) GetAPIVersion() string
  • func (r *ClusterRef) GetKind() string
  • func (r *ClusterRef) GetName() string
  • func (r *ClusterRef) GetNamespace() string
• type OCISpec
  • func (in *OCISpec) DeepCopy() *OCISpec
  • func (in *OCISpec) DeepCopyInto(out *OCISpec)
  • func (o *OCISpec) GetRepository() string
• type PackageRef
  • func (in *PackageRef) DeepCopy() *PackageRef
  • func (in *PackageRef) DeepCopyInto(out *PackageRef)
  • func (r *PackageRef) GetName() string
• type RemoteRootSyncSet
  • func (in *RemoteRootSyncSet) DeepCopy() *RemoteRootSyncSet
  • func (in *RemoteRootSyncSet) DeepCopyInto(out *RemoteRootSyncSet)
  • func (in *RemoteRootSyncSet) DeepCopyObject() runtime.Object
  • func (o *RemoteRootSyncSet) GetSpec() *RemoteRootSyncSetSpec
• type RemoteRootSyncSetList
  • func (in *RemoteRootSyncSetList) DeepCopy() *RemoteRootSyncSetList
  • func (in *RemoteRootSyncSetList) DeepCopyInto(out *RemoteRootSyncSetList)
  • func (in *RemoteRootSyncSetList) DeepCopyObject() runtime.Object
• type RemoteRootSyncSetSpec
  • func (in *RemoteRootSyncSetSpec) DeepCopy() *RemoteRootSyncSetSpec
  • func (in *RemoteRootSyncSetSpec) DeepCopyInto(out *RemoteRootSyncSetSpec)
  • func (o *RemoteRootSyncSetSpec) GetTemplate() *RootSyncTemplate
• type RemoteRootSyncSetStatus
  • func (in *RemoteRootSyncSetStatus) DeepCopy() *RemoteRootSyncSetStatus
  • func (in *RemoteRootSyncSetStatus) DeepCopyInto(out *RemoteRootSyncSetStatus)
• type RootSyncTemplate
  • func (in *RootSyncTemplate) DeepCopy() *RootSyncTemplate
  • func (in *RootSyncTemplate) DeepCopyInto(out *RootSyncTemplate)
  • func (o *RootSyncTemplate) GetOCI() *OCISpec
  • func (o *RootSyncTemplate) GetPackageRef() *PackageRef
  • func (o *RootSyncTemplate) GetSourceFormat() string
• type TargetStatus
  • func (in *TargetStatus) DeepCopy() *TargetStatus
  • func (in *TargetStatus) DeepCopyInto(out *TargetStatus)

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "config.porch.kpt.dev", Version: "v1alpha1"}

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

Types

type AggregatedStatus

type AggregatedStatus struct {
	Targets int32 `json:"total"`
	Applied int32 `json:"applied"`
	Ready   int32 `json:"ready"`
	// Conditions describes the reconciliation state of the object.
	Conditions []metav1.Condition `json:"conditions,omitempty"`
}

func (*AggregatedStatus) DeepCopy

func (in *AggregatedStatus) DeepCopy() *AggregatedStatus

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

func (*AggregatedStatus) DeepCopyInto

func (in *AggregatedStatus) DeepCopyInto(out *AggregatedStatus)

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

type ClusterRef

type ClusterRef struct {
	ApiVersion string `json:"apiVersion,omitempty"`
	Kind       string `json:"kind,omitempty"`
	Name       string `json:"name,omitempty"`
	Namespace  string `json:"namespace,omitempty"`
}

func (*ClusterRef) DeepCopy

func (in *ClusterRef) DeepCopy() *ClusterRef

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

func (*ClusterRef) DeepCopyInto

func (in *ClusterRef) DeepCopyInto(out *ClusterRef)

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

func (*ClusterRef) GetAPIVersion

func (r *ClusterRef) GetAPIVersion() string

func (*ClusterRef) GetKind

func (r *ClusterRef) GetKind() string

func (*ClusterRef) GetName

func (r *ClusterRef) GetName() string

func (*ClusterRef) GetNamespace

func (r *ClusterRef) GetNamespace() string

type OCISpec

type OCISpec struct {
	Repository string `json:"repository,omitempty"`
}

func (*OCISpec) DeepCopy

func (in *OCISpec) DeepCopy() *OCISpec

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

func (*OCISpec) DeepCopyInto

func (in *OCISpec) DeepCopyInto(out *OCISpec)

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

func (*OCISpec) GetRepository

func (o *OCISpec) GetRepository() string

type PackageRef

type PackageRef struct {
	Name string `json:"name,omitempty"`
}

func (*PackageRef) DeepCopy

func (in *PackageRef) DeepCopy() *PackageRef

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

func (*PackageRef) DeepCopyInto

func (in *PackageRef) DeepCopyInto(out *PackageRef)

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

func (*PackageRef) GetName

func (r *PackageRef) GetName() string

type RemoteRootSyncSet

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

	Spec   RemoteRootSyncSetSpec   `json:"spec,omitempty"`
	Status RemoteRootSyncSetStatus `json:"status,omitempty"`
}

RemoteRootSyncSet represents applying a package to multiple target clusters. In future, this should use ConfigSync, but while we're iterating on OCI/porch support, and making a few similar iterations (e.g. what feedback do we need for rollout), we're just applying directly to the target cluster(s).

We follow the "managed remote objects" pattern; we don't want to create a mirror object, so we start with the "ReplicaSet" of Pod/ReplicaSet/Deployment.

spec.clusterRefs specifies the target clusters

spec.template maps to the spec of our "Pod", in this case a ConfigSync RootSync/RepoSync. Because we're not actually using ConfigSync in this prototype, we are only defining a small subset of fields.

func (*RemoteRootSyncSet) DeepCopy

func (in *RemoteRootSyncSet) DeepCopy() *RemoteRootSyncSet

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

func (*RemoteRootSyncSet) DeepCopyInto

func (in *RemoteRootSyncSet) DeepCopyInto(out *RemoteRootSyncSet)

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

func (*RemoteRootSyncSet) DeepCopyObject

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

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

func (*RemoteRootSyncSet) GetSpec

func (o *RemoteRootSyncSet) GetSpec() *RemoteRootSyncSetSpec

type RemoteRootSyncSetList

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

RemoteRootSyncSetList contains a list of RemoteRootSyncSet

func (*RemoteRootSyncSetList) DeepCopy

func (in *RemoteRootSyncSetList) DeepCopy() *RemoteRootSyncSetList

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

func (*RemoteRootSyncSetList) DeepCopyInto

func (in *RemoteRootSyncSetList) DeepCopyInto(out *RemoteRootSyncSetList)

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

func (*RemoteRootSyncSetList) DeepCopyObject

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

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

type RemoteRootSyncSetSpec

type RemoteRootSyncSetSpec struct {
	ClusterRefs []*ClusterRef     `json:"clusterRefs,omitempty"`
	Template    *RootSyncTemplate `json:"template,omitempty"`
}

RemoteRootSyncSetSpec defines the desired state of RemoteRootSync

func (*RemoteRootSyncSetSpec) DeepCopy

func (in *RemoteRootSyncSetSpec) DeepCopy() *RemoteRootSyncSetSpec

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

func (*RemoteRootSyncSetSpec) DeepCopyInto

func (in *RemoteRootSyncSetSpec) DeepCopyInto(out *RemoteRootSyncSetSpec)

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

func (*RemoteRootSyncSetSpec) GetTemplate

func (o *RemoteRootSyncSetSpec) GetTemplate() *RootSyncTemplate

type RemoteRootSyncSetStatus

type RemoteRootSyncSetStatus struct {
	Targets          []TargetStatus   `json:"targets,omitempty"`
	AggregatedStatus AggregatedStatus `json:"aggregated,omitempty"`
}

RootSyncSetStatus defines the observed state of RootSyncSet

func (*RemoteRootSyncSetStatus) DeepCopy

func (in *RemoteRootSyncSetStatus) DeepCopy() *RemoteRootSyncSetStatus

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

func (*RemoteRootSyncSetStatus) DeepCopyInto

func (in *RemoteRootSyncSetStatus) DeepCopyInto(out *RemoteRootSyncSetStatus)

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

type RootSyncTemplate

type RootSyncTemplate struct {
	SourceFormat string `json:"sourceFormat,omitempty"`
	// Git          *GitInfo `json:"git,omitempty"`
	OCI *OCISpec `json:"oci,omitempty"`

	// PackageRef specifies a package as the source of the objects to be applied.
	PackageRef *PackageRef `json:"packageRef,omitempty"`
}

func (*RootSyncTemplate) DeepCopy

func (in *RootSyncTemplate) DeepCopy() *RootSyncTemplate

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

func (*RootSyncTemplate) DeepCopyInto

func (in *RootSyncTemplate) DeepCopyInto(out *RootSyncTemplate)

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

func (*RootSyncTemplate) GetOCI

func (o *RootSyncTemplate) GetOCI() *OCISpec

func (*RootSyncTemplate) GetPackageRef

func (o *RootSyncTemplate) GetPackageRef() *PackageRef

func (*RootSyncTemplate) GetSourceFormat

func (o *RootSyncTemplate) GetSourceFormat() string

type TargetStatus

type TargetStatus struct {
	Ref ClusterRef `json:"ref,omitempty"`
	// Conditions describes the reconciliation state of the object.
	Conditions []metav1.Condition `json:"conditions,omitempty"`
}

func (*TargetStatus) DeepCopy

func (in *TargetStatus) DeepCopy() *TargetStatus

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

func (*TargetStatus) DeepCopyInto

func (in *TargetStatus) DeepCopyInto(out *TargetStatus)

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