Documentation
¶
Index ¶
- Constants
- func GitCloneInitContainers(repository, revision string) ([]corev1.Container, corev1.Volume)
- func Ingress(input IngressInput) (*extensions.Ingress, error)
- func PersistentVolumeClaim(input PersistentVolumeClaimInput) *v1.PersistentVolumeClaim
- func Pod(input PodInput) (*v1.Pod, error)
- func Secret(input SecretInput) (*v1.Secret, error)
- func Service(input ServiceInput) (*v1.Service, error)
- type IngressInput
- type PersistentVolumeClaimInput
- type PodInput
- type PodInputCache
- type SecretInput
- type ServiceInput
Constants ¶
const ( // GitCloneImage is the image used for cloning the repository. GitCloneImage = "alpine/git:latest" // GitCloneVolume is the name of the volume which code is cloned into. GitCloneVolume = "code" // GitClonePath is the path which the init containers mount the GitCloneVolume. GitClonePath = "/checkout" )
const ( // SecretSSH is the identifier for storing the "id_rsa" and known_hosts file // secrets are stored. SecretSSH = "ssh" )
const TypeMySQL = "mysql"
TypeMySQL is used of idenifying a MySQL container for readiness rules.
Variables ¶
This section is empty.
Functions ¶
func GitCloneInitContainers ¶ added in v0.8.0
GitCloneInitContainers returns a list of init containers and volume which they clone a repository into.
func Ingress ¶
func Ingress(input IngressInput) (*extensions.Ingress, error)
Ingress converts a Docker Compose file into a Kubernetes Ingress object.
func PersistentVolumeClaim ¶
func PersistentVolumeClaim(input PersistentVolumeClaimInput) *v1.PersistentVolumeClaim
PersistentVolumeClaim is used for creating a new PersistentVolumeClaim object.
func Secret ¶
func Secret(input SecretInput) (*v1.Secret, error)
Secret is used for generating a "basic auth" secret for our PR environment. @todo, Needs a test.
func Service ¶
func Service(input ServiceInput) (*v1.Service, error)
Service converts a Docker Compose file into a Kubernetes Service object.
Types ¶
type IngressInput ¶ added in v0.4.1
type IngressInput struct {
Namespace string
Name string
Annotations []*pb.Annotation
Secret string
Retention string
Domains []string
}
IngressInput provides the Ingress function with information to produce a Kubernetes Ingress.
type PersistentVolumeClaimInput ¶ added in v0.4.1
PersistentVolumeClaimInput provides the PersistentVolumeClaim function with information to produce a Kubernetes PersistentVolumeClaim.
type PodInput ¶ added in v0.4.1
type PodInput struct {
Namespace string
Name string
Annotations []*pb.Annotation
Repository string
Revision string
Retention string
Services []*pb.ComposeService
Caches []PodInputCache
ImagePullSecret string
Init []*pb.Init
}
PodInput provides the Pod function with information to produce a Kubernetes Pod.
type PodInputCache ¶ added in v0.5.0
PodInputCache is used for passing in cache configuration to generate a pod.
type SecretInput ¶ added in v0.4.1
type SecretInput struct {
Namespace string
Name string
Annotations []*pb.Annotation
User string
Pass string
Retention string
}
SecretInput provides the Secret function with information to produce a Kubernetes Secret.
type ServiceInput ¶ added in v0.4.1
type ServiceInput struct {
Namespace string
Name string
Annotations []*pb.Annotation
Retention string
}
ServiceInput provides the Service function with information to produce a Kubernetes Service.
Source Files
Directories