feat(doc): regenerate documentation

2025-06-04 15:18:11 +02:00
parent b143f743ef
commit d94bb8ac32
9 changed files with 73 additions and 142 deletions
--- a/doc/docs/.markdownlint.yaml
+++ b/doc/docs/.markdownlint.yaml
@@ -0,0 +1,5 @@
+MD012: false
+MD013: false
+MD022: false
+MD033: false
+MD046: false
--- a/doc/docs/labels.md
+++ b/doc/docs/labels.md
@@ -61,7 +61,6 @@ labels:
    - ./conf.d
 ```

-
 ### katenary.v3/cronjob

 Create a cronjob from the service.
@@ -71,6 +70,7 @@ Create a cronjob from the service.
 This adds a cronjob to the chart.

 The label value is a YAML object with the following attributes:
+
 - command: the command to be executed
 - schedule: the cron schedule (cron format or @every where "every" is a
  duration like 1h30m, daily, hourly...)
@@ -86,7 +86,6 @@ labels:
        schedule: "* */1 * * *" # or @hourly for example
 ```

-
 ### katenary.v3/dependencies

 Add Helm dependencies to the service.
@@ -133,7 +132,6 @@ labels:
          password: the secret password
 ```

-
 ### katenary.v3/description

 Description of the service
@@ -154,7 +152,6 @@ labels:
    It can be multiline.
 ```

-
 ### katenary.v3/env-from

 Add environment variables from antoher service.
@@ -180,7 +177,6 @@ service2:
        - myservice1
 ```

-
 ### katenary.v3/exchange-volumes

 Add exchange volumes (empty directory on the node) to share data
@@ -198,6 +194,7 @@ This will create:
 - a `initContainer` for each definition

 Fields:
+
 - name: the name of the volume (manadatory)
 - mountPath: the path where the volume is mounted in the pod (optional, default is `/opt`)
 - init: a command to run to initialize the volume with data (optional)
@@ -223,7 +220,6 @@ php:
        init: cp -ra /var/www/html/* /opt
 ```

-
 ### katenary.v3/health-check

 Health check to be added to the deployment.
@@ -243,7 +239,6 @@ labels:
        port: 8080
 ```

-
 ### katenary.v3/ignore

 Ignore the service
@@ -259,7 +254,6 @@ labels:
  katenary.v3/ignore: "true"
 ```

-
 ### katenary.v3/ingress

 Ingress rules to be added to the service.
@@ -278,7 +272,6 @@ labels:
    hostname: mywebsite.com (optional)
 ```

-
 ### katenary.v3/main-app

 Mark the service as the main app.
@@ -305,7 +298,6 @@ ghost:
    katenary.v3/main-app: true
 ```

-
 ### katenary.v3/map-env

 Map env vars from the service to the deployment.
@@ -333,7 +325,6 @@ labels:
    DB_HOST: '{{ include "__APP__.fullname" . }}-database'
 ```

-
 ### katenary.v3/ports

 Ports to be added to the service.
@@ -352,7 +343,6 @@ labels:
    - 8081
 ```

-
 ### katenary.v3/same-pod

 Move the same-pod deployment to the target deployment.
@@ -377,7 +367,6 @@ php:
    katenary.v3/same-pod: web
 ```

-
 ### katenary.v3/secrets

 Env vars to be set as secrets.
@@ -401,7 +390,6 @@ labels:
    - PASSWORD
 ```

-
 ### katenary.v3/values

 Environment variables to be added to the values.yaml
@@ -438,7 +426,6 @@ labels:
        It can be, of course,  a multiline text.
 ```

-
 ### katenary.v3/values-from

 Add values from another service.
@@ -460,9 +447,9 @@ database:
    MARIADB_USER: myuser
    MARIADB_PASSWORD: mypassword
  labels:
-    # it can be a secret
+    # we can declare secrets
    katenary.v3/secrets: |-
-      - DB_PASSWORD
+      - MARIADB_PASSWORD
 php:
  image: php:7.4-fpm
  environment:
@@ -476,5 +463,4 @@ php:
      DB_PASSWORD: database.MARIADB_PASSWORD
 ```

-
 <!-- STOP_DETAILED_DOC : do not remove this tag !-->
--- a/doc/docs/packages/generator.md
+++ b/doc/docs/packages/generator.md
@@ -35,7 +35,7 @@ var Version = "master" // changed at compile time
 ```

 <a name="Convert"></a>
-## func [Convert](<https://github.com/metal3d/katenary/blob/develop/generator/converter.go#L93>)
+## func [Convert](<https://github.com/metal3d/katenary/blob/develop/generator/converter.go#L99>)

 ```go
 func Convert(config ConvertOptions, dockerComposeFile ...string) error
@@ -92,7 +92,7 @@ NewCronJob creates a new CronJob from a compose service. The appName is the name
 ## func [ToK8SYaml](<https://github.com/metal3d/katenary/blob/develop/generator/utils.go#L90>)

 ```go
-func ToK8SYaml(obj interface{}) ([]byte, error)
+func ToK8SYaml(obj any) ([]byte, error)
 ```


@@ -149,7 +149,7 @@ func NewConfigMapFromDirectory(service types.ServiceConfig, appName, path string
 NewConfigMapFromDirectory creates a new ConfigMap from a compose service. This path is the path to the file or directory. If the path is a directory, all files in the directory are added to the ConfigMap. Each subdirectory are ignored. Note that the Generate\(\) function will create the subdirectories ConfigMaps.

 <a name="ConfigMap.AddBinaryData"></a>
-### func \(\*ConfigMap\) [AddBinaryData](<https://github.com/metal3d/katenary/blob/develop/generator/configMap.go#L155>)
+### func \(\*ConfigMap\) [AddBinaryData](<https://github.com/metal3d/katenary/blob/develop/generator/configMap.go#L157>)

 ```go
 func (c *ConfigMap) AddBinaryData(key string, value []byte)
@@ -158,7 +158,7 @@ func (c *ConfigMap) AddBinaryData(key string, value []byte)
 AddBinaryData adds binary data to the configmap. Append or overwrite the value if the key already exists.

 <a name="ConfigMap.AddData"></a>
-### func \(\*ConfigMap\) [AddData](<https://github.com/metal3d/katenary/blob/develop/generator/configMap.go#L150>)
+### func \(\*ConfigMap\) [AddData](<https://github.com/metal3d/katenary/blob/develop/generator/configMap.go#L152>)

 ```go
 func (c *ConfigMap) AddData(key, value string)
@@ -167,7 +167,7 @@ func (c *ConfigMap) AddData(key, value string)
 AddData adds a key value pair to the configmap. Append or overwrite the value if the key already exists.

 <a name="ConfigMap.AppendDir"></a>
-### func \(\*ConfigMap\) [AppendDir](<https://github.com/metal3d/katenary/blob/develop/generator/configMap.go#L164>)
+### func \(\*ConfigMap\) [AppendDir](<https://github.com/metal3d/katenary/blob/develop/generator/configMap.go#L166>)

 ```go
 func (c *ConfigMap) AppendDir(path string) error
@@ -176,7 +176,7 @@ func (c *ConfigMap) AppendDir(path string) error
 AddFile adds files from given path to the configmap. It is not recursive, to add all files in a directory, you need to call this function for each subdirectory.

 <a name="ConfigMap.AppendFile"></a>
-### func \(\*ConfigMap\) [AppendFile](<https://github.com/metal3d/katenary/blob/develop/generator/configMap.go#L211>)
+### func \(\*ConfigMap\) [AppendFile](<https://github.com/metal3d/katenary/blob/develop/generator/configMap.go#L213>)

 ```go
 func (c *ConfigMap) AppendFile(path string) error
@@ -185,7 +185,7 @@ func (c *ConfigMap) AppendFile(path string) error


 <a name="ConfigMap.Filename"></a>
-### func \(\*ConfigMap\) [Filename](<https://github.com/metal3d/katenary/blob/develop/generator/configMap.go#L235>)
+### func \(\*ConfigMap\) [Filename](<https://github.com/metal3d/katenary/blob/develop/generator/configMap.go#L237>)

 ```go
 func (c *ConfigMap) Filename() string
@@ -194,7 +194,7 @@ func (c *ConfigMap) Filename() string
 Filename returns the filename of the configmap. If the configmap is used for files, the filename contains the path.

 <a name="ConfigMap.SetData"></a>
-### func \(\*ConfigMap\) [SetData](<https://github.com/metal3d/katenary/blob/develop/generator/configMap.go#L245>)
+### func \(\*ConfigMap\) [SetData](<https://github.com/metal3d/katenary/blob/develop/generator/configMap.go#L247>)

 ```go
 func (c *ConfigMap) SetData(data map[string]string)
@@ -203,7 +203,7 @@ func (c *ConfigMap) SetData(data map[string]string)
 SetData sets the data of the configmap. It replaces the entire data.

 <a name="ConfigMap.Yaml"></a>
-### func \(\*ConfigMap\) [Yaml](<https://github.com/metal3d/katenary/blob/develop/generator/configMap.go#L250>)
+### func \(\*ConfigMap\) [Yaml](<https://github.com/metal3d/katenary/blob/develop/generator/configMap.go#L252>)

 ```go
 func (c *ConfigMap) Yaml() ([]byte, error)
@@ -275,7 +275,7 @@ Yaml returns the yaml representation of the cronjob.
 Implements the Yaml interface.

 <a name="CronJobValue"></a>
-## type [CronJobValue](<https://github.com/metal3d/katenary/blob/develop/generator/values.go#L113-L118>)
+## type [CronJobValue](<https://github.com/metal3d/katenary/blob/develop/generator/values.go#L118-L123>)

 CronJobValue is a cronjob configuration that will be saved in values.yaml.

@@ -376,7 +376,7 @@ func (d *Deployment) BindFrom(service types.ServiceConfig, binded *Deployment)


 <a name="Deployment.BindMapFilesToContainer"></a>
-### func \(\*Deployment\) [BindMapFilesToContainer](<https://github.com/metal3d/katenary/blob/develop/generator/deployment.go#L377>)
+### func \(\*Deployment\) [BindMapFilesToContainer](<https://github.com/metal3d/katenary/blob/develop/generator/deployment.go#L374>)

 ```go
 func (d *Deployment) BindMapFilesToContainer(service types.ServiceConfig, secrets []string, appName string) (*corev1.Container, int)
@@ -403,7 +403,7 @@ func (d *Deployment) Filename() string
 Filename returns the filename of the deployment.

 <a name="Deployment.MountExchangeVolumes"></a>
-### func \(\*Deployment\) [MountExchangeVolumes](<https://github.com/metal3d/katenary/blob/develop/generator/deployment.go#L428>)
+### func \(\*Deployment\) [MountExchangeVolumes](<https://github.com/metal3d/katenary/blob/develop/generator/deployment.go#L425>)

 ```go
 func (d *Deployment) MountExchangeVolumes()
@@ -421,7 +421,7 @@ func (d *Deployment) SetEnvFrom(service types.ServiceConfig, appName string, sam
 SetEnvFrom sets the environment variables to a configmap. The configmap is created.

 <a name="Deployment.Yaml"></a>
-### func \(\*Deployment\) [Yaml](<https://github.com/metal3d/katenary/blob/develop/generator/deployment.go#L452>)
+### func \(\*Deployment\) [Yaml](<https://github.com/metal3d/katenary/blob/develop/generator/deployment.go#L449>)

 ```go
 func (d *Deployment) Yaml() ([]byte, error)
@@ -471,7 +471,7 @@ type HelmChart struct {
 ```

 <a name="Generate"></a>
-### func [Generate](<https://github.com/metal3d/katenary/blob/develop/generator/generator.go#L29>)
+### func [Generate](<https://github.com/metal3d/katenary/blob/develop/generator/generator.go#L31>)

 ```go
 func Generate(project *types.Project) (*HelmChart, error)
@@ -509,7 +509,7 @@ func (chart *HelmChart) SaveTemplates(templateDir string)
 SaveTemplates the templates of the chart to the given directory.

 <a name="Ingress"></a>
-## type [Ingress](<https://github.com/metal3d/katenary/blob/develop/generator/ingress.go#L17-L20>)
+## type [Ingress](<https://github.com/metal3d/katenary/blob/develop/generator/ingress.go#L17-L21>)



@@ -521,7 +521,7 @@ type Ingress struct {
 ```

 <a name="NewIngress"></a>
-### func [NewIngress](<https://github.com/metal3d/katenary/blob/develop/generator/ingress.go#L23>)
+### func [NewIngress](<https://github.com/metal3d/katenary/blob/develop/generator/ingress.go#L24>)

 ```go
 func NewIngress(service types.ServiceConfig, Chart *HelmChart) *Ingress
@@ -530,7 +530,7 @@ func NewIngress(service types.ServiceConfig, Chart *HelmChart) *Ingress
 NewIngress creates a new Ingress from a compose service.

 <a name="Ingress.Filename"></a>
-### func \(\*Ingress\) [Filename](<https://github.com/metal3d/katenary/blob/develop/generator/ingress.go#L122>)
+### func \(\*Ingress\) [Filename](<https://github.com/metal3d/katenary/blob/develop/generator/ingress.go#L128>)

 ```go
 func (ingress *Ingress) Filename() string
@@ -539,7 +539,7 @@ func (ingress *Ingress) Filename() string


 <a name="Ingress.Yaml"></a>
-### func \(\*Ingress\) [Yaml](<https://github.com/metal3d/katenary/blob/develop/generator/ingress.go#L126>)
+### func \(\*Ingress\) [Yaml](<https://github.com/metal3d/katenary/blob/develop/generator/ingress.go#L132>)

 ```go
 func (ingress *Ingress) Yaml() ([]byte, error)
@@ -548,7 +548,7 @@ func (ingress *Ingress) Yaml() ([]byte, error)


 <a name="IngressValue"></a>
-## type [IngressValue](<https://github.com/metal3d/katenary/blob/develop/generator/values.go#L28-L35>)
+## type [IngressValue](<https://github.com/metal3d/katenary/blob/develop/generator/values.go#L29-L36>)

 IngressValue is a ingress configuration that will be saved in values.yaml.

@@ -809,18 +809,19 @@ func (r *ServiceAccount) Yaml() ([]byte, error)


 <a name="TLS"></a>
-## type [TLS](<https://github.com/metal3d/katenary/blob/develop/generator/values.go#L23-L25>)
+## type [TLS](<https://github.com/metal3d/katenary/blob/develop/generator/values.go#L23-L26>)



 ```go
 type TLS struct {
    Enabled    bool   `yaml:"enabled"`
+    SecretName string `yaml:"secretName"`
 }
 ```

 <a name="Value"></a>
-## type [Value](<https://github.com/metal3d/katenary/blob/develop/generator/values.go#L38-L49>)
+## type [Value](<https://github.com/metal3d/katenary/blob/develop/generator/values.go#L39-L50>)

 Value will be saved in values.yaml. It contains configuration for all deployment and services.

@@ -840,7 +841,7 @@ type Value struct {
 ```

 <a name="NewValue"></a>
-### func [NewValue](<https://github.com/metal3d/katenary/blob/develop/generator/values.go#L56>)
+### func [NewValue](<https://github.com/metal3d/katenary/blob/develop/generator/values.go#L57>)

 ```go
 func NewValue(service types.ServiceConfig, main ...bool) *Value
@@ -851,7 +852,7 @@ NewValue creates a new Value from a compose service. The value contains the nece
 If \`main\` is true, the tag will be empty because it will be set in the helm chart appVersion.

 <a name="Value.AddIngress"></a>
-### func \(\*Value\) [AddIngress](<https://github.com/metal3d/katenary/blob/develop/generator/values.go#L89>)
+### func \(\*Value\) [AddIngress](<https://github.com/metal3d/katenary/blob/develop/generator/values.go#L90>)

 ```go
 func (v *Value) AddIngress(host, path string)
@@ -860,7 +861,7 @@ func (v *Value) AddIngress(host, path string)


 <a name="Value.AddPersistence"></a>
-### func \(\*Value\) [AddPersistence](<https://github.com/metal3d/katenary/blob/develop/generator/values.go#L99>)
+### func \(\*Value\) [AddPersistence](<https://github.com/metal3d/katenary/blob/develop/generator/values.go#L104>)

 ```go
 func (v *Value) AddPersistence(volumeName string)
--- a/doc/docs/packages/generator/extrafiles.md
+++ b/doc/docs/packages/generator/extrafiles.md
@@ -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://github.com/metal3d/katenary/blob/develop/generator/extrafiles/readme.go#L45>)
+## func [ReadMeFile](<https://github.com/metal3d/katenary/blob/develop/generator/extrafiles/readme.go#L46>)

 ```go
 func ReadMeFile(charname, description string, values map[string]any) string
--- a/doc/docs/packages/generator/katenaryfile.md
+++ b/doc/docs/packages/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://github.com/metal3d/katenary/blob/develop/generator/katenaryfile/main.go#L131>)
+## func [GenerateSchema](<https://github.com/metal3d/katenary/blob/develop/generator/katenaryfile/main.go#L137>)

 ```go
 func GenerateSchema() string
--- a/doc/docs/packages/generator/labels.md
+++ b/doc/docs/packages/generator/labels.md
@@ -15,7 +15,7 @@ const KatenaryLabelPrefix = "katenary.v3"
 ```

 <a name="GetLabelHelp"></a>
-## func [GetLabelHelp](<https://github.com/metal3d/katenary/blob/develop/generator/labels/katenaryLabels.go#L87>)
+## func [GetLabelHelp](<https://github.com/metal3d/katenary/blob/develop/generator/labels/katenaryLabels.go#L88>)

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

 <a name="GetLabelHelpFor"></a>
-## func [GetLabelHelpFor](<https://github.com/metal3d/katenary/blob/develop/generator/labels/katenaryLabels.go#L96>)
+## func [GetLabelHelpFor](<https://github.com/metal3d/katenary/blob/develop/generator/labels/katenaryLabels.go#L97>)

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

 <a name="GetLabelNames"></a>
-## func [GetLabelNames](<https://github.com/metal3d/katenary/blob/develop/generator/labels/katenaryLabels.go#L71>)
+## func [GetLabelNames](<https://github.com/metal3d/katenary/blob/develop/generator/labels/katenaryLabels.go#L72>)

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

 <a name="Prefix"></a>
-## func [Prefix](<https://github.com/metal3d/katenary/blob/develop/generator/labels/katenaryLabels.go#L224>)
+## func [Prefix](<https://github.com/metal3d/katenary/blob/develop/generator/labels/katenaryLabels.go#L235>)

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


 <a name="Help"></a>
-## type [Help](<https://github.com/metal3d/katenary/blob/develop/generator/labels/katenaryLabels.go#L63-L68>)
+## type [Help](<https://github.com/metal3d/katenary/blob/develop/generator/labels/katenaryLabels.go#L64-L69>)

 Help is the documentation of a label.

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

 <a name="Label"></a>
-## type [Label](<https://github.com/metal3d/katenary/blob/develop/generator/labels/katenaryLabels.go#L56>)
+## type [Label](<https://github.com/metal3d/katenary/blob/develop/generator/labels/katenaryLabels.go#L57>)

 Label is a katenary label to find in compose files.

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

 <a name="LabelName"></a>
-### func [LabelName](<https://github.com/metal3d/katenary/blob/develop/generator/labels/katenaryLabels.go#L58>)
+### func [LabelName](<https://github.com/metal3d/katenary/blob/develop/generator/labels/katenaryLabels.go#L59>)

 ```go
 func LabelName(name string) Label
--- a/doc/docs/packages/update.md
+++ b/doc/docs/packages/update.md
@@ -1,60 +0,0 @@
-<!-- Code generated by gomarkdoc. DO NOT EDIT -->
-
-# update
-
-```go
-import "katenary/update"
-```
-
-Update package is used to check if a new version of katenary is available.
-
-## Variables
-
-<a name="Version"></a>
-
-```go
-var (
-    Version = "master" // reset by cmd/main.go
-)
-```
-
-<a name="DownloadFile"></a>
-## func [DownloadFile](<https://github.com/metal3d/katenary/blob/develop/update/main.go#L134>)
-
-```go
-func DownloadFile(url, exe string) error
-```
-
-DownloadFile will download a url to a local file. It also ensure that the file is executable.
-
-<a name="DownloadLatestVersion"></a>
-## func [DownloadLatestVersion](<https://github.com/metal3d/katenary/blob/develop/update/main.go#L80>)
-
-```go
-func DownloadLatestVersion(assets []Asset) error
-```
-
-DownloadLatestVersion will download the latest version of katenary.
-
-<a name="Asset"></a>
-## type [Asset](<https://github.com/metal3d/katenary/blob/develop/update/main.go#L23-L26>)
-
-Asset is a github asset from release url.
-
-```go
-type Asset struct {
-    Name string `json:"name"`
-    URL  string `json:"browser_download_url"`
-}
-```
-
-<a name="CheckLatestVersion"></a>
-### func [CheckLatestVersion](<https://github.com/metal3d/katenary/blob/develop/update/main.go#L29>)
-
-```go
-func CheckLatestVersion() (string, []Asset, error)
-```
-
-CheckLatestVersion check katenary latest version from release and propose to download it
-
-Generated by [gomarkdoc](<https://github.com/princjef/gomarkdoc>)
--- a/doc/docs/packages/utils.md
+++ b/doc/docs/packages/utils.md
@@ -8,7 +8,7 @@ import "katenary/utils"

 Utils package 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#L191>)
+## func [AsResourceName](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L193>)

 ```go
 func AsResourceName(name string) string
@@ -35,7 +35,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#L173>)
+## func [EncodeBasicYaml](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L175>)

 ```go
 func EncodeBasicYaml(data any) ([]byte, error)
@@ -44,7 +44,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#L185>)
+## func [FixedResourceName](<https://github.com/metal3d/katenary/blob/develop/utils/utils.go#L187>)

 ```go
 func FixedResourceName(name string) string
@@ -146,7 +146,7 @@ GetContainerByName returns a container by name and its index in the array.
 ## func [Warn](<https://github.com/metal3d/katenary/blob/develop/utils/icons.go#L25>)

 ```go
-func Warn(msg ...interface{})
+func Warn(msg ...any)
 ```

 Warn prints a warning message
--- a/doc/mkdocs.yml
+++ b/doc/mkdocs.yml
@@ -54,7 +54,6 @@ nav:
  - Go Packages:
    - packages/cmd/katenary.md
    - packages/parser.md
-    - packages/update.md
    - packages/utils.md
    - Generator: 
      - Index: packages/generator.md