katenary/doc/docs/packages/generator/labels.md

<!-- Code generated by gomarkdoc. DO NOT EDIT -->

# labels

```go
import "katenary/generator/labels"
```

Package labels provides functionality to parse and manipulate labels.

## Constants

<a name="KatenaryLabelPrefix"></a>

```go
const KatenaryLabelPrefix = "katenary.v3"
```

<a name="GetLabelHelp"></a>
## func [GetLabelHelp](<https://github.com/metal3d/katenary/blob/develop/generator/labels/katenaryLabels.go#L88>)

```go
func GetLabelHelp(asMarkdown bool) string
```

GetLabelHelp return the help for the labels.

<a name="GetLabelHelpFor"></a>
## func [GetLabelHelpFor](<https://github.com/metal3d/katenary/blob/develop/generator/labels/katenaryLabels.go#L97>)

```go
func GetLabelHelpFor(labelname string, asMarkdown bool) string
```

GetLabelHelpFor returns the help for a specific label.

<a name="GetLabelNames"></a>
## func [GetLabelNames](<https://github.com/metal3d/katenary/blob/develop/generator/labels/katenaryLabels.go#L72>)

```go
func GetLabelNames() []string
```

GetLabelNames returns a sorted list of all katenary label names.

<a name="Prefix"></a>
## func [Prefix](<https://github.com/metal3d/katenary/blob/develop/generator/labels/katenaryLabels.go#L235>)

```go
func Prefix() string
```



<a name="Help"></a>
## type [Help](<https://github.com/metal3d/katenary/blob/develop/generator/labels/katenaryLabels.go#L64-L69>)

Help is the documentation of a label.

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

<a name="Label"></a>
## type [Label](<https://github.com/metal3d/katenary/blob/develop/generator/labels/katenaryLabels.go#L57>)

Label is a katenary label to find in compose files.

```go
type Label = string
```

<a name="LabelMainApp"></a>Known labels.

```go
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"
)
```

<a name="LabelName"></a>
### func [LabelName](<https://github.com/metal3d/katenary/blob/develop/generator/labels/katenaryLabels.go#L59>)

```go
func LabelName(name string) Label
```



Generated by [gomarkdoc](<https://github.com/princjef/gomarkdoc>)