labels

import "katenary/generator/labels"

Package labels provides functionality to parse and manipulate labels.

Constants

const KatenaryLabelPrefix = "katenary.v3"

func GetLabelHelp

func GetLabelHelp(asMarkdown bool) string

GetLabelHelp return the help for the labels.

func GetLabelHelpFor

func GetLabelHelpFor(labelname string, asMarkdown bool) string

GetLabelHelpFor returns the help for a specific label.

func GetLabelNames

func GetLabelNames() []string

GetLabelNames returns a sorted list of all katenary label names.

func Prefix

func Prefix() string

type Help

Help is the documentation of a label.

type Help struct {
    Short   string `yaml:"short"`
    Long    string `yaml:"long"`
    Example string `yaml:"example"`
    Type    string `yaml:"type"`
}

type Label

Label is a katenary label to find in compose files.

type Label = string

Known labels.

const (
    LabelMainApp        Label = KatenaryLabelPrefix + "/main-app"
    LabelValues         Label = KatenaryLabelPrefix + "/values"
    LabelSecrets        Label = KatenaryLabelPrefix + "/secrets"
    LabelPorts          Label = KatenaryLabelPrefix + "/ports"
    LabelIngress        Label = KatenaryLabelPrefix + "/ingress"
    LabelMapEnv         Label = KatenaryLabelPrefix + "/map-env"
    LabelHealthCheck    Label = KatenaryLabelPrefix + "/health-check"
    LabelSamePod        Label = KatenaryLabelPrefix + "/same-pod"
    LabelDescription    Label = KatenaryLabelPrefix + "/description"
    LabelIgnore         Label = KatenaryLabelPrefix + "/ignore"
    LabelDependencies   Label = KatenaryLabelPrefix + "/dependencies"
    LabelConfigMapFiles Label = KatenaryLabelPrefix + "/configmap-files"
    LabelCronJob        Label = KatenaryLabelPrefix + "/cronjob"
    LabelEnvFrom        Label = KatenaryLabelPrefix + "/env-from"
    LabelExchangeVolume Label = KatenaryLabelPrefix + "/exchange-volumes"
    LabelValueFrom      Label = KatenaryLabelPrefix + "/values-from"
)

func LabelName

func LabelName(name string) Label

Generated by gomarkdoc

3.1 KiB Raw Blame History