katenary/doc/docs/packages/internal/generator.md

<!-- Code generated by gomarkdoc. DO NOT EDIT -->

# generator

```go
import "katenary.io/internal/generator"
```

Package generator generates kubernetes objects from a "compose" file and transforms them into a helm chart.

The generator package is the core of katenary. It is responsible for generating kubernetes objects from a compose file and transforming them into a helm chart. Conversion manipulates Yaml representation of kubernetes object to add conditions, labels, annotations, etc. to the objects. It also create the values to be set to the values.yaml file.

The generate.Convert\(\) create an HelmChart object and call "Generate\(\)" method to convert from a compose file to a helm chart. It saves the helm chart in the given directory.

If you want to change or override the write behavior, you can use the HelmChart.Generate\(\) function and implement your own write function. This function returns the helm chart object containing all kubernetes objects and helm chart ingormation. It does not write the helm chart to the disk.

## Variables

<a name="Annotations"></a>

```go
var (

    // Standard annotationss
    Annotations = map[string]string{
        labels.LabelName("version"): Version,
    }
)
```

<a name="Version"></a>Version is the version of katenary. It is set at compile time.

```go
var Version = "master" // changed at compile time
```

<a name="Convert"></a>
## func [Convert](<https://repo.katenary.io/Katenary/katenary/blob/master/internal/generator/converter.go#L100>)

```go
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/master/internal/generator/labels.go#L13>)

```go
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/master/internal/generator/labels.go#L26>)

```go
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/master/internal/generator/version.go#L14>)

```go
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/master/internal/generator/helper.go#L16>)

```go
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/master/internal/generator/cronJob.go#L29>)

```go
func NewCronJob(service types.ServiceConfig, chart *HelmChart, appName string) (*CronJob, *RBAC)
```

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/master/internal/generator/utils.go#L91>)

```go
func ToK8SYaml(obj any) ([]byte, error)
```



<a name="UnWrapTPL"></a>
## func [UnWrapTPL](<https://repo.katenary.io/Katenary/katenary/blob/master/internal/generator/utils.go#L87>)

```go
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/master/internal/generator/chart.go#L22-L25>)

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.

```go
type ChartTemplate struct {
    Servicename string
    Content     []byte
}
```

<a name="ConfigMap"></a>
## type [ConfigMap](<https://repo.katenary.io/Katenary/katenary/blob/master/internal/generator/configMap.go#L38-L43>)

ConfigMap is a kubernetes ConfigMap. Implements the DataMap interface.

```go
type ConfigMap struct {
    *corev1.ConfigMap
    // contains filtered or unexported fields
}
```

<a name="NewConfigMap"></a>
### func [NewConfigMap](<https://repo.katenary.io/Katenary/katenary/blob/master/internal/generator/configMap.go#L47>)

```go
func NewConfigMap(service types.ServiceConfig, appName string, forFile bool) *ConfigMap
```

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/master/internal/generator/configMap.go#L120>)

```go
func NewConfigMapFromDirectory(service types.ServiceConfig, appName, path string) *ConfigMap
```

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/master/internal/generator/configMap.go#L158>)

```go
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/master/internal/generator/configMap.go#L153>)

```go
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/master/internal/generator/configMap.go#L167>)

```go
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/master/internal/generator/configMap.go#L214>)

```go
func (c *ConfigMap) AppendFile(path string) error
```



<a name="ConfigMap.Filename"></a>
### func \(\*ConfigMap\) [Filename](<https://repo.katenary.io/Katenary/katenary/blob/master/internal/generator/configMap.go#L238>)

```go
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/master/internal/generator/configMap.go#L248>)

```go
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/master/internal/generator/configMap.go#L253>)

```go
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/master/internal/generator/deployment.go#L29-L32>)



```go
type ConfigMapMount struct {
    // contains filtered or unexported fields
}
```

<a name="ConvertOptions"></a>
## type [ConvertOptions](<https://repo.katenary.io/Katenary/katenary/blob/master/internal/generator/chart.go#L28-L37>)

ConvertOptions are the options to convert a compose project to a helm chart.

```go
type ConvertOptions struct {
    AppVersion   *string
    OutputDir    string
    ChartVersion string
    Icon         string
    Profiles     []string
    EnvFiles     []string
    Force        bool
    HelmUpdate   bool
}
```

<a name="CronJob"></a>
## type [CronJob](<https://repo.katenary.io/Katenary/katenary/blob/master/internal/generator/cronJob.go#L23-L26>)

CronJob is a kubernetes CronJob.

```go
type CronJob struct {
    *batchv1.CronJob
    // contains filtered or unexported fields
}
```

<a name="CronJob.Filename"></a>
### func \(\*CronJob\) [Filename](<https://repo.katenary.io/Katenary/katenary/blob/master/internal/generator/cronJob.go#L113>)

```go
func (c *CronJob) Filename() string
```

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/master/internal/generator/cronJob.go#L120>)

```go
func (c *CronJob) Yaml() ([]byte, error)
```

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/master/internal/generator/values.go#L118-L123>)

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

```go
type CronJobValue struct {
    Repository      *RepositoryValue `yaml:"repository,omitempty"`
    Environment     map[string]any   `yaml:"environment,omitempty"`
    ImagePullPolicy string           `yaml:"imagePullPolicy,omitempty"`
    Schedule        string           `yaml:"schedule"`
}
```

<a name="DataMap"></a>
## type [DataMap](<https://repo.katenary.io/Katenary/katenary/blob/master/internal/generator/types.go#L4-L7>)

DataMap is a kubernetes ConfigMap or Secret. It can be used to add data to the ConfigMap or Secret.

```go
type DataMap interface {
    SetData(map[string]string)
    AddData(string, string)
}
```

<a name="Deployment"></a>
## type [Deployment](<https://repo.katenary.io/Katenary/katenary/blob/master/internal/generator/deployment.go#L35-L45>)

Deployment is a kubernetes Deployment.

```go
type Deployment struct {
    *appsv1.Deployment `yaml:",inline"`
    // contains filtered or unexported fields
}
```

<a name="NewDeployment"></a>
### func [NewDeployment](<https://repo.katenary.io/Katenary/katenary/blob/master/internal/generator/deployment.go#L49>)

```go
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/master/internal/generator/deployment.go#L116>)

```go
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/master/internal/generator/deployment.go#L163>)

```go
func (d *Deployment) AddHealthCheck(service types.ServiceConfig, container *corev1.Container)
```



<a name="Deployment.AddIngress"></a>
### func \(\*Deployment\) [AddIngress](<https://repo.katenary.io/Katenary/katenary/blob/master/internal/generator/deployment.go#L192>)

```go
func (d *Deployment) AddIngress(service types.ServiceConfig, appName string) *Ingress
```

AddIngress adds an ingress to the deployment. It creates the ingress object.

<a name="Deployment.AddLegacyVolume"></a>
### func \(\*Deployment\) [AddLegacyVolume](<https://repo.katenary.io/Katenary/katenary/blob/master/internal/generator/deployment.go#L222>)

```go
func (d *Deployment) AddLegacyVolume(name, kind string)
```



<a name="Deployment.AddVolumes"></a>
### func \(\*Deployment\) [AddVolumes](<https://repo.katenary.io/Katenary/katenary/blob/master/internal/generator/deployment.go#L198>)

```go
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/master/internal/generator/deployment.go#L243>)

```go
func (d *Deployment) BindFrom(service types.ServiceConfig, binded *Deployment)
```



<a name="Deployment.BindMapFilesToContainer"></a>
### func \(\*Deployment\) [BindMapFilesToContainer](<https://repo.katenary.io/Katenary/katenary/blob/master/internal/generator/deployment.go#L377>)

```go
func (d *Deployment) BindMapFilesToContainer(service types.ServiceConfig, secrets []string, appName string) (*corev1.Container, int)
```



<a name="Deployment.DependsOn"></a>
### func \(\*Deployment\) [DependsOn](<https://repo.katenary.io/Katenary/katenary/blob/master/internal/generator/deployment.go#L271>)

```go
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/master/internal/generator/deployment.go#L302>)

```go
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/master/internal/generator/deployment.go#L428>)

```go
func (d *Deployment) MountExchangeVolumes()
```



<a name="Deployment.SetEnvFrom"></a>
### func \(\*Deployment\) [SetEnvFrom](<https://repo.katenary.io/Katenary/katenary/blob/master/internal/generator/deployment.go#L307>)

```go
func (d *Deployment) SetEnvFrom(service types.ServiceConfig, appName string, samePod ...bool)
```

SetEnvFrom sets the environment variables to a configmap. The configmap is created.

<a name="Deployment.Yaml"></a>
### func \(\*Deployment\) [Yaml](<https://repo.katenary.io/Katenary/katenary/blob/master/internal/generator/deployment.go#L452>)

```go
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/master/internal/generator/configMap.go#L22>)

FileMapUsage is the usage of the filemap.

```go
type FileMapUsage uint8
```

<a name="FileMapUsageConfigMap"></a>FileMapUsage constants.

```go
const (
    FileMapUsageConfigMap FileMapUsage = iota // pure configmap for key:values.
    FileMapUsageFiles                         // files in a configmap.
)
```

<a name="HelmChart"></a>
## type [HelmChart](<https://repo.katenary.io/Katenary/katenary/blob/master/internal/generator/chart.go#L41-L54>)

HelmChart is a Helm Chart representation. It contains all the templates, values, versions, helpers...

```go
type HelmChart struct {
    Templates    map[string]*ChartTemplate `yaml:"-"`
    Values       map[string]any            `yaml:"-"`
    VolumeMounts map[string]any            `yaml:"-"`

    Name         string                    `yaml:"name"`
    Icon         string                    `yaml:"icon,omitempty"`
    APIVersion   string                    `yaml:"apiVersion"`
    Version      string                    `yaml:"version"`
    AppVersion   string                    `yaml:"appVersion"`
    Description  string                    `yaml:"description"`
    Helper       string                    `yaml:"-"`
    Dependencies []labelstructs.Dependency `yaml:"dependencies,omitempty"`
    // contains filtered or unexported fields
}
```

<a name="Generate"></a>
### func [Generate](<https://repo.katenary.io/Katenary/katenary/blob/master/internal/generator/generator.go#L32>)

```go
func Generate(project *types.Project) (*HelmChart, error)
```

Generate a chart from a compose project. This does not write files to disk, it only creates the HelmChart object.

The Generate function will create the HelmChart object this way:

- Detect the service port name or leave the port number if not found.
- Create a deployment for each service that are not ingnore.
- Create a service and ingresses for each service that has ports and/or declared ingresses.
- Create a PVC or Configmap volumes for each volume.
- Create init containers for each service which has dependencies to other services.
- Create a chart dependencies.
- Create a configmap and secrets from the environment variables.
- Merge the same\-pod services.

<a name="NewChart"></a>
### func [NewChart](<https://repo.katenary.io/Katenary/katenary/blob/master/internal/generator/chart.go#L57>)

```go
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/master/internal/generator/chart.go#L72>)

```go
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/master/internal/generator/ingress.go#L18-L22>)



```go
type Ingress struct {
    *networkv1.Ingress
    // contains filtered or unexported fields
}
```

<a name="NewIngress"></a>
### func [NewIngress](<https://repo.katenary.io/Katenary/katenary/blob/master/internal/generator/ingress.go#L25>)

```go
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://repo.katenary.io/Katenary/katenary/blob/master/internal/generator/ingress.go#L129>)

```go
func (ingress *Ingress) Filename() string
```



<a name="Ingress.Yaml"></a>
### func \(\*Ingress\) [Yaml](<https://repo.katenary.io/Katenary/katenary/blob/master/internal/generator/ingress.go#L133>)

```go
func (ingress *Ingress) Yaml() ([]byte, error)
```



<a name="IngressValue"></a>
## type [IngressValue](<https://repo.katenary.io/Katenary/katenary/blob/master/internal/generator/values.go#L29-L36>)

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"`
}
```

<a name="PersistenceValue"></a>
## type [PersistenceValue](<https://repo.katenary.io/Katenary/katenary/blob/master/internal/generator/values.go#L16-L21>)

PersistenceValue is a persistence configuration that will be saved in values.yaml.

```go
type PersistenceValue struct {
    StorageClass string   `yaml:"storageClass"`
    Size         string   `yaml:"size"`
    AccessMode   []string `yaml:"accessMode"`
    Enabled      bool     `yaml:"enabled"`
}
```

<a name="RBAC"></a>
## type [RBAC](<https://repo.katenary.io/Katenary/katenary/blob/master/internal/generator/rbac.go#L20-L24>)

RBAC is a kubernetes RBAC containing a role, a rolebinding and an associated serviceaccount.

```go
type RBAC struct {
    RoleBinding    *RoleBinding
    Role           *Role
    ServiceAccount *ServiceAccount
}
```

<a name="NewRBAC"></a>
### func [NewRBAC](<https://repo.katenary.io/Katenary/katenary/blob/master/internal/generator/rbac.go#L27>)

```go
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/master/internal/generator/values.go#L10-L13>)

RepositoryValue is a docker repository image and tag that will be saved in values.yaml.

```go
type RepositoryValue struct {
    Image string `yaml:"image"`
    Tag   string `yaml:"tag"`
}
```

<a name="Role"></a>
## type [Role](<https://repo.katenary.io/Katenary/katenary/blob/master/internal/generator/rbac.go#L114-L117>)

Role is a kubernetes Role.

```go
type Role struct {
    *rbacv1.Role
    // contains filtered or unexported fields
}
```

<a name="Role.Filename"></a>
### func \(\*Role\) [Filename](<https://repo.katenary.io/Katenary/katenary/blob/master/internal/generator/rbac.go#L119>)

```go
func (r *Role) Filename() string
```



<a name="Role.Yaml"></a>
### func \(\*Role\) [Yaml](<https://repo.katenary.io/Katenary/katenary/blob/master/internal/generator/rbac.go#L123>)

```go
func (r *Role) Yaml() ([]byte, error)
```



<a name="RoleBinding"></a>
## type [RoleBinding](<https://repo.katenary.io/Katenary/katenary/blob/master/internal/generator/rbac.go#L100-L103>)

RoleBinding is a kubernetes RoleBinding.

```go
type RoleBinding struct {
    *rbacv1.RoleBinding
    // contains filtered or unexported fields
}
```

<a name="RoleBinding.Filename"></a>
### func \(\*RoleBinding\) [Filename](<https://repo.katenary.io/Katenary/katenary/blob/master/internal/generator/rbac.go#L105>)

```go
func (r *RoleBinding) Filename() string
```



<a name="RoleBinding.Yaml"></a>
### func \(\*RoleBinding\) [Yaml](<https://repo.katenary.io/Katenary/katenary/blob/master/internal/generator/rbac.go#L109>)

```go
func (r *RoleBinding) Yaml() ([]byte, error)
```



<a name="Secret"></a>
## type [Secret](<https://repo.katenary.io/Katenary/katenary/blob/master/internal/generator/secret.go#L23-L26>)

Secret is a kubernetes Secret.

Implements the DataMap interface.

```go
type Secret struct {
    *corev1.Secret
    // contains filtered or unexported fields
}
```

<a name="NewSecret"></a>
### func [NewSecret](<https://repo.katenary.io/Katenary/katenary/blob/master/internal/generator/secret.go#L29>)

```go
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/master/internal/generator/secret.go#L71>)

```go
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/master/internal/generator/secret.go#L87>)

```go
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/master/internal/generator/secret.go#L92>)

```go
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/master/internal/generator/secret.go#L99>)

```go
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/master/internal/generator/service.go#L19-L22>)

Service is a kubernetes Service.

```go
type Service struct {
    *v1.Service `yaml:",inline"`
    // contains filtered or unexported fields
}
```

<a name="NewService"></a>
### func [NewService](<https://repo.katenary.io/Katenary/katenary/blob/master/internal/generator/service.go#L25>)

```go
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/master/internal/generator/service.go#L54>)

```go
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/master/internal/generator/service.go#L75>)

```go
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/master/internal/generator/service.go#L80>)

```go
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/master/internal/generator/rbac.go#L132-L135>)

ServiceAccount is a kubernetes ServiceAccount.

```go
type ServiceAccount struct {
    *corev1.ServiceAccount
    // contains filtered or unexported fields
}
```

<a name="ServiceAccount.Filename"></a>
### func \(\*ServiceAccount\) [Filename](<https://repo.katenary.io/Katenary/katenary/blob/master/internal/generator/rbac.go#L137>)

```go
func (r *ServiceAccount) Filename() string
```



<a name="ServiceAccount.Yaml"></a>
### func \(\*ServiceAccount\) [Yaml](<https://repo.katenary.io/Katenary/katenary/blob/master/internal/generator/rbac.go#L141>)

```go
func (r *ServiceAccount) Yaml() ([]byte, error)
```



<a name="TLS"></a>
## type [TLS](<https://repo.katenary.io/Katenary/katenary/blob/master/internal/generator/values.go#L23-L26>)



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

<a name="Value"></a>
## type [Value](<https://repo.katenary.io/Katenary/katenary/blob/master/internal/generator/values.go#L39-L50>)

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

```go
type Value struct {
    Repository      *RepositoryValue             `yaml:"repository,omitempty"`
    Persistence     map[string]*PersistenceValue `yaml:"persistence,omitempty"`
    Ingress         *IngressValue                `yaml:"ingress,omitempty"`
    Environment     map[string]any               `yaml:"environment,omitempty"`
    Replicas        *uint32                      `yaml:"replicas,omitempty"`
    CronJob         *CronJobValue                `yaml:"cronjob,omitempty"`
    NodeSelector    map[string]string            `yaml:"nodeSelector"`
    Resources       map[string]any               `yaml:"resources"`
    ImagePullPolicy string                       `yaml:"imagePullPolicy,omitempty"`
    ServiceAccount  string                       `yaml:"serviceAccount"`
}
```

<a name="NewValue"></a>
### func [NewValue](<https://repo.katenary.io/Katenary/katenary/blob/master/internal/generator/values.go#L57>)

```go
func NewValue(service types.ServiceConfig, main ...bool) *Value
```

NewValue creates a new Value from a compose service. The value contains the necessary information to deploy the service \(image, tag, replicas, etc.\).

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/master/internal/generator/values.go#L90>)

```go
func (v *Value) AddIngress(host, path string)
```



<a name="Value.AddPersistence"></a>
### func \(\*Value\) [AddPersistence](<https://repo.katenary.io/Katenary/katenary/blob/master/internal/generator/values.go#L104>)

```go
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/master/internal/generator/volume.go#L19-L24>)

VolumeClaim is a kubernetes VolumeClaim. This is a PersistentVolumeClaim.

```go
type VolumeClaim struct {
    *v1.PersistentVolumeClaim
    // contains filtered or unexported fields
}
```

<a name="NewVolumeClaim"></a>
### func [NewVolumeClaim](<https://repo.katenary.io/Katenary/katenary/blob/master/internal/generator/volume.go#L27>)

```go
func NewVolumeClaim(service types.ServiceConfig, volumeName, appName string) *VolumeClaim
```

NewVolumeClaim creates a new VolumeClaim from a compose service.

<a name="VolumeClaim.Filename"></a>
### func \(\*VolumeClaim\) [Filename](<https://repo.katenary.io/Katenary/katenary/blob/master/internal/generator/volume.go#L63>)

```go
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/master/internal/generator/volume.go#L68>)

```go
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/master/internal/generator/types.go#L10-L13>)

Yaml is a kubernetes object that can be converted to yaml.

```go
type Yaml interface {
    Yaml() ([]byte, error)
    Filename() string
}
```

Generated by [gomarkdoc](<https://github.com/princjef/gomarkdoc>)