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

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

# labelstructs

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

Package labelstructs is a package that contains the structs used to represent the labels in the yaml files.

## type [ConfigMapFile](<https://github.com/metal3d/katenary/blob/develop/generator/labels/labelstructs/configMap.go#L5>)



```go
type ConfigMapFile []string
```

<a name="ConfigMapFileFrom"></a>
### func [ConfigMapFileFrom](<https://github.com/metal3d/katenary/blob/develop/generator/labels/labelstructs/configMap.go#L7>)

```go
func ConfigMapFileFrom(data string) (ConfigMapFile, error)
```



<a name="CronJob"></a>
## type [CronJob](<https://github.com/metal3d/katenary/blob/develop/generator/labels/labelstructs/cronJob.go#L5-L10>)



```go
type CronJob struct {
    Image    string `yaml:"image,omitempty" json:"image,omitempty"`
    Command  string `yaml:"command" json:"command,omitempty"`
    Schedule string `yaml:"schedule" json:"schedule,omitempty"`
    Rbac     bool   `yaml:"rbac" json:"rbac,omitempty"`
}
```

<a name="CronJobFrom"></a>
### func [CronJobFrom](<https://github.com/metal3d/katenary/blob/develop/generator/labels/labelstructs/cronJob.go#L12>)

```go
func CronJobFrom(data string) (*CronJob, error)
```



<a name="Dependency"></a>
## type [Dependency](<https://github.com/metal3d/katenary/blob/develop/generator/labels/labelstructs/dependencies.go#L6-L12>)

Dependency is a dependency of a chart to other charts.

```go
type Dependency struct {
    Values     map[string]any `yaml:"-" json:"values,omitempty"`
    Name       string         `yaml:"name" json:"name"`
    Version    string         `yaml:"version" json:"version"`
    Repository string         `yaml:"repository" json:"repository"`
    Alias      string         `yaml:"alias,omitempty" json:"alias,omitempty"`
}
```

<a name="DependenciesFrom"></a>
### func [DependenciesFrom](<https://github.com/metal3d/katenary/blob/develop/generator/labels/labelstructs/dependencies.go#L15>)

```go
func DependenciesFrom(data string) ([]Dependency, error)
```

DependenciesFrom returns a slice of dependencies from the given string.

<a name="EnvFrom"></a>
## type [EnvFrom](<https://github.com/metal3d/katenary/blob/develop/generator/labels/labelstructs/envFrom.go#L5>)



```go
type EnvFrom []string
```

<a name="EnvFromFrom"></a>
### func [EnvFromFrom](<https://github.com/metal3d/katenary/blob/develop/generator/labels/labelstructs/envFrom.go#L8>)

```go
func EnvFromFrom(data string) (EnvFrom, error)
```

EnvFromFrom returns a EnvFrom from the given string.

<a name="ExchangeVolume"></a>
## type [ExchangeVolume](<https://github.com/metal3d/katenary/blob/develop/generator/labels/labelstructs/exchangeVolume.go#L5-L10>)



```go
type ExchangeVolume struct {
    Name      string `yaml:"name" json:"name"`
    MountPath string `yaml:"mountPath" json:"mountPath"`
    Type      string `yaml:"type,omitempty" json:"type,omitempty"`
    Init      string `yaml:"init,omitempty" json:"init,omitempty"`
}
```

<a name="NewExchangeVolumes"></a>
### func [NewExchangeVolumes](<https://github.com/metal3d/katenary/blob/develop/generator/labels/labelstructs/exchangeVolume.go#L12>)

```go
func NewExchangeVolumes(data string) ([]*ExchangeVolume, error)
```



<a name="HealthCheck"></a>
## type [HealthCheck](<https://github.com/metal3d/katenary/blob/develop/generator/labels/labelstructs/probes.go#L11-L14>)



```go
type HealthCheck struct {
    LivenessProbe  *corev1.Probe `yaml:"livenessProbe,omitempty" json:"livenessProbe,omitempty"`
    ReadinessProbe *corev1.Probe `yaml:"readinessProbe,omitempty" json:"readinessProbe,omitempty"`
}
```

<a name="ProbeFrom"></a>
### func [ProbeFrom](<https://github.com/metal3d/katenary/blob/develop/generator/labels/labelstructs/probes.go#L16>)

```go
func ProbeFrom(data string) (*HealthCheck, error)
```



<a name="Ingress"></a>
## type [Ingress](<https://github.com/metal3d/katenary/blob/develop/generator/labels/labelstructs/ingress.go#L14-L22>)



```go
type Ingress struct {
    Port        *int32            `yaml:"port,omitempty" json:"port,omitempty"`
    Annotations map[string]string `yaml:"annotations,omitempty" jsonschema:"nullable" json:"annotations,omitempty"`
    Hostname    string            `yaml:"hostname,omitempty" json:"hostname,omitempty"`
    Path        *string           `yaml:"path,omitempty" json:"path,omitempty"`
    Class       *string           `yaml:"class,omitempty" json:"class,omitempty" jsonschema:"default:-"`
    Enabled     bool              `yaml:"enabled,omitempty" json:"enabled,omitempty"`
    TLS         *TLS              `yaml:"tls,omitempty" json:"tls,omitempty"`
}
```

<a name="IngressFrom"></a>
### func [IngressFrom](<https://github.com/metal3d/katenary/blob/develop/generator/labels/labelstructs/ingress.go#L25>)

```go
func IngressFrom(data string) (*Ingress, error)
```

IngressFrom creates a new Ingress from a compose service.

<a name="MapEnv"></a>
## type [MapEnv](<https://github.com/metal3d/katenary/blob/develop/generator/labels/labelstructs/mapenv.go#L5>)



```go
type MapEnv map[string]string
```

<a name="MapEnvFrom"></a>
### func [MapEnvFrom](<https://github.com/metal3d/katenary/blob/develop/generator/labels/labelstructs/mapenv.go#L8>)

```go
func MapEnvFrom(data string) (MapEnv, error)
```

MapEnvFrom returns a MapEnv from the given string.

<a name="Ports"></a>
## type [Ports](<https://github.com/metal3d/katenary/blob/develop/generator/labels/labelstructs/ports.go#L5>)



```go
type Ports []uint32
```

<a name="PortsFrom"></a>
### func [PortsFrom](<https://github.com/metal3d/katenary/blob/develop/generator/labels/labelstructs/ports.go#L8>)

```go
func PortsFrom(data string) (Ports, error)
```

PortsFrom returns a Ports from the given string.

<a name="Secrets"></a>
## type [Secrets](<https://github.com/metal3d/katenary/blob/develop/generator/labels/labelstructs/secrets.go#L5>)



```go
type Secrets []string
```

<a name="SecretsFrom"></a>
### func [SecretsFrom](<https://github.com/metal3d/katenary/blob/develop/generator/labels/labelstructs/secrets.go#L7>)

```go
func SecretsFrom(data string) (Secrets, error)
```



<a name="TLS"></a>
## type [TLS](<https://github.com/metal3d/katenary/blob/develop/generator/labels/labelstructs/ingress.go#L10-L12>)



```go
type TLS struct {
    Enabled bool `yaml:"enabled" json:"enabled,omitempty"`
}
```

<a name="ValueFrom"></a>
## type [ValueFrom](<https://github.com/metal3d/katenary/blob/develop/generator/labels/labelstructs/valueFrom.go#L5>)



```go
type ValueFrom map[string]string
```

<a name="GetValueFrom"></a>
### func [GetValueFrom](<https://github.com/metal3d/katenary/blob/develop/generator/labels/labelstructs/valueFrom.go#L7>)

```go
func GetValueFrom(data string) (*ValueFrom, error)
```



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