2025-07-06 15:36:43 +02:00
|
|
|
<!-- Code generated by gomarkdoc. DO NOT EDIT -->
|
|
|
|
|
|
|
|
|
|
# labelstructs
|
|
|
|
|
|
|
|
|
|
```go
|
2025-08-20 12:16:14 +02:00
|
|
|
import "katenary.io/internal/generator/labels/labelstructs"
|
2025-07-06 15:36:43 +02:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Package labelstructs is a package that contains the structs used to represent the labels in the yaml files.
|
|
|
|
|
|
2026-05-03 21:21:38 +02:00
|
|
|
## type ConfigMapFiles
|
2025-07-06 15:36:43 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
```go
|
2025-08-03 15:54:58 +02:00
|
|
|
type ConfigMapFiles []string
|
2025-07-06 15:36:43 +02:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
<a name="ConfigMapFileFrom"></a>
|
2026-05-03 21:21:38 +02:00
|
|
|
### func ConfigMapFileFrom
|
2025-07-06 15:36:43 +02:00
|
|
|
|
|
|
|
|
```go
|
2025-08-03 15:54:58 +02:00
|
|
|
func ConfigMapFileFrom(data string) (ConfigMapFiles, error)
|
2025-07-06 15:36:43 +02:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a name="CronJob"></a>
|
2026-05-03 21:21:38 +02:00
|
|
|
## type CronJob
|
2025-07-06 15:36:43 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
```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>
|
2026-05-03 21:21:38 +02:00
|
|
|
### func CronJobFrom
|
2025-07-06 15:36:43 +02:00
|
|
|
|
|
|
|
|
```go
|
|
|
|
|
func CronJobFrom(data string) (*CronJob, error)
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a name="Dependency"></a>
|
2026-05-03 21:21:38 +02:00
|
|
|
## type Dependency
|
2025-07-06 15:36:43 +02:00
|
|
|
|
|
|
|
|
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>
|
2026-05-03 21:21:38 +02:00
|
|
|
### func DependenciesFrom
|
2025-07-06 15:36:43 +02:00
|
|
|
|
|
|
|
|
```go
|
|
|
|
|
func DependenciesFrom(data string) ([]Dependency, error)
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
DependenciesFrom returns a slice of dependencies from the given string.
|
|
|
|
|
|
|
|
|
|
<a name="EnvFrom"></a>
|
2026-05-03 21:21:38 +02:00
|
|
|
## type EnvFrom
|
2025-07-06 15:36:43 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
```go
|
|
|
|
|
type EnvFrom []string
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
<a name="EnvFromFrom"></a>
|
2026-05-03 21:21:38 +02:00
|
|
|
### func EnvFromFrom
|
2025-07-06 15:36:43 +02:00
|
|
|
|
|
|
|
|
```go
|
|
|
|
|
func EnvFromFrom(data string) (EnvFrom, error)
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
EnvFromFrom returns a EnvFrom from the given string.
|
|
|
|
|
|
|
|
|
|
<a name="ExchangeVolume"></a>
|
2026-05-03 21:21:38 +02:00
|
|
|
## type ExchangeVolume
|
2025-07-06 15:36:43 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
```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>
|
2026-05-03 21:21:38 +02:00
|
|
|
### func NewExchangeVolumes
|
2025-07-06 15:36:43 +02:00
|
|
|
|
|
|
|
|
```go
|
|
|
|
|
func NewExchangeVolumes(data string) ([]*ExchangeVolume, error)
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a name="HealthCheck"></a>
|
2026-05-03 21:21:38 +02:00
|
|
|
## type HealthCheck
|
2025-07-06 15:36:43 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
```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>
|
2026-05-03 21:21:38 +02:00
|
|
|
### func ProbeFrom
|
2025-07-06 15:36:43 +02:00
|
|
|
|
|
|
|
|
```go
|
|
|
|
|
func ProbeFrom(data string) (*HealthCheck, error)
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a name="Ingress"></a>
|
2026-05-03 21:21:38 +02:00
|
|
|
## type Ingress
|
2025-07-06 15:36:43 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
```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"`
|
2026-05-03 21:21:38 +02:00
|
|
|
Class *string `yaml:"class,omitempty" json:"class,omitempty" jsonschema:"default:traefik"`
|
|
|
|
|
Type string `yaml:"type,omitempty" json:"type,omitempty"`
|
2025-07-06 15:36:43 +02:00
|
|
|
Enabled bool `yaml:"enabled,omitempty" json:"enabled,omitempty"`
|
|
|
|
|
TLS *TLS `yaml:"tls,omitempty" json:"tls,omitempty"`
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
<a name="IngressFrom"></a>
|
2026-05-03 21:21:38 +02:00
|
|
|
### func IngressFrom
|
2025-07-06 15:36:43 +02:00
|
|
|
|
|
|
|
|
```go
|
|
|
|
|
func IngressFrom(data string) (*Ingress, error)
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
IngressFrom creates a new Ingress from a compose service.
|
|
|
|
|
|
|
|
|
|
<a name="MapEnv"></a>
|
2026-05-03 21:21:38 +02:00
|
|
|
## type MapEnv
|
2025-07-06 15:36:43 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
```go
|
|
|
|
|
type MapEnv map[string]string
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
<a name="MapEnvFrom"></a>
|
2026-05-03 21:21:38 +02:00
|
|
|
### func MapEnvFrom
|
2025-07-06 15:36:43 +02:00
|
|
|
|
|
|
|
|
```go
|
|
|
|
|
func MapEnvFrom(data string) (MapEnv, error)
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
MapEnvFrom returns a MapEnv from the given string.
|
|
|
|
|
|
|
|
|
|
<a name="Ports"></a>
|
2026-05-03 21:21:38 +02:00
|
|
|
## type Ports
|
2025-07-06 15:36:43 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
```go
|
|
|
|
|
type Ports []uint32
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
<a name="PortsFrom"></a>
|
2026-05-03 21:21:38 +02:00
|
|
|
### func PortsFrom
|
2025-07-06 15:36:43 +02:00
|
|
|
|
|
|
|
|
```go
|
|
|
|
|
func PortsFrom(data string) (Ports, error)
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
PortsFrom returns a Ports from the given string.
|
|
|
|
|
|
|
|
|
|
<a name="Secrets"></a>
|
2026-05-03 21:21:38 +02:00
|
|
|
## type Secrets
|
2025-07-06 15:36:43 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
```go
|
|
|
|
|
type Secrets []string
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
<a name="SecretsFrom"></a>
|
2026-05-03 21:21:38 +02:00
|
|
|
### func SecretsFrom
|
2025-07-06 15:36:43 +02:00
|
|
|
|
|
|
|
|
```go
|
|
|
|
|
func SecretsFrom(data string) (Secrets, error)
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a name="TLS"></a>
|
2026-05-03 21:21:38 +02:00
|
|
|
## type TLS
|
2025-07-06 15:36:43 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
```go
|
|
|
|
|
type TLS struct {
|
|
|
|
|
Enabled bool `yaml:"enabled" json:"enabled,omitempty"`
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
<a name="ValueFrom"></a>
|
2026-05-03 21:21:38 +02:00
|
|
|
## type ValueFrom
|
2025-07-06 15:36:43 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
```go
|
|
|
|
|
type ValueFrom map[string]string
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
<a name="GetValueFrom"></a>
|
2026-05-03 21:21:38 +02:00
|
|
|
### func GetValueFrom
|
2025-07-06 15:36:43 +02:00
|
|
|
|
|
|
|
|
```go
|
|
|
|
|
func GetValueFrom(data string) (*ValueFrom, error)
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Generated by [gomarkdoc](<https://github.com/princjef/gomarkdoc>)
|