Update docs

2026-05-03 21:21:38 +02:00
parent 99c8e12f40
commit b9e81c7e49
9 changed files with 329 additions and 169 deletions
--- a/doc/docs/packages/internal/generator/extrafiles.md
+++ b/doc/docs/packages/internal/generator/extrafiles.md
@@ -8,7 +8,7 @@ import "katenary.io/internal/generator/extrafiles"

 Package extrafiles provides function to generate the Chart files that are not objects. Like README.md and notes.txt...

-## func [NotesFile](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/extrafiles/notes.go#L13>)
+## func NotesFile

 ```go
 func NotesFile(services []string) string
@@ -17,7 +17,7 @@ func NotesFile(services []string) string
 NotesFile returns the content of the note.txt file.

 <a name="ReadMeFile"></a>
-## func [ReadMeFile](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/extrafiles/readme.go#L46>)
+## func ReadMeFile

 ```go
 func ReadMeFile(charname, description string, values map[string]any) string
--- a/doc/docs/packages/internal/generator/katenaryfile.md
+++ b/doc/docs/packages/internal/generator/katenaryfile.md
@@ -12,7 +12,7 @@ A katenary file, named "katenary.yml" or "katenary.yaml", is a file where you ca

 Formely, the file describe the same structure as in labels, and so that can be validated and completed by LSP. It also ease the use of katenary.

-## func [GenerateSchema](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/katenaryfile/main.go#L141>)
+## func GenerateSchema

 ```go
 func GenerateSchema() string
@@ -21,7 +21,7 @@ func GenerateSchema() string
 GenerateSchema generates the schema for the katenary.yaml file.

 <a name="OverrideWithConfig"></a>
-## func [OverrideWithConfig](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/katenaryfile/main.go#L48>)
+## func OverrideWithConfig

 ```go
 func OverrideWithConfig(project *types.Project)
@@ -30,7 +30,7 @@ func OverrideWithConfig(project *types.Project)
 OverrideWithConfig overrides the project with the katenary.yaml file. It will set the labels of the services with the values from the katenary.yaml file. It work in memory, so it will not modify the original project.

 <a name="Service"></a>
-## type [Service](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/katenaryfile/main.go#L26-L43>)
+## type Service

 Service is a struct that contains the service configuration for katenary

@@ -56,7 +56,7 @@ type Service struct {
 ```

 <a name="StringOrMap"></a>
-## type [StringOrMap](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/katenaryfile/main.go#L23>)
+## type StringOrMap

 StringOrMap is a struct that can be either a string or a map of strings. It's a helper struct to unmarshal the katenary.yaml file and produce the schema

--- a/doc/docs/packages/internal/generator/labels.md
+++ b/doc/docs/packages/internal/generator/labels.md
@@ -17,7 +17,7 @@ const KatenaryLabelPrefix = "katenary.v3"
 ```

 <a name="GetLabelHelp"></a>
-## func [GetLabelHelp](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/labels/katenaryLabels.go#L90>)
+## func GetLabelHelp

 ```go
 func GetLabelHelp(asMarkdown bool) string
@@ -26,7 +26,7 @@ func GetLabelHelp(asMarkdown bool) string
 GetLabelHelp return the help for the labels.

 <a name="GetLabelHelpFor"></a>
-## func [GetLabelHelpFor](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/labels/katenaryLabels.go#L99>)
+## func GetLabelHelpFor

 ```go
 func GetLabelHelpFor(labelname string, asMarkdown bool) string
@@ -35,7 +35,7 @@ func GetLabelHelpFor(labelname string, asMarkdown bool) string
 GetLabelHelpFor returns the help for a specific label.

 <a name="GetLabelNames"></a>
-## func [GetLabelNames](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/labels/katenaryLabels.go#L74>)
+## func GetLabelNames

 ```go
 func GetLabelNames() []string
@@ -44,7 +44,7 @@ func GetLabelNames() []string
 GetLabelNames returns a sorted list of all katenary label names.

 <a name="Prefix"></a>
-## func [Prefix](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/labels/katenaryLabels.go#L237>)
+## func Prefix

 ```go
 func Prefix() string
@@ -53,7 +53,7 @@ func Prefix() string


 <a name="Help"></a>
-## type [Help](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/labels/katenaryLabels.go#L66-L71>)
+## type Help

 Help is the documentation of a label.

@@ -67,7 +67,7 @@ type Help struct {
 ```

 <a name="Label"></a>
-## type [Label](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/labels/katenaryLabels.go#L59>)
+## type Label

 Label is a katenary label to find in compose files.

@@ -100,7 +100,7 @@ const (
 ```

 <a name="LabelName"></a>
-### func [LabelName](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/labels/katenaryLabels.go#L61>)
+### func LabelName

 ```go
 func LabelName(name string) Label
--- a/doc/docs/packages/internal/generator/labels/labelstructs.md
+++ b/doc/docs/packages/internal/generator/labels/labelstructs.md
@@ -8,7 +8,7 @@ import "katenary.io/internal/generator/labels/labelstructs"

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

-## type [ConfigMapFiles](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/labels/labelstructs/configMap.go#L5>)
+## type ConfigMapFiles



@@ -17,7 +17,7 @@ type ConfigMapFiles []string
 ```

 <a name="ConfigMapFileFrom"></a>
-### func [ConfigMapFileFrom](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/labels/labelstructs/configMap.go#L7>)
+### func ConfigMapFileFrom

 ```go
 func ConfigMapFileFrom(data string) (ConfigMapFiles, error)
@@ -26,7 +26,7 @@ func ConfigMapFileFrom(data string) (ConfigMapFiles, error)


 <a name="CronJob"></a>
-## type [CronJob](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/labels/labelstructs/cronJob.go#L5-L10>)
+## type CronJob



@@ -40,7 +40,7 @@ type CronJob struct {
 ```

 <a name="CronJobFrom"></a>
-### func [CronJobFrom](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/labels/labelstructs/cronJob.go#L12>)
+### func CronJobFrom

 ```go
 func CronJobFrom(data string) (*CronJob, error)
@@ -49,7 +49,7 @@ func CronJobFrom(data string) (*CronJob, error)


 <a name="Dependency"></a>
-## type [Dependency](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/labels/labelstructs/dependencies.go#L6-L12>)
+## type Dependency

 Dependency is a dependency of a chart to other charts.

@@ -64,7 +64,7 @@ type Dependency struct {
 ```

 <a name="DependenciesFrom"></a>
-### func [DependenciesFrom](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/labels/labelstructs/dependencies.go#L15>)
+### func DependenciesFrom

 ```go
 func DependenciesFrom(data string) ([]Dependency, error)
@@ -73,7 +73,7 @@ func DependenciesFrom(data string) ([]Dependency, error)
 DependenciesFrom returns a slice of dependencies from the given string.

 <a name="EnvFrom"></a>
-## type [EnvFrom](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/labels/labelstructs/envFrom.go#L5>)
+## type EnvFrom



@@ -82,7 +82,7 @@ type EnvFrom []string
 ```

 <a name="EnvFromFrom"></a>
-### func [EnvFromFrom](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/labels/labelstructs/envFrom.go#L8>)
+### func EnvFromFrom

 ```go
 func EnvFromFrom(data string) (EnvFrom, error)
@@ -91,7 +91,7 @@ func EnvFromFrom(data string) (EnvFrom, error)
 EnvFromFrom returns a EnvFrom from the given string.

 <a name="ExchangeVolume"></a>
-## type [ExchangeVolume](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/labels/labelstructs/exchangeVolume.go#L5-L10>)
+## type ExchangeVolume



@@ -105,7 +105,7 @@ type ExchangeVolume struct {
 ```

 <a name="NewExchangeVolumes"></a>
-### func [NewExchangeVolumes](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/labels/labelstructs/exchangeVolume.go#L12>)
+### func NewExchangeVolumes

 ```go
 func NewExchangeVolumes(data string) ([]*ExchangeVolume, error)
@@ -114,7 +114,7 @@ func NewExchangeVolumes(data string) ([]*ExchangeVolume, error)


 <a name="HealthCheck"></a>
-## type [HealthCheck](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/labels/labelstructs/probes.go#L11-L14>)
+## type HealthCheck



@@ -126,7 +126,7 @@ type HealthCheck struct {
 ```

 <a name="ProbeFrom"></a>
-### func [ProbeFrom](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/labels/labelstructs/probes.go#L16>)
+### func ProbeFrom

 ```go
 func ProbeFrom(data string) (*HealthCheck, error)
@@ -135,7 +135,7 @@ func ProbeFrom(data string) (*HealthCheck, error)


 <a name="Ingress"></a>
-## type [Ingress](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/labels/labelstructs/ingress.go#L15-L23>)
+## type Ingress



@@ -145,14 +145,15 @@ type Ingress struct {
    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:-"`
+    Class       *string           `yaml:"class,omitempty" json:"class,omitempty" jsonschema:"default:traefik"`
+    Type        string            `yaml:"type,omitempty" json:"type,omitempty"`
    Enabled     bool              `yaml:"enabled,omitempty" json:"enabled,omitempty"`
    TLS         *TLS              `yaml:"tls,omitempty" json:"tls,omitempty"`
 }
 ```

 <a name="IngressFrom"></a>
-### func [IngressFrom](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/labels/labelstructs/ingress.go#L26>)
+### func IngressFrom

 ```go
 func IngressFrom(data string) (*Ingress, error)
@@ -161,7 +162,7 @@ func IngressFrom(data string) (*Ingress, error)
 IngressFrom creates a new Ingress from a compose service.

 <a name="MapEnv"></a>
-## type [MapEnv](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/labels/labelstructs/mapenv.go#L5>)
+## type MapEnv



@@ -170,7 +171,7 @@ type MapEnv map[string]string
 ```

 <a name="MapEnvFrom"></a>
-### func [MapEnvFrom](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/labels/labelstructs/mapenv.go#L8>)
+### func MapEnvFrom

 ```go
 func MapEnvFrom(data string) (MapEnv, error)
@@ -179,7 +180,7 @@ func MapEnvFrom(data string) (MapEnv, error)
 MapEnvFrom returns a MapEnv from the given string.

 <a name="Ports"></a>
-## type [Ports](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/labels/labelstructs/ports.go#L5>)
+## type Ports



@@ -188,7 +189,7 @@ type Ports []uint32
 ```

 <a name="PortsFrom"></a>
-### func [PortsFrom](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/labels/labelstructs/ports.go#L8>)
+### func PortsFrom

 ```go
 func PortsFrom(data string) (Ports, error)
@@ -197,7 +198,7 @@ func PortsFrom(data string) (Ports, error)
 PortsFrom returns a Ports from the given string.

 <a name="Secrets"></a>
-## type [Secrets](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/labels/labelstructs/secrets.go#L5>)
+## type Secrets



@@ -206,7 +207,7 @@ type Secrets []string
 ```

 <a name="SecretsFrom"></a>
-### func [SecretsFrom](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/labels/labelstructs/secrets.go#L7>)
+### func SecretsFrom

 ```go
 func SecretsFrom(data string) (Secrets, error)
@@ -215,7 +216,7 @@ func SecretsFrom(data string) (Secrets, error)


 <a name="TLS"></a>
-## type [TLS](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/labels/labelstructs/ingress.go#L11-L13>)
+## type TLS



@@ -226,7 +227,7 @@ type TLS struct {
 ```

 <a name="ValueFrom"></a>
-## type [ValueFrom](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/labels/labelstructs/valueFrom.go#L5>)
+## type ValueFrom



@@ -235,7 +236,7 @@ type ValueFrom map[string]string
 ```

 <a name="GetValueFrom"></a>
-### func [GetValueFrom](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/labels/labelstructs/valueFrom.go#L7>)
+### func GetValueFrom

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