v1alpha1

package
v0.4.0-rc3 Latest Latest
Warning

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

 Go to latest Published: Mar 27, 2019 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the faros v1alpha1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/pusher/faros/pkg/apis/faros +k8s:defaulter-gen=TypeMeta +groupName=faros.pusher.com

Package v1alpha1 contains API Schema definitions for the faros v1alpha1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/pusher/faros/pkg/apis/faros +k8s:defaulter-gen=TypeMeta +groupName=faros.pusher.com

Index

Constants

View Source 
const (
	// GitCredentialTypeSSH defines a private SSH key credential type
	GitCredentialTypeSSH = "SSH"
	// GitCredentialTypeHTTPBasicAuth defines an http basic auth type
	GitCredentialTypeHTTPBasicAuth = "HTTPBasicAuth"
)
View Source 
const (
	Group   = "faros.pusher.com"
	Version = "v1alpha1"

	GitTrackKind              = "GitTrack"
	GitTrackObjectKind        = "GitTrackObject"
	ClusterGitTrackObjectKind = "ClusterGitTrackObject"
)

API related string constants for Group, Version and Kinds within v1alpha1.faros.pusher.com

Variables

View Source 
var (
	GroupVersion = schema.GroupVersion{
		Group:   Group,
		Version: Version,
	}

	GitTrackTypeMeta = metav1.TypeMeta{
		APIVersion: GroupVersion.String(),
		Kind:       GitTrackKind,
	}
	GitTrackObjectTypeMeta = metav1.TypeMeta{
		APIVersion: GroupVersion.String(),
		Kind:       GitTrackObjectKind,
	}
	ClusterGitTrackObjectTypeMeta = metav1.TypeMeta{
		APIVersion: GroupVersion.String(),
		Kind:       ClusterGitTrackObjectKind,
	}
)

GroupVersion and TypeMeta for v1alpha1.faros.pusher.com

View Source 
var (
	// SchemeGroupVersion is group version used to register these objects
	SchemeGroupVersion = schema.GroupVersion{Group: "faros.pusher.com", Version: "v1alpha1"}

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

	// AddToScheme is used to register the new types with the Scheme
	AddToScheme = SchemeBuilder.AddToScheme
)

Functions

func Resource added in v0.4.0 

func Resource(resource string) schema.GroupResource

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

Types

type ClusterGitTrackObject 

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

	Spec   GitTrackObjectSpec   `json:"spec,omitempty"`
	Status GitTrackObjectStatus `json:"status,omitempty"`
}

ClusterGitTrackObject is the Schema for the clustergittrackobjects API +k8s:openapi-gen=true +kubebuilder:printcolumn:name="In Sync",type="string",JSONPath=".status.conditions[?(@.type=="ObjectInSync")].status" +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp"

func (*ClusterGitTrackObject) DeepCopy 

func (in *ClusterGitTrackObject) DeepCopy() *ClusterGitTrackObject

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

func (*ClusterGitTrackObject) DeepCopyInterface 

func (g *ClusterGitTrackObject) DeepCopyInterface() GitTrackObjectInterface

DeepCopyInterface implements the GitTrackObject interface

func (*ClusterGitTrackObject) DeepCopyInto 

func (in *ClusterGitTrackObject) DeepCopyInto(out *ClusterGitTrackObject)

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

func (*ClusterGitTrackObject) DeepCopyObject 

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

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

func (*ClusterGitTrackObject) GetNamespacedName added in v0.2.0 

func (g *ClusterGitTrackObject) GetNamespacedName() string

GetNamespacedName implementes the GitTrackObject interface

func (*ClusterGitTrackObject) GetSpec 

func (g *ClusterGitTrackObject) GetSpec() GitTrackObjectSpec

GetSpec implements the GitTrackObject interface

func (*ClusterGitTrackObject) GetStatus 

func (g *ClusterGitTrackObject) GetStatus() GitTrackObjectStatus

GetStatus implements the GitTrackObject interface

func (*ClusterGitTrackObject) SetSpec 

func (g *ClusterGitTrackObject) SetSpec(s GitTrackObjectSpec)

SetSpec implements the GitTrackObject interface

func (*ClusterGitTrackObject) SetStatus 

func (g *ClusterGitTrackObject) SetStatus(s GitTrackObjectStatus)

SetStatus implements the GitTrackObject interface

type ClusterGitTrackObjectList 

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

ClusterGitTrackObjectList contains a list of ClusterGitTrackObject

func (*ClusterGitTrackObjectList) DeepCopy 

func (in *ClusterGitTrackObjectList) DeepCopy() *ClusterGitTrackObjectList

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

func (*ClusterGitTrackObjectList) DeepCopyInto 

func (in *ClusterGitTrackObjectList) DeepCopyInto(out *ClusterGitTrackObjectList)

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

func (*ClusterGitTrackObjectList) DeepCopyObject 

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

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

type GitCredentialType added in v0.4.0 

type GitCredentialType string

GitCredentialType defines the type of git credential

type GitTrack 

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

	Spec   GitTrackSpec   `json:"spec,omitempty"`
	Status GitTrackStatus `json:"status,omitempty"`
}

GitTrack is the Schema for the gittracks API +k8s:openapi-gen=true +kubebuilder:printcolumn:name="Repository",type="string",JSONPath=".spec.repository",priority=1 +kubebuilder:printcolumn:name="Reference",type="string",JSONPath=".spec.reference" +kubebuilder:printcolumn:name="Children Created",type="integer",JSONPath=".status.objectsApplied" +kubebuilder:printcolumn:name="Resources Discovered",type="integer",JSONPath=".status.objectsDiscovered" +kubebuilder:printcolumn:name="Resources Ignored",type="integer",JSONPath=".status.objectsIgnored" +kubebuilder:printcolumn:name="Children In Sync",type="integer",JSONPath=".status.objectsInSync" +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp"

func (*GitTrack) DeepCopy 

func (in *GitTrack) DeepCopy() *GitTrack

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

func (*GitTrack) DeepCopyInto 

func (in *GitTrack) DeepCopyInto(out *GitTrack)

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

func (*GitTrack) DeepCopyObject 

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

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

type GitTrackCondition 

type GitTrackCondition struct {
	// Type of this condition
	Type GitTrackConditionType `json:"type"`

	// Status of this condition
	Status v1.ConditionStatus `json:"status"`

	// LastUpdateTime of this condition
	LastUpdateTime metav1.Time `json:"lastUpdateTime,omitempty"`

	// LastTransitionTime of this condition
	LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"`

	// Reason for the current status of this condition
	Reason string `json:"reason,omitempty"`

	// Message associated with this condition
	Message string `json:"message,omitempty"`
}

GitTrackCondition is a status condition for a GitTrack

func (*GitTrackCondition) DeepCopy 

func (in *GitTrackCondition) DeepCopy() *GitTrackCondition

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

func (*GitTrackCondition) DeepCopyInto 

func (in *GitTrackCondition) DeepCopyInto(out *GitTrackCondition)

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

type GitTrackConditionType 

type GitTrackConditionType string

GitTrackConditionType is the type of a GitTrackCondition 

const (
	// FilesParsedType referes to whether all files parsed successfully
	FilesParsedType GitTrackConditionType = "FilesParsed"

	// FilesFetchedType refers to whether all files where fetched from git
	// successfully
	FilesFetchedType GitTrackConditionType = "FilesFetched"

	// ChildrenUpToDateType referes to whether all children were created/updated
	// successfully
	ChildrenUpToDateType GitTrackConditionType = "ChildrenUpToDate"

	// ChildrenGarbageCollectedType referes to whether all children that were meant to
	// be GC'd have been GC'
	ChildrenGarbageCollectedType GitTrackConditionType = "ChildrenGarbageCollected"
)

type GitTrackDeployKey 

type GitTrackDeployKey struct {
	// SecretName is the name of the Secret object containins the key
	SecretName string `json:"secretName"`

	// Key is the key within the Secret object that contains the deploy secret
	Key string `json:"key"`

	// Type is the type of credential. Accepted values are "SSH", "HTTPBasicAuth". Defaults to "SSH".
	// +kubebuilder:validation:Enum=SSH,HTTPBasicAuth
	Type GitCredentialType `json:"type,omitempty"`
}

GitTrackDeployKey holds a reference to a secret such as an SSH key or HTTP Basic Auth credentials needed to access the repository

func (*GitTrackDeployKey) DeepCopy 

func (in *GitTrackDeployKey) DeepCopy() *GitTrackDeployKey

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

func (*GitTrackDeployKey) DeepCopyInto 

func (in *GitTrackDeployKey) DeepCopyInto(out *GitTrackDeployKey)

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

type GitTrackList 

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

GitTrackList contains a list of GitTrack

func (*GitTrackList) DeepCopy 

func (in *GitTrackList) DeepCopy() *GitTrackList

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

func (*GitTrackList) DeepCopyInto 

func (in *GitTrackList) DeepCopyInto(out *GitTrackList)

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

func (*GitTrackList) DeepCopyObject 

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

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

type GitTrackObject 

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

	Spec   GitTrackObjectSpec   `json:"spec,omitempty"`
	Status GitTrackObjectStatus `json:"status,omitempty"`
}

GitTrackObject is the Schema for the gittrackobjects API +k8s:openapi-gen=true +kubebuilder:printcolumn:name="In Sync",type="string",JSONPath=".status.conditions[?(@.type=="ObjectInSync")].status" +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp"

func (*GitTrackObject) DeepCopy 

func (in *GitTrackObject) DeepCopy() *GitTrackObject

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

func (*GitTrackObject) DeepCopyInterface 

func (g *GitTrackObject) DeepCopyInterface() GitTrackObjectInterface

DeepCopyInterface implements the GitTrackObject interface

func (*GitTrackObject) DeepCopyInto 

func (in *GitTrackObject) DeepCopyInto(out *GitTrackObject)

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

func (*GitTrackObject) DeepCopyObject 

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

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

func (*GitTrackObject) GetNamespacedName added in v0.2.0 

func (g *GitTrackObject) GetNamespacedName() string

GetNamespacedName implementes the GitTrackObject interface

func (*GitTrackObject) GetSpec 

func (g *GitTrackObject) GetSpec() GitTrackObjectSpec

GetSpec implements the GitTrackObject interface

func (*GitTrackObject) GetStatus 

func (g *GitTrackObject) GetStatus() GitTrackObjectStatus

GetStatus implements the GitTrackObject interface

func (*GitTrackObject) SetSpec 

func (g *GitTrackObject) SetSpec(s GitTrackObjectSpec)

SetSpec implements the GitTrackObject interface

func (*GitTrackObject) SetStatus 

func (g *GitTrackObject) SetStatus(s GitTrackObjectStatus)

SetStatus implements the GitTrackObject interface

type GitTrackObjectCondition 

type GitTrackObjectCondition struct {
	// Type of this condition
	Type GitTrackObjectConditionType `json:"type"`

	// Status of this condition
	Status v1.ConditionStatus `json:"status"`

	// LastUpdateTime of this condition
	LastUpdateTime metav1.Time `json:"lastUpdateTime,omitempty"`

	// LastTransitionTime of this condition
	LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"`

	// Reason for the current status of this condition
	Reason string `json:"reason,omitempty"`

	// Message associated with this condition
	Message string `json:"message,omitempty"`
}

GitTrackObjectCondition is a status condition for a GitTrackObject

func (*GitTrackObjectCondition) DeepCopy 

func (in *GitTrackObjectCondition) DeepCopy() *GitTrackObjectCondition

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

func (*GitTrackObjectCondition) DeepCopyInto 

func (in *GitTrackObjectCondition) DeepCopyInto(out *GitTrackObjectCondition)

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

type GitTrackObjectConditionType 

type GitTrackObjectConditionType string

GitTrackObjectConditionType is the type of a GitTrackObjectCondition 

const (
	// ObjectInSyncType whether the tracked object is in sync or not
	ObjectInSyncType GitTrackObjectConditionType = "ObjectInSync"
)

type GitTrackObjectInterface 

type GitTrackObjectInterface interface {
	runtime.Object
	v1.Object
	schema.ObjectKind
	GetNamespacedName() string
	GetSpec() GitTrackObjectSpec
	SetSpec(GitTrackObjectSpec)
	GetStatus() GitTrackObjectStatus
	SetStatus(GitTrackObjectStatus)
	DeepCopyInterface() GitTrackObjectInterface
}

GitTrackObjectInterface represents an interface implemented by both GitTrackObject and ClusterGitTrackObject to allow them to be passed interchangably.

type GitTrackObjectList 

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

GitTrackObjectList contains a list of GitTrackObject

func (*GitTrackObjectList) DeepCopy 

func (in *GitTrackObjectList) DeepCopy() *GitTrackObjectList

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

func (*GitTrackObjectList) DeepCopyInto 

func (in *GitTrackObjectList) DeepCopyInto(out *GitTrackObjectList)

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

func (*GitTrackObjectList) DeepCopyObject 

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

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

type GitTrackObjectSpec 

type GitTrackObjectSpec struct {
	// Name of the tracked object
	Name string `json:"name"`

	// Kind of the tracked object
	Kind string `json:"kind"`

	// Data representation of the tracked object
	Data []byte `json:"data"`
}

GitTrackObjectSpec defines the desired state of GitTrackObject

func (*GitTrackObjectSpec) DeepCopy 

func (in *GitTrackObjectSpec) DeepCopy() *GitTrackObjectSpec

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

func (*GitTrackObjectSpec) DeepCopyInto 

func (in *GitTrackObjectSpec) DeepCopyInto(out *GitTrackObjectSpec)

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

type GitTrackObjectStatus 

type GitTrackObjectStatus struct {
	// Conditions of this object
	Conditions []GitTrackObjectCondition `json:"conditions,omitempty"`
}

GitTrackObjectStatus defines the observed state of GitTrackObject

func (*GitTrackObjectStatus) DeepCopy 

func (in *GitTrackObjectStatus) DeepCopy() *GitTrackObjectStatus

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

func (*GitTrackObjectStatus) DeepCopyInto 

func (in *GitTrackObjectStatus) DeepCopyInto(out *GitTrackObjectStatus)

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

type GitTrackSpec 

type GitTrackSpec struct {
	// Reference contains the git reference this GitTrack tracks
	Reference string `json:"reference"`

	// Repository is the git repository URI to clone from
	Repository string `json:"repository"`

	// +kubebuilder:validation:Pattern=^[a-zA-Z0-9/\-.]*$
	// SubPath is the subpath within the repository underneath which files are considered
	SubPath string `json:"subPath,omitempty"`

	// DeployKey holds a reference to an SSH key needed to access the repository
	DeployKey GitTrackDeployKey `json:"deployKey,omitempty"`
}

GitTrackSpec defines the desired state of GitTrack

func (*GitTrackSpec) DeepCopy 

func (in *GitTrackSpec) DeepCopy() *GitTrackSpec

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

func (*GitTrackSpec) DeepCopyInto 

func (in *GitTrackSpec) DeepCopyInto(out *GitTrackSpec)

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

type GitTrackStatus 

type GitTrackStatus struct {
	// ObjectsDiscovered is the number of k8s objects found in the repository path
	ObjectsDiscovered int64 `json:"objectsDiscovered"`

	// ObjectsApplied is the number of k8s objects for which a GitTrackObjects was created
	ObjectsApplied int64 `json:"objectsApplied"`

	// ObjectsIgnored is the number of k8s objects found in the repository path for which no GitTrackObject was created
	ObjectsIgnored int64 `json:"objectsIgnored"`

	// ObjectsInSync is the number of GitTrackObjects that were successfully applied to the cluster
	ObjectsInSync int64 `json:"objectsInSync"`

	// Conditions are the conditions on this GitTrack
	Conditions []GitTrackCondition `json:"conditions,omitempty"`
}

GitTrackStatus defines the observed state of GitTrack

func (*GitTrackStatus) DeepCopy 

func (in *GitTrackStatus) DeepCopy() *GitTrackStatus

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

func (*GitTrackStatus) DeepCopyInto 

func (in *GitTrackStatus) DeepCopyInto(out *GitTrackStatus)

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.