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

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

# labelStructs

```go
import "katenary/generator/labelStructs"
```

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/labelStructs/configMap.go#L5>)



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

<a name="ConfigMapFileFrom"></a>
### func [ConfigMapFileFrom](<https://github.com/metal3d/katenary/blob/develop/generator/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/labelStructs/cronJob.go#L5-L10>)



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

<a name="CronJobFrom"></a>
### func [CronJobFrom](<https://github.com/metal3d/katenary/blob/develop/generator/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/labelStructs/dependencies.go#L6-L12>)

Dependency is a dependency of a chart to other charts.

```go
type Dependency struct {
    Name       string         `yaml:"name"`
    Version    string         `yaml:"version"`
    Repository string         `yaml:"repository"`
    Alias      string         `yaml:"alias,omitempty"`
    Values     map[string]any `yaml:"-"` // do not export to Chart.yaml
}
```

<a name="DependenciesFrom"></a>
### func [DependenciesFrom](<https://github.com/metal3d/katenary/blob/develop/generator/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/labelStructs/envFrom.go#L5>)



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

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

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

EnvFromFrom returns a EnvFrom from the given string.

<a name="Ingress"></a>
## type [Ingress](<https://github.com/metal3d/katenary/blob/develop/generator/labelStructs/ingress.go#L5-L18>)



```go
type Ingress struct {
    // Hostname is the hostname to match against the request. It can contain wildcards.
    Hostname string `yaml:"hostname"`
    // Path is the path to match against the request. It can contain wildcards.
    Path string `yaml:"path"`
    // Enabled is a flag to enable or disable the ingress.
    Enabled bool `yaml:"enabled"`
    // Class is the ingress class to use.
    Class string `yaml:"class"`
    // Port is the port to use.
    Port *int32 `yaml:"port,omitempty"`
    // Annotations is a list of key-value pairs to add to the ingress.
    Annotations map[string]string `yaml:"annotations,omitempty"`
}
```

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

```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/labelStructs/mapenv.go#L5>)



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

<a name="MapEnvFrom"></a>
### func [MapEnvFrom](<https://github.com/metal3d/katenary/blob/develop/generator/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/labelStructs/ports.go#L5>)



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

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

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

PortsFrom returns a Ports from the given string.

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



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

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

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



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



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

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

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



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