Katenary/katenary
2
0
Fork 3
Code Issues 13 Pull Requests 2 Actions Packages Projects 4 Releases 18 Wiki Activity

Update docs

Browse Source
This commit is contained in:
Patrice Ferlet
2026-05-03 21:21:38 +02:00
parent 99c8e12f40
commit b9e81c7e49
9 changed files with 329 additions and 169 deletions
Download Patch File Download Diff File Expand all files Collapse all files

312
doc/docs/packages/internal/generator.md
View File

@@ -35,7 +35,7 @@ var Version = "master" // changed at compile time
```
<a name="Convert"></a>
## func [Convert](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/converter.go#L100>)
## func Convert
```go
func Convert(config ConvertOptions, dockerComposeFile ...string) error
@@ -44,7 +44,7 @@ func Convert(config ConvertOptions, dockerComposeFile ...string) error
Convert a compose \(docker, podman...\) project to a helm chart. It calls Generate\(\) to generate the chart and then write it to the disk.
<a name="GetLabels"></a>
## func [GetLabels](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/labels.go#L13>)
## func GetLabels
```go
func GetLabels(serviceName, appName string) map[string]string
@@ -53,7 +53,7 @@ func GetLabels(serviceName, appName string) map[string]string
GetLabels returns the labels for a service. It uses the appName to replace the \_\_replace\_\_ in the labels. This is used to generate the labels in the templates.
<a name="GetMatchLabels"></a>
## func [GetMatchLabels](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/labels.go#L26>)
## func GetMatchLabels
```go
func GetMatchLabels(serviceName, appName string) map[string]string
@@ -62,7 +62,7 @@ func GetMatchLabels(serviceName, appName string) map[string]string
GetMatchLabels returns the matchLabels for a service. It uses the appName to replace the \_\_replace\_\_ in the labels. This is used to generate the matchLabels in the templates.
<a name="GetVersion"></a>
## func [GetVersion](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/version.go#L15>)
## func GetVersion
```go
func GetVersion() string
@@ -71,7 +71,7 @@ func GetVersion() string
GetVersion return the version of katneary. It's important to understand that the version is set at compile time for the github release. But, it the user get katneary using \`go install\`, the version should be different.
<a name="Helper"></a>
## func [Helper](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/helper.go#L16>)
## func Helper
```go
func Helper(name string) string
@@ -80,7 +80,7 @@ func Helper(name string) string
Helper returns the \_helpers.tpl file for a chart.
<a name="NewCronJob"></a>
## func [NewCronJob](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/cronJob.go#L29>)
## func NewCronJob
```go
func NewCronJob(service types.ServiceConfig, chart *HelmChart, appName string) (*CronJob, *RBAC)
@@ -89,7 +89,7 @@ func NewCronJob(service types.ServiceConfig, chart *HelmChart, appName string) (
NewCronJob creates a new CronJob from a compose service. The appName is the name of the application taken from the project name.
<a name="ToK8SYaml"></a>
## func [ToK8SYaml](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/utils.go#L91>)
## func ToK8SYaml
```go
func ToK8SYaml(obj any) ([]byte, error)
@@ -98,7 +98,7 @@ func ToK8SYaml(obj any) ([]byte, error)
<a name="UnWrapTPL"></a>
## func [UnWrapTPL](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/utils.go#L87>)
## func UnWrapTPL
```go
func UnWrapTPL(in []byte) []byte
@@ -107,7 +107,7 @@ func UnWrapTPL(in []byte) []byte
UnWrapTPL removes the line wrapping from a template.
<a name="ChartTemplate"></a>
## type [ChartTemplate](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/chart.go#L22-L25>)
## type ChartTemplate
ChartTemplate is a template of a chart. It contains the content of the template and the name of the service. This is used internally to generate the templates.
@@ -119,7 +119,7 @@ type ChartTemplate struct {
```
<a name="ConfigMap"></a>
## type [ConfigMap](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/configMap.go#L38-L43>)
## type ConfigMap
ConfigMap is a kubernetes ConfigMap. Implements the DataMap interface.
@@ -131,7 +131,7 @@ type ConfigMap struct {
```
<a name="NewConfigMap"></a>
### func [NewConfigMap](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/configMap.go#L47>)
### func NewConfigMap
```go
func NewConfigMap(service types.ServiceConfig, appName string, forFile bool) *ConfigMap
@@ -140,7 +140,7 @@ func NewConfigMap(service types.ServiceConfig, appName string, forFile bool) *Co
NewConfigMap creates a new ConfigMap from a compose service. The appName is the name of the application taken from the project name. The ConfigMap is filled by environment variables and labels "map\-env".
<a name="NewConfigMapFromDirectory"></a>
### func [NewConfigMapFromDirectory](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/configMap.go#L120>)
### func NewConfigMapFromDirectory
```go
func NewConfigMapFromDirectory(service types.ServiceConfig, appName, path string) *ConfigMap
@@ -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://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/configMap.go#L158>)
### func \(\*ConfigMap\) AddBinaryData
```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://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/configMap.go#L153>)
### func \(\*ConfigMap\) AddData
```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://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/configMap.go#L167>)
### func \(\*ConfigMap\) AppendDir
```go
func (c *ConfigMap) AppendDir(path string) error
@@ -176,7 +176,7 @@ func (c *ConfigMap) AppendDir(path string) error
AppendDir 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://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/configMap.go#L214>)
### func \(\*ConfigMap\) AppendFile
```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://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/configMap.go#L238>)
### func \(\*ConfigMap\) Filename
```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://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/configMap.go#L248>)
### func \(\*ConfigMap\) SetData
```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://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/configMap.go#L253>)
### func \(\*ConfigMap\) Yaml
```go
func (c *ConfigMap) Yaml() ([]byte, error)
@@ -212,7 +212,7 @@ func (c *ConfigMap) Yaml() ([]byte, error)
Yaml returns the yaml representation of the configmap
<a name="ConfigMapMount"></a>
## type [ConfigMapMount](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/deployment.go#L31-L34>)
## type ConfigMapMount
@@ -223,7 +223,7 @@ type ConfigMapMount struct {
```
<a name="ConvertOptions"></a>
## type [ConvertOptions](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/chart.go#L28-L37>)
## type ConvertOptions
ConvertOptions are the options to convert a compose project to a helm chart.
@@ -241,7 +241,7 @@ type ConvertOptions struct {
```
<a name="CronJob"></a>
## type [CronJob](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/cronJob.go#L23-L26>)
## type CronJob
CronJob is a kubernetes CronJob.
@@ -253,7 +253,7 @@ type CronJob struct {
```
<a name="CronJob.Filename"></a>
### func \(\*CronJob\) [Filename](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/cronJob.go#L113>)
### func \(\*CronJob\) Filename
```go
func (c *CronJob) Filename() string
@@ -264,7 +264,7 @@ Filename returns the filename of the cronjob.
Implements the Yaml interface.
<a name="CronJob.Yaml"></a>
### func \(\*CronJob\) [Yaml](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/cronJob.go#L120>)
### func \(\*CronJob\) Yaml
```go
func (c *CronJob) 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://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/values.go#L118-L123>)
## type CronJobValue
CronJobValue is a cronjob configuration that will be saved in values.yaml.
@@ -289,7 +289,7 @@ type CronJobValue struct {
```
<a name="DataMap"></a>
## type [DataMap](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/types.go#L4-L7>)
## type DataMap
DataMap is a kubernetes ConfigMap or Secret. It can be used to add data to the ConfigMap or Secret.
@@ -301,7 +301,7 @@ type DataMap interface {
```
<a name="Deployment"></a>
## type [Deployment](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/deployment.go#L37-L48>)
## type Deployment
Deployment is a kubernetes Deployment.
@@ -313,7 +313,7 @@ type Deployment struct {
```
<a name="NewDeployment"></a>
### func [NewDeployment](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/deployment.go#L52>)
### func NewDeployment
```go
func NewDeployment(service types.ServiceConfig, chart *HelmChart) *Deployment
@@ -322,7 +322,7 @@ func NewDeployment(service types.ServiceConfig, chart *HelmChart) *Deployment
NewDeployment creates a new Deployment from a compose service. The appName is the name of the application taken from the project name. It also creates the Values map that will be used to create the values.yaml file.
<a name="Deployment.AddContainer"></a>
### func \(\*Deployment\) [AddContainer](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/deployment.go#L119>)
### func \(\*Deployment\) AddContainer
```go
func (d *Deployment) AddContainer(service types.ServiceConfig)
@@ -331,7 +331,7 @@ func (d *Deployment) AddContainer(service types.ServiceConfig)
AddContainer adds a container to the deployment.
<a name="Deployment.AddHealthCheck"></a>
### func \(\*Deployment\) [AddHealthCheck](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/deployment.go#L166>)
### func \(\*Deployment\) AddHealthCheck
```go
func (d *Deployment) AddHealthCheck(service types.ServiceConfig, container *corev1.Container)
@@ -340,7 +340,7 @@ func (d *Deployment) AddHealthCheck(service types.ServiceConfig, container *core
<a name="Deployment.AddIngress"></a>
### func \(\*Deployment\) [AddIngress](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/deployment.go#L195>)
### func \(\*Deployment\) AddIngress
```go
func (d *Deployment) AddIngress(service types.ServiceConfig, appName string) *Ingress
@@ -348,8 +348,17 @@ func (d *Deployment) AddIngress(service types.ServiceConfig, appName string) *In
AddIngress adds an ingress to the deployment. It creates the ingress object.
<a name="Deployment.AddIngressRoute"></a>
### func \(\*Deployment\) AddIngressRoute
```go
func (d *Deployment) AddIngressRoute(service types.ServiceConfig, appName string) Yaml
```
AddIngressRoute adds an IngressRoute to the deployment if type is "ingressroute".
<a name="Deployment.AddLegacyVolume"></a>
### func \(\*Deployment\) [AddLegacyVolume](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/deployment.go#L218>)
### func \(\*Deployment\) AddLegacyVolume
```go
func (d *Deployment) AddLegacyVolume(name, kind string)
@@ -358,7 +367,7 @@ func (d *Deployment) AddLegacyVolume(name, kind string)
<a name="Deployment.AddVolumes"></a>
### func \(\*Deployment\) [AddVolumes](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/deployment.go#L201>)
### func \(\*Deployment\) AddVolumes
```go
func (d *Deployment) AddVolumes(service types.ServiceConfig, appName string)
@@ -367,7 +376,7 @@ func (d *Deployment) AddVolumes(service types.ServiceConfig, appName string)
AddVolumes adds a volume to the deployment. It does not create the PVC, it only adds the volumes to the deployment. If the volume is a bind volume it will warn the user that it is not supported yet.
<a name="Deployment.BindFrom"></a>
### func \(\*Deployment\) [BindFrom](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/deployment.go#L239>)
### func \(\*Deployment\) BindFrom
```go
func (d *Deployment) BindFrom(service types.ServiceConfig, binded *Deployment)
@@ -376,7 +385,7 @@ func (d *Deployment) BindFrom(service types.ServiceConfig, binded *Deployment)
<a name="Deployment.BindMapFilesToContainer"></a>
### func \(\*Deployment\) [BindMapFilesToContainer](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/deployment.go#L419>)
### func \(\*Deployment\) BindMapFilesToContainer
```go
func (d *Deployment) BindMapFilesToContainer(service types.ServiceConfig, secrets []string, appName string) (*corev1.Container, int)
@@ -385,7 +394,7 @@ func (d *Deployment) BindMapFilesToContainer(service types.ServiceConfig, secret
<a name="Deployment.DependsOn"></a>
### func \(\*Deployment\) [DependsOn](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/deployment.go#L267>)
### func \(\*Deployment\) DependsOn
```go
func (d *Deployment) DependsOn(to *Deployment, servicename string) error
@@ -394,7 +403,7 @@ func (d *Deployment) DependsOn(to *Deployment, servicename string) error
DependsOn adds a initContainer to the deployment that will wait for the service to be up.
<a name="Deployment.Filename"></a>
### func \(\*Deployment\) [Filename](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/deployment.go#L344>)
### func \(\*Deployment\) Filename
```go
func (d *Deployment) Filename() string
@@ -403,7 +412,7 @@ func (d *Deployment) Filename() string
Filename returns the filename of the deployment.
<a name="Deployment.MountExchangeVolumes"></a>
### func \(\*Deployment\) [MountExchangeVolumes](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/deployment.go#L470>)
### func \(\*Deployment\) MountExchangeVolumes
```go
func (d *Deployment) MountExchangeVolumes()
@@ -412,7 +421,7 @@ func (d *Deployment) MountExchangeVolumes()
<a name="Deployment.SetEnvFrom"></a>
### func \(\*Deployment\) [SetEnvFrom](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/deployment.go#L349>)
### func \(\*Deployment\) SetEnvFrom
```go
func (d *Deployment) SetEnvFrom(service types.ServiceConfig, appName string, samePod ...bool)
@@ -421,7 +430,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.SetServiceAccountName"></a>
### func \(\*Deployment\) [SetServiceAccountName](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/deployment.go#L654>)
### func \(\*Deployment\) SetServiceAccountName
```go
func (d *Deployment) SetServiceAccountName()
@@ -430,7 +439,7 @@ func (d *Deployment) SetServiceAccountName()
<a name="Deployment.Yaml"></a>
### func \(\*Deployment\) [Yaml](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/deployment.go#L494>)
### func \(\*Deployment\) Yaml
```go
func (d *Deployment) Yaml() ([]byte, error)
@@ -439,7 +448,7 @@ func (d *Deployment) Yaml() ([]byte, error)
Yaml returns the yaml representation of the deployment.
<a name="FileMapUsage"></a>
## type [FileMapUsage](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/configMap.go#L22>)
## type FileMapUsage
FileMapUsage is the usage of the filemap.
@@ -457,7 +466,7 @@ const (
```
<a name="HelmChart"></a>
## type [HelmChart](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/chart.go#L41-L54>)
## type HelmChart
HelmChart is a Helm Chart representation. It contains all the templates, values, versions, helpers...
@@ -480,7 +489,7 @@ type HelmChart struct {
```
<a name="Generate"></a>
### func [Generate](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/generator.go#L32>)
### func Generate
```go
func Generate(project *types.Project) (*HelmChart, error)
@@ -500,7 +509,7 @@ The Generate function will create the HelmChart object this way:
- Merge the same\-pod services.
<a name="NewChart"></a>
### func [NewChart](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/chart.go#L57>)
### func NewChart
```go
func NewChart(name string) *HelmChart
@@ -509,7 +518,7 @@ func NewChart(name string) *HelmChart
NewChart creates a new empty chart with the given name.
<a name="HelmChart.SaveTemplates"></a>
### func \(\*HelmChart\) [SaveTemplates](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/chart.go#L72>)
### func \(\*HelmChart\) SaveTemplates
```go
func (chart *HelmChart) SaveTemplates(templateDir string)
@@ -518,7 +527,7 @@ func (chart *HelmChart) SaveTemplates(templateDir string)
SaveTemplates the templates of the chart to the given directory.
<a name="Ingress"></a>
## type [Ingress](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/ingress.go#L18-L22>)
## type Ingress
@@ -530,16 +539,16 @@ type Ingress struct {
```
<a name="NewIngress"></a>
### func [NewIngress](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/ingress.go#L25>)
### func NewIngress
```go
func NewIngress(service types.ServiceConfig, Chart *HelmChart) *Ingress
```
NewIngress creates a new Ingress from a compose service.
NewIngress creates a new standard Kubernetes Ingress from a compose service.
<a name="Ingress.Filename"></a>
### func \(\*Ingress\) [Filename](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/ingress.go#L129>)
### func \(\*Ingress\) Filename
```go
func (ingress *Ingress) Filename() string
@@ -548,7 +557,7 @@ func (ingress *Ingress) Filename() string
<a name="Ingress.Yaml"></a>
### func \(\*Ingress\) [Yaml](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/ingress.go#L133>)
### func \(\*Ingress\) Yaml
```go
func (ingress *Ingress) Yaml() ([]byte, error)
@@ -556,24 +565,128 @@ func (ingress *Ingress) Yaml() ([]byte, error)
<a name="IngressRoute"></a>
## type IngressRoute
IngressRoute represents a Traefik IngressRoute CRD
```go
type IngressRoute struct {
metav1.TypeMeta `yaml:",inline"`
metav1.ObjectMeta `yaml:"metadata"`
Spec IngressRouteSpec `yaml:"spec"`
// contains filtered or unexported fields
}
```
<a name="NewIngressRoute"></a>
### func NewIngressRoute
```go
func NewIngressRoute(service types.ServiceConfig, Chart *HelmChart, mapping *labelstructs.Ingress, serviceName, appName string) *IngressRoute
```
NewIngressRoute creates a new Traefik IngressRoute from a compose service.
<a name="IngressRoute.Filename"></a>
### func \(\*IngressRoute\) Filename
```go
func (ir *IngressRoute) Filename() string
```
<a name="IngressRoute.Yaml"></a>
### func \(\*IngressRoute\) Yaml
```go
func (ir *IngressRoute) Yaml() ([]byte, error)
```
<a name="IngressRouteRoute"></a>
## type IngressRouteRoute
IngressRouteRoute defines a route in the IngressRoute
```go
type IngressRouteRoute struct {
Match string `json:"match" yaml:"match"`
Kind string `json:"kind" yaml:"kind"`
Services []IngressRouteService `json:"services" yaml:"services"`
}
```
<a name="IngressRouteService"></a>
## type IngressRouteService
IngressRouteService defines a service backend in IngressRoute
```go
type IngressRouteService struct {
Name string `json:"name" yaml:"name"`
Port int `json:"port" yaml:"port"`
}
```
<a name="IngressRouteSpec"></a>
## type IngressRouteSpec
IngressRouteSpec defines the spec for Traefik IngressRoute
```go
type IngressRouteSpec struct {
EntryPoints []string `json:"entryPoints,omitempty" yaml:"entryPoints,omitempty"`
Routes []IngressRouteRoute `json:"routes" yaml:"routes"`
TLS *IngressRouteTLS `json:"tls,omitempty" yaml:"tls,omitempty"`
}
```
<a name="IngressRouteTLS"></a>
## type IngressRouteTLS
IngressRouteTLS defines TLS configuration for IngressRoute
```go
type IngressRouteTLS struct {
SecretName string `json:"secretName,omitempty" yaml:"secretName,omitempty"`
Domains []IngressRouteTLSDomain `json:"domains,omitempty" yaml:"domains,omitempty"`
}
```
<a name="IngressRouteTLSDomain"></a>
## type IngressRouteTLSDomain
IngressRouteTLSDomain defines a domain for TLS
```go
type IngressRouteTLSDomain struct {
Main string `json:"main" yaml:"main"`
}
```
<a name="IngressValue"></a>
## type [IngressValue](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/values.go#L29-L36>)
## type IngressValue
IngressValue is a ingress configuration that will be saved in values.yaml.
```go
type IngressValue struct {
Annotations map[string]string `yaml:"annotations"`
Host string `yaml:"host"`
Path string `yaml:"path"`
Class string `yaml:"class"`
Enabled bool `yaml:"enabled"`
TLS TLS `yaml:"tls"`
Annotations map[string]string `yaml:"annotations"`
Host string `yaml:"host"`
Path string `yaml:"path"`
Class string `yaml:"class"`
Type string `yaml:"type"`
Enabled bool `yaml:"enabled"`
IngressRouteEnabled bool `yaml:"ingressRouteEnabled"`
TLS TLS `yaml:"tls"`
}
```
<a name="PersistenceValue"></a>
## type [PersistenceValue](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/values.go#L16-L21>)
## type PersistenceValue
PersistenceValue is a persistence configuration that will be saved in values.yaml.
@@ -587,7 +700,7 @@ type PersistenceValue struct {
```
<a name="RBAC"></a>
## type [RBAC](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/rbac.go#L20-L24>)
## type RBAC
RBAC is a kubernetes RBAC containing a role, a rolebinding and an associated serviceaccount.
@@ -600,7 +713,7 @@ type RBAC struct {
```
<a name="NewRBAC"></a>
### func [NewRBAC](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/rbac.go#L27>)
### func NewRBAC
```go
func NewRBAC(service types.ServiceConfig, appName string) *RBAC
@@ -609,7 +722,7 @@ func NewRBAC(service types.ServiceConfig, appName string) *RBAC
NewRBAC creates a new RBAC from a compose service. The appName is the name of the application taken from the project name.
<a name="RepositoryValue"></a>
## type [RepositoryValue](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/values.go#L10-L13>)
## type RepositoryValue
RepositoryValue is a docker repository image and tag that will be saved in values.yaml.
@@ -621,7 +734,7 @@ type RepositoryValue struct {
```
<a name="Role"></a>
## type [Role](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/rbac.go#L114-L117>)
## type Role
Role is a kubernetes Role.
@@ -633,7 +746,7 @@ type Role struct {
```
<a name="NewRestrictedRole"></a>
### func [NewRestrictedRole](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/rbac.go#L150>)
### func NewRestrictedRole
```go
func NewRestrictedRole(service types.ServiceConfig, appName string) *Role
@@ -642,7 +755,7 @@ func NewRestrictedRole(service types.ServiceConfig, appName string) *Role
NewRestrictedRole creates a Role with minimal permissions for init containers.
<a name="Role.Filename"></a>
### func \(\*Role\) [Filename](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/rbac.go#L119>)
### func \(\*Role\) Filename
```go
func (r *Role) Filename() string
@@ -651,7 +764,7 @@ func (r *Role) Filename() string
<a name="Role.Yaml"></a>
### func \(\*Role\) [Yaml](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/rbac.go#L123>)
### func \(\*Role\) Yaml
```go
func (r *Role) Yaml() ([]byte, error)
@@ -660,7 +773,7 @@ func (r *Role) Yaml() ([]byte, error)
<a name="RoleBinding"></a>
## type [RoleBinding](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/rbac.go#L100-L103>)
## type RoleBinding
RoleBinding is a kubernetes RoleBinding.
@@ -672,7 +785,7 @@ type RoleBinding struct {
```
<a name="NewRestrictedRoleBinding"></a>
### func [NewRestrictedRoleBinding](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/rbac.go#L175>)
### func NewRestrictedRoleBinding
```go
func NewRestrictedRoleBinding(service types.ServiceConfig, appName string) *RoleBinding
@@ -681,7 +794,7 @@ func NewRestrictedRoleBinding(service types.ServiceConfig, appName string) *Role
NewRestrictedRoleBinding creates a RoleBinding that binds the restricted role to the ServiceAccount.
<a name="RoleBinding.Filename"></a>
### func \(\*RoleBinding\) [Filename](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/rbac.go#L105>)
### func \(\*RoleBinding\) Filename
```go
func (r *RoleBinding) Filename() string
@@ -690,7 +803,7 @@ func (r *RoleBinding) Filename() string
<a name="RoleBinding.Yaml"></a>
### func \(\*RoleBinding\) [Yaml](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/rbac.go#L109>)
### func \(\*RoleBinding\) Yaml
```go
func (r *RoleBinding) Yaml() ([]byte, error)
@@ -699,7 +812,7 @@ func (r *RoleBinding) Yaml() ([]byte, error)
<a name="Secret"></a>
## type [Secret](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/secret.go#L23-L26>)
## type Secret
Secret is a kubernetes Secret.
@@ -713,7 +826,7 @@ type Secret struct {
```
<a name="NewSecret"></a>
### func [NewSecret](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/secret.go#L29>)
### func NewSecret
```go
func NewSecret(service types.ServiceConfig, appName string) *Secret
@@ -722,7 +835,7 @@ func NewSecret(service types.ServiceConfig, appName string) *Secret
NewSecret creates a new Secret from a compose service
<a name="Secret.AddData"></a>
### func \(\*Secret\) [AddData](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/secret.go#L71>)
### func \(\*Secret\) AddData
```go
func (s *Secret) AddData(key, value string)
@@ -731,7 +844,7 @@ func (s *Secret) AddData(key, value string)
AddData adds a key value pair to the secret.
<a name="Secret.Filename"></a>
### func \(\*Secret\) [Filename](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/secret.go#L87>)
### func \(\*Secret\) Filename
```go
func (s *Secret) Filename() string
@@ -740,7 +853,7 @@ func (s *Secret) Filename() string
Filename returns the filename of the secret.
<a name="Secret.SetData"></a>
### func \(\*Secret\) [SetData](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/secret.go#L92>)
### func \(\*Secret\) SetData
```go
func (s *Secret) SetData(data map[string]string)
@@ -749,7 +862,7 @@ func (s *Secret) SetData(data map[string]string)
SetData sets the data of the secret.
<a name="Secret.Yaml"></a>
### func \(\*Secret\) [Yaml](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/secret.go#L99>)
### func \(\*Secret\) Yaml
```go
func (s *Secret) Yaml() ([]byte, error)
@@ -758,7 +871,7 @@ func (s *Secret) Yaml() ([]byte, error)
Yaml returns the yaml representation of the secret.
<a name="Service"></a>
## type [Service](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/service.go#L19-L22>)
## type Service
Service is a kubernetes Service.
@@ -770,7 +883,7 @@ type Service struct {
```
<a name="NewService"></a>
### func [NewService](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/service.go#L25>)
### func NewService
```go
func NewService(service types.ServiceConfig, appName string) *Service
@@ -779,7 +892,7 @@ func NewService(service types.ServiceConfig, appName string) *Service
NewService creates a new Service from a compose service.
<a name="Service.AddPort"></a>
### func \(\*Service\) [AddPort](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/service.go#L54>)
### func \(\*Service\) AddPort
```go
func (s *Service) AddPort(port types.ServicePortConfig, serviceName ...string)
@@ -788,7 +901,7 @@ func (s *Service) AddPort(port types.ServicePortConfig, serviceName ...string)
AddPort adds a port to the service.
<a name="Service.Filename"></a>
### func \(\*Service\) [Filename](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/service.go#L75>)
### func \(\*Service\) Filename
```go
func (s *Service) Filename() string
@@ -797,7 +910,7 @@ func (s *Service) Filename() string
Filename returns the filename of the service.
<a name="Service.Yaml"></a>
### func \(\*Service\) [Yaml](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/service.go#L80>)
### func \(\*Service\) Yaml
```go
func (s *Service) Yaml() ([]byte, error)
@@ -806,7 +919,7 @@ func (s *Service) Yaml() ([]byte, error)
Yaml returns the yaml representation of the service.
<a name="ServiceAccount"></a>
## type [ServiceAccount](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/rbac.go#L205-L208>)
## type ServiceAccount
ServiceAccount is a kubernetes ServiceAccount.
@@ -818,7 +931,7 @@ type ServiceAccount struct {
```
<a name="NewServiceAccount"></a>
### func [NewServiceAccount](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/rbac.go#L132>)
### func NewServiceAccount
```go
func NewServiceAccount(service types.ServiceConfig, appName string) *ServiceAccount
@@ -827,7 +940,7 @@ func NewServiceAccount(service types.ServiceConfig, appName string) *ServiceAcco
NewServiceAccount creates a new ServiceAccount from a compose service.
<a name="ServiceAccount.Filename"></a>
### func \(\*ServiceAccount\) [Filename](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/rbac.go#L210>)
### func \(\*ServiceAccount\) Filename
```go
func (r *ServiceAccount) Filename() string
@@ -836,7 +949,7 @@ func (r *ServiceAccount) Filename() string
<a name="ServiceAccount.Yaml"></a>
### func \(\*ServiceAccount\) [Yaml](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/rbac.go#L214>)
### func \(\*ServiceAccount\) Yaml
```go
func (r *ServiceAccount) Yaml() ([]byte, error)
@@ -845,7 +958,7 @@ func (r *ServiceAccount) Yaml() ([]byte, error)
<a name="TLS"></a>
## type [TLS](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/values.go#L23-L26>)
## type TLS
@@ -857,7 +970,7 @@ type TLS struct {
```
<a name="Value"></a>
## type [Value](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/values.go#L39-L50>)
## type Value
Value will be saved in values.yaml. It contains configuration for all deployment and services.
@@ -877,7 +990,7 @@ type Value struct {
```
<a name="NewValue"></a>
### func [NewValue](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/values.go#L57>)
### func NewValue
```go
func NewValue(service types.ServiceConfig, main ...bool) *Value
@@ -888,7 +1001,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://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/values.go#L90>)
### func \(\*Value\) AddIngress
```go
func (v *Value) AddIngress(host, path string)
@@ -897,7 +1010,7 @@ func (v *Value) AddIngress(host, path string)
<a name="Value.AddPersistence"></a>
### func \(\*Value\) [AddPersistence](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/values.go#L104>)
### func \(\*Value\) AddPersistence
```go
func (v *Value) AddPersistence(volumeName string)
@@ -906,7 +1019,7 @@ func (v *Value) AddPersistence(volumeName string)
AddPersistence adds persistence configuration to the Value.
<a name="VolumeClaim"></a>
## type [VolumeClaim](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/volume.go#L19-L24>)
## type VolumeClaim
VolumeClaim is a kubernetes VolumeClaim. This is a PersistentVolumeClaim.
@@ -918,7 +1031,7 @@ type VolumeClaim struct {
```
<a name="NewVolumeClaim"></a>
### func [NewVolumeClaim](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/volume.go#L27>)
### func NewVolumeClaim
```go
func NewVolumeClaim(service types.ServiceConfig, volumeName, appName string) *VolumeClaim
@@ -927,7 +1040,7 @@ func NewVolumeClaim(service types.ServiceConfig, volumeName, appName string) *Vo
NewVolumeClaim creates a new VolumeClaim from a compose service.
<a name="VolumeClaim.Filename"></a>
### func \(\*VolumeClaim\) [Filename](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/volume.go#L63>)
### func \(\*VolumeClaim\) Filename
```go
func (v *VolumeClaim) Filename() string
@@ -936,7 +1049,7 @@ func (v *VolumeClaim) Filename() string
Filename returns the suggested filename for a VolumeClaim.
<a name="VolumeClaim.Yaml"></a>
### func \(\*VolumeClaim\) [Yaml](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/volume.go#L68>)
### func \(\*VolumeClaim\) Yaml
```go
func (v *VolumeClaim) Yaml() ([]byte, error)
@@ -945,7 +1058,7 @@ func (v *VolumeClaim) Yaml() ([]byte, error)
Yaml marshals a VolumeClaim into yaml.
<a name="Yaml"></a>
## type [Yaml](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/types.go#L10-L13>)
## type Yaml
Yaml is a kubernetes object that can be converted to yaml.
@@ -956,4 +1069,13 @@ type Yaml interface {
}
```
<a name="NewIngressRouteFromService"></a>
### func NewIngressRouteFromService
```go
func NewIngressRouteFromService(service types.ServiceConfig, Chart *HelmChart) Yaml
```
NewIngressRouteFromService creates a Traefik IngressRoute from the same service config. This is called separately to generate the IngressRoute file in addition to Ingress.
Generated by [gomarkdoc](<https://github.com/princjef/gomarkdoc>)