compose

Documentation

Index

• Constants
• Variables
• func ParseVols(volNames []string, svcName string) ([]kobject.Volumes, error)
• func ReadFile(fileName string) ([]byte, error)
• type Compose
  • func (c *Compose) LoadFile(files []string, profiles []string) (kobject.KomposeObject, error)

Constants

const (
	// LabelServiceType defines the type of service to be created
	LabelServiceType = "kompose.service.type"
	// LabelServiceExternalTrafficPolicy defines the external policy traffic of service to be created
	LabelServiceExternalTrafficPolicy = "kompose.service.external-traffic-policy"
	// LabelServiceGroup defines the group of services in a single pod
	LabelServiceGroup = "kompose.service.group"
	// LabelNodePortPort defines the port value for NodePort service
	LabelNodePortPort = "kompose.service.nodeport.port"
	// LabelServiceExpose defines if the service needs to be made accessible from outside the cluster or not
	LabelServiceExpose = "kompose.service.expose"
	// LabelServiceExposeTLSSecret provides the name of the TLS secret to use with the Kubernetes ingress controller
	LabelServiceExposeTLSSecret = "kompose.service.expose.tls-secret"
	// LabelServiceExposeIngressClassName provides the name of ingress class to use with the Kubernetes ingress controller
	LabelServiceExposeIngressClassName = "kompose.service.expose.ingress-class-name"
	// LabelServiceAccountName defines the service account name to provide the credential info of the pod.
	LabelServiceAccountName = "kompose.serviceaccount-name"
	// LabelControllerType defines the type of controller to be created
	LabelControllerType = "kompose.controller.type"
	// LabelImagePullSecret defines a secret name for kubernetes ImagePullSecrets
	LabelImagePullSecret = "kompose.image-pull-secret"
	// LabelImagePullPolicy defines Kubernetes PodSpec imagePullPolicy.
	LabelImagePullPolicy = "kompose.image-pull-policy"
	// HealthCheckReadinessDisable defines readiness health check disable
	HealthCheckReadinessDisable = "kompose.service.healthcheck.readiness.disable"
	// HealthCheckReadinessTest defines readiness health check test
	HealthCheckReadinessTest = "kompose.service.healthcheck.readiness.test"
	// HealthCheckReadinessInterval defines readiness health check interval
	HealthCheckReadinessInterval = "kompose.service.healthcheck.readiness.interval"
	// HealthCheckReadinessTimeout defines readiness health check timeout
	HealthCheckReadinessTimeout = "kompose.service.healthcheck.readiness.timeout"
	// HealthCheckReadinessRetries defines readiness health check retries
	HealthCheckReadinessRetries = "kompose.service.healthcheck.readiness.retries"
	// HealthCheckReadinessStartPeriod defines readiness health check start period
	HealthCheckReadinessStartPeriod = "kompose.service.healthcheck.readiness.start_period"
	// HealthCheckReadinessHTTPGetPath defines readiness health check HttpGet path
	HealthCheckReadinessHTTPGetPath = "kompose.service.healthcheck.readiness.http_get_path"
	// HealthCheckReadinessHTTPGetPort defines readiness health check HttpGet port
	HealthCheckReadinessHTTPGetPort = "kompose.service.healthcheck.readiness.http_get_port"
	// HealthCheckReadinessTCPPort defines readiness health check tcp port
	HealthCheckReadinessTCPPort = "kompose.service.healthcheck.readiness.tcp_port"
	// HealthCheckLivenessHTTPGetPath defines liveness health check HttpGet path
	HealthCheckLivenessHTTPGetPath = "kompose.service.healthcheck.liveness.http_get_path"
	// HealthCheckLivenessHTTPGetPort defines liveness health check HttpGet port
	HealthCheckLivenessHTTPGetPort = "kompose.service.healthcheck.liveness.http_get_port"
	// HealthCheckLivenessTCPPort defines liveness health check tcp port
	HealthCheckLivenessTCPPort = "kompose.service.healthcheck.liveness.tcp_port"
	// ServiceTypeHeadless ...
	ServiceTypeHeadless = "Headless"
	// LabelSecurityContextFsGroup defines the pod FsGroup
	LabelSecurityContextFsGroup = "kompose.security-context.fsgroup"
	// LabelContainerVolumeSubpath defines the volume mount subpath inside container
	LabelContainerVolumeSubpath = "kompose.volume.subpath"
	// LabelCronJobSchedule defines the cron job schedule
	LabelCronJobSchedule = "kompose.cronjob.schedule"
	// LabelCronJobConcurrencyPolicy defines the cron job concurrency policy
	LabelCronJobConcurrencyPolicy = "kompose.cronjob.concurrency_policy"
	// LabelCronJobBackoffLimit defines the job backoff limit
	LabelCronJobBackoffLimit = "kompose.cronjob.backoff_limit"
	// LabelInitContainerName defines name resource
	LabelInitContainerName = "kompose.init.containers.name"
	// LabelInitContainerImage defines image to pull
	LabelInitContainerImage = "kompose.init.containers.image"
	// LabelInitContainerCommand defines commands
	LabelInitContainerCommand = "kompose.init.containers.command"
	// LabelHpaMinReplicas defines min pod replicas
	LabelHpaMinReplicas = "kompose.hpa.replicas.min"
	// LabelHpaMaxReplicas defines max pod replicas
	LabelHpaMaxReplicas = "kompose.hpa.replicas.max"
	// LabelHpaCpu defines scaling decisions based on CPU utilization
	LabelHpaCPU = "kompose.hpa.cpu"
	// LabelHpaMemory defines scaling decisions based on memory utilization
	LabelHpaMemory = "kompose.hpa.memory"
	// LabelNameOverride defines the override resource name
	LabelNameOverride = "kompose.service.name_override"
	// LabelExposeContainerToHost defines whether to expose container to host or not using hostPort
	LabelExposeContainerToHost = "kompose.controller.port.expose"
)

Variables

var StdinData []byte

StdinData is data bytes read from stdin

Functions

func ParseVols

func ParseVols(volNames []string, svcName string) ([]kobject.Volumes, error)

ParseVols parse volumes

func ReadFile

func ReadFile(fileName string) ([]byte, error)

ReadFile read data from file or stdin

Types

type Compose

type Compose struct {
}

Compose is docker compose file loader, implements Loader interface

func (*Compose) LoadFile

func (c *Compose) LoadFile(files []string, profiles []string) (kobject.KomposeObject, error)

LoadFile loads a compose file into KomposeObject