chore(doc): Regenerated doc

doc/docs/packages/generator.md

@@ -465,7 +465,7 @@ type HelmChart struct {
     AppVersion   string                    `yaml:"appVersion"`
     Description  string                    `yaml:"description"`
     Helper       string                    `yaml:"-"`
-    Dependencies []labelStructs.Dependency `yaml:"dependencies,omitempty"`
+    Dependencies []labelstructs.Dependency `yaml:"dependencies,omitempty"`
     // contains filtered or unexported fields
 }
 ```

doc/docs/packages/generator/katenaryfile.md

@@ -38,20 +38,20 @@ Service is a struct that contains the service configuration for katenary
 type Service struct {
     MainApp         *bool                          `json:"main-app,omitempty" jsonschema:"title=Is this service the main application"`
     Values          []StringOrMap                  `json:"values,omitempty" jsonschema:"description=Environment variables to be set in values.yaml with or without a description"`
-    Secrets         *labelStructs.Secrets          `json:"secrets,omitempty" jsonschema:"title=Secrets,description=Environment variables to be set as secrets"`
+    Secrets         *labelstructs.Secrets          `json:"secrets,omitempty" jsonschema:"title=Secrets,description=Environment variables to be set as secrets"`
-    Ports           *labelStructs.Ports            `json:"ports,omitempty" jsonschema:"title=Ports,description=Ports to be exposed in services"`
+    Ports           *labelstructs.Ports            `json:"ports,omitempty" jsonschema:"title=Ports,description=Ports to be exposed in services"`
-    Ingress         *labelStructs.Ingress          `json:"ingress,omitempty" jsonschema:"title=Ingress,description=Ingress configuration"`
+    Ingress         *labelstructs.Ingress          `json:"ingress,omitempty" jsonschema:"title=Ingress,description=Ingress configuration"`
-    HealthCheck     *labelStructs.HealthCheck      `json:"health-check,omitempty" jsonschema:"title=Health Check,description=Health check configuration that respects the kubernetes api"`
+    HealthCheck     *labelstructs.HealthCheck      `json:"health-check,omitempty" jsonschema:"title=Health Check,description=Health check configuration that respects the kubernetes api"`
     SamePod         *string                        `json:"same-pod,omitempty" jsonschema:"title=Same Pod,description=Service that should be in the same pod"`
     Description     *string                        `json:"description,omitempty" jsonschema:"title=Description,description=Description of the service that will be injected in the values.yaml file"`
     Ignore          *bool                          `json:"ignore,omitempty" jsonschema:"title=Ignore,description=Ignore the service in the conversion"`
-    Dependencies    []labelStructs.Dependency      `json:"dependencies,omitempty" jsonschema:"title=Dependencies,description=Services that should be injected in the Chart.yaml file"`
+    Dependencies    []labelstructs.Dependency      `json:"dependencies,omitempty" jsonschema:"title=Dependencies,description=Services that should be injected in the Chart.yaml file"`
-    ConfigMapFile   *labelStructs.ConfigMapFile    `json:"configmap-files,omitempty" jsonschema:"title=ConfigMap Files,description=Files that should be injected as ConfigMap"`
+    ConfigMapFile   *labelstructs.ConfigMapFile    `json:"configmap-files,omitempty" jsonschema:"title=ConfigMap Files,description=Files that should be injected as ConfigMap"`
-    MapEnv          *labelStructs.MapEnv           `json:"map-env,omitempty" jsonschema:"title=Map Env,description=Map environment variables to another value"`
+    MapEnv          *labelstructs.MapEnv           `json:"map-env,omitempty" jsonschema:"title=Map Env,description=Map environment variables to another value"`
-    CronJob         *labelStructs.CronJob          `json:"cron-job,omitempty" jsonschema:"title=Cron Job,description=Cron Job configuration"`
+    CronJob         *labelstructs.CronJob          `json:"cron-job,omitempty" jsonschema:"title=Cron Job,description=Cron Job configuration"`
-    EnvFrom         *labelStructs.EnvFrom          `json:"env-from,omitempty" jsonschema:"title=Env From,description=Inject environment variables from another service"`
+    EnvFrom         *labelstructs.EnvFrom          `json:"env-from,omitempty" jsonschema:"title=Env From,description=Inject environment variables from another service"`
-    ExchangeVolumes []*labelStructs.ExchangeVolume `json:"exchange-volumes,omitempty" jsonschema:"title=Exchange Volumes,description=Exchange volumes between services"`
+    ExchangeVolumes []*labelstructs.ExchangeVolume `json:"exchange-volumes,omitempty" jsonschema:"title=Exchange Volumes,description=Exchange volumes between services"`
-    ValuesFrom      *labelStructs.ValueFrom        `json:"values-from,omitempty" jsonschema:"title=Values From,description=Inject values from another service (secret or configmap environment variables)"`
+    ValuesFrom      *labelstructs.ValueFrom        `json:"values-from,omitempty" jsonschema:"title=Values From,description=Inject values from another service (secret or configmap environment variables)"`
 }
 ```
 

doc/docs/packages/generator/labels.md

@@ -23,7 +23,7 @@ const KatenaryLabelPrefix = "katenary.v3"
 func GetLabelHelp(asMarkdown bool) string
 ```
 
-Generate the help for the labels.
+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>)

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

@@ -0,0 +1,246 @@
+<!-- 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>)

doc/docs/packages/utils.md

@@ -8,7 +8,16 @@ import "katenary/utils"
 
 Package utils provides some utility functions used in katenary. It defines some constants and functions used in the whole project.
 
-## func [AsResourceName](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L193>)
+## Constants
+
+<a name="DirectoryPermission"></a>DirectoryPermission is the default values for permissions apply to created directories.
+
+```go
+const DirectoryPermission = 0o755
+```
+
+<a name="AsResourceName"></a>
+## func [AsResourceName](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L196>)
 
 ```go
 func AsResourceName(name string) string
@@ -17,7 +26,7 @@ func AsResourceName(name string) string
 AsResourceName returns a resource name with underscores to respect the kubernetes naming convention. It's the opposite of FixedResourceName.
 
 <a name="Confirm"></a>
-## func [Confirm](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L161>)
+## func [Confirm](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L164>)
 
 ```go
 func Confirm(question string, icon ...Icon) bool
@@ -26,7 +35,7 @@ func Confirm(question string, icon ...Icon) bool
 Confirm asks a question and returns true if the answer is y.
 
 <a name="CountStartingSpaces"></a>
-## func [CountStartingSpaces](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L38>)
+## func [CountStartingSpaces](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L41>)
 
 ```go
 func CountStartingSpaces(line string) int
@@ -35,7 +44,7 @@ func CountStartingSpaces(line string) int
 CountStartingSpaces counts the number of spaces at the beginning of a string.
 
 <a name="EncodeBasicYaml"></a>
-## func [EncodeBasicYaml](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L175>)
+## func [EncodeBasicYaml](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L178>)
 
 ```go
 func EncodeBasicYaml(data any) ([]byte, error)
@@ -44,7 +53,7 @@ func EncodeBasicYaml(data any) ([]byte, error)
 EncodeBasicYaml encodes a basic yaml from an interface.
 
 <a name="FixedResourceName"></a>
-## func [FixedResourceName](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L187>)
+## func [FixedResourceName](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L190>)
 
 ```go
 func FixedResourceName(name string) string
@@ -53,7 +62,7 @@ func FixedResourceName(name string) string
 FixedResourceName returns a resource name without underscores to respect the kubernetes naming convention.
 
 <a name="GetContainerByName"></a>
-## func [GetContainerByName](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L84>)
+## func [GetContainerByName](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L87>)
 
 ```go
 func GetContainerByName(name string, containers []corev1.Container) (*corev1.Container, int)
@@ -62,7 +71,7 @@ func GetContainerByName(name string, containers []corev1.Container) (*corev1.Con
 GetContainerByName returns a container by name and its index in the array. It returns nil, \-1 if not found.
 
 <a name="GetKind"></a>
-## func [GetKind](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L51>)
+## func [GetKind](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L54>)
 
 ```go
 func GetKind(path string) (kind string)
@@ -71,7 +80,7 @@ func GetKind(path string) (kind string)
 GetKind returns the kind of the resource from the file path.
 
 <a name="GetServiceNameByPort"></a>
-## func [GetServiceNameByPort](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L74>)
+## func [GetServiceNameByPort](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L77>)
 
 ```go
 func GetServiceNameByPort(port int) string
@@ -80,7 +89,7 @@ func GetServiceNameByPort(port int) string
 GetServiceNameByPort returns the service name for a port. It the service name is not found, it returns an empty string.
 
 <a name="GetValuesFromLabel"></a>
-## func [GetValuesFromLabel](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L126>)
+## func [GetValuesFromLabel](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L129>)
 
 ```go
 func GetValuesFromLabel(service types.ServiceConfig, LabelValues string) map[string]*EnvConfig
@@ -98,7 +107,7 @@ func HashComposefiles(files []string) (string, error)
 HashComposefiles returns a hash of the compose files.
 
 <a name="Int32Ptr"></a>
-## func [Int32Ptr](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L32>)
+## func [Int32Ptr](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L35>)
 
 ```go
 func Int32Ptr(i int32) *int32
@@ -107,7 +116,7 @@ func Int32Ptr(i int32) *int32
 Int32Ptr returns a pointer to an int32.
 
 <a name="PathToName"></a>
-## func [PathToName](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L103>)
+## func [PathToName](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L106>)
 
 ```go
 func PathToName(path string) string
@@ -116,7 +125,7 @@ func PathToName(path string) string
 PathToName converts a path to a kubernetes complient name.
 
 <a name="StrPtr"></a>
-## func [StrPtr](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L35>)
+## func [StrPtr](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L38>)
 
 ```go
 func StrPtr(s string) *string
@@ -125,7 +134,7 @@ func StrPtr(s string) *string
 StrPtr returns a pointer to a string.
 
 <a name="TplName"></a>
-## func [TplName](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L19>)
+## func [TplName](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L22>)
 
 ```go
 func TplName(serviceName, appname string, suffix ...string) string
@@ -134,7 +143,7 @@ func TplName(serviceName, appname string, suffix ...string) string
 TplName returns the name of the kubernetes resource as a template string. It is used in the templates and defined in \_helper.tpl file.
 
 <a name="TplValue"></a>
-## func [TplValue](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L94>)
+## func [TplValue](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L97>)
 
 ```go
 func TplValue(serviceName, variable string, pipes ...string) string
@@ -152,7 +161,7 @@ func Warn(msg ...any)
 Warn prints a warning message
 
 <a name="WordWrap"></a>
-## func [WordWrap](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L156>)
+## func [WordWrap](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L159>)
 
 ```go
 func WordWrap(text string, lineWidth int) string
@@ -161,7 +170,7 @@ func WordWrap(text string, lineWidth int) string
 WordWrap wraps a string to a given line width. Warning: it may break the string. You need to check the result.
 
 <a name="Wrap"></a>
-## func [Wrap](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L68>)
+## func [Wrap](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L71>)
 
 ```go
 func Wrap(src, above, below string) string
@@ -170,7 +179,7 @@ func Wrap(src, above, below string) string
 Wrap wraps a string with a string above and below. It will respect the indentation of the src string.
 
 <a name="EnvConfig"></a>
-## type [EnvConfig](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L120-L123>)
+## type [EnvConfig](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L123-L126>)
 
 EnvConfig is a struct to hold the description of an environment variable.