v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the deploy v1alpha1 API group +kubebuilder:object:generate=true +groupName=deploy.properator.io

Index

• Variables
• type Deployment
• type DeploymentStatus
• type GithubDeployment
• type GithubDeploymentList
• type Ref
• type RefRelease
• type RefReleaseList
• type RefReleaseSpec
• type RefReleaseStatus
• type Repo

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "deploy.properator.io", 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 Deployment

type Deployment struct {
	Status DeploymentStatus `json:"statuses,omitempty"`
	// Current Sha
	Sha string `json:"sha,omitempty"`
	// Owner
	Owner string `json:"owner,omitempty"`
	// Name
	Name string `json:"name,omitempty"`
	// Ref
	Ref string `json:"ref,omitempty"`
	// ID
	ID int64 `json:"id,omitempty"`
}

Deployment tells us about our deployment

type DeploymentStatus

type DeploymentStatus struct {
	// URL determines the deployment URL
	URL string `json:"url,omitempty"`
	// State determines the deployment state
	State string `json:"state,omitempty"`
}

DeploymentStatus tells us about a deployment for some Sha

type GithubDeployment

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

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

GithubDeployment is the Schema for the githubdeployment API

type GithubDeploymentList

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

GithubDeploymentList contains a list of GithubDeployment

type Ref

type Ref struct {
	// +optional
	Branch string `json:"branch,omitempty"`
	// +optional
	Sha string `json:"sha,omitempty"`
	// +optional
	Tag string `json:"tag,omitempty"`
	// +optional
	PullRequest int `json:"pullRequest,omitempty"`
}

Ref tells us which version of our repo to track

type RefRelease

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

	Spec   RefReleaseSpec   `json:"spec,omitempty"`
	Status RefReleaseStatus `json:"status,omitempty"`
}

RefRelease is the Schema for the refreleases API

type RefReleaseList

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

RefReleaseList contains a list of RefRelease

type RefReleaseSpec

type RefReleaseSpec struct {
	// Repo refers to a github repository
	Repo Repo `json:"repo,omitempty"`
	// Repo refers to either a branch, tag or commit along with a pull request
	// number
	Ref Ref `json:"ref,omitempty"`
}

RefReleaseSpec defines the desired state of RefRelease

type RefReleaseStatus

type RefReleaseStatus struct {
	// Deployment status determines the deployment URL
	DeploymentURL string `json:"deploymentURL,omitempty"`
}

RefReleaseStatus defines the observed state of RefRelease

type Repo

type Repo struct {
	Owner         string `json:"owner,omitempty"`
	Name          string `json:"name,omitempty"`
	KeySecretName string `json:"keySecretName,omitempty"`
}

Repo defines the Github repo