# labels
```go
import "katenary/generator/labels"
```
Package labels provides functionality to parse and manipulate labels.
## Constants
```go
const KatenaryLabelPrefix = "katenary.v3"
```
## func [GetLabelHelp]()
```go
func GetLabelHelp(asMarkdown bool) string
```
GetLabelHelp return the help for the labels.
## func [GetLabelHelpFor]()
```go
func GetLabelHelpFor(labelname string, asMarkdown bool) string
```
GetLabelHelpFor returns the help for a specific label.
## func [GetLabelNames]()
```go
func GetLabelNames() []string
```
GetLabelNames returns a sorted list of all katenary label names.
## func [Prefix]()
```go
func Prefix() string
```
## type [Help]()
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"`
}
```
## type [Label]()
Label is a katenary label to find in compose files.
```go
type Label = string
```
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"
)
```
### func [LabelName]()
```go
func LabelName(name string) Label
```
Generated by [gomarkdoc]()