diff --git a/doc/docs/labels.md b/doc/docs/labels.md
index 3f13b63..d0c1a69 100644
--- a/doc/docs/labels.md
+++ b/doc/docs/labels.md
@@ -187,9 +187,10 @@ Health check to be added to the deployment.
```yaml
labels:
katenary.v3/health-check: |-
- httpGet:
- path: /health
- port: 8080
+ livenessProbe:
+ httpGet:
+ path: /health
+ port: 8080
```
### katenary.v3/ignore
diff --git a/doc/docs/packages/generator.md b/doc/docs/packages/generator.md
index 5df58a5..a0df7f5 100644
--- a/doc/docs/packages/generator.md
+++ b/doc/docs/packages/generator.md
@@ -98,7 +98,7 @@ func Helper(name string) string
Helper returns the \_helpers.tpl file for a chart.
-## func [NewCronJob]()
+## func [NewCronJob]()
```go
func NewCronJob(service types.ServiceConfig, chart *HelmChart, appName string) (*CronJob, *RBAC)
@@ -115,6 +115,15 @@ func Prefix() string
+
+## func [UnWrapTPL]()
+
+```go
+func UnWrapTPL(in []byte) []byte
+```
+
+UnWrapTPL removes the line wrapping from a template.
+
## type [ChartTemplate]()
@@ -149,7 +158,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".
-### func [NewConfigMapFromDirectory]()
+### func [NewConfigMapFromDirectory]()
```go
func NewConfigMapFromDirectory(service types.ServiceConfig, appName, path string) *ConfigMap
@@ -158,7 +167,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.
-### func \(\*ConfigMap\) [AddData]()
+### func \(\*ConfigMap\) [AddData]()
```go
func (c *ConfigMap) AddData(key, value string)
@@ -167,7 +176,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.
-### func \(\*ConfigMap\) [AppendDir]()
+### func \(\*ConfigMap\) [AppendDir]()
```go
func (c *ConfigMap) AppendDir(path string)
@@ -176,7 +185,7 @@ func (c *ConfigMap) AppendDir(path string)
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.
-### func \(\*ConfigMap\) [AppendFile]()
+### func \(\*ConfigMap\) [AppendFile]()
```go
func (c *ConfigMap) AppendFile(path string)
@@ -185,7 +194,7 @@ func (c *ConfigMap) AppendFile(path string)
-### func \(\*ConfigMap\) [Filename]()
+### func \(\*ConfigMap\) [Filename]()
```go
func (c *ConfigMap) Filename() string
@@ -194,7 +203,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.
-### func \(\*ConfigMap\) [SetData]()
+### func \(\*ConfigMap\) [SetData]()
```go
func (c *ConfigMap) SetData(data map[string]string)
@@ -203,7 +212,7 @@ func (c *ConfigMap) SetData(data map[string]string)
SetData sets the data of the configmap. It replaces the entire data.
-### func \(\*ConfigMap\) [Yaml]()
+### func \(\*ConfigMap\) [Yaml]()
```go
func (c *ConfigMap) Yaml() ([]byte, error)
@@ -234,14 +243,14 @@ type ConvertOptions struct {
ChartVersion string
Icon string
Profiles []string
+ EnvFiles []string
Force bool
HelmUpdate bool
- EnvFiles []string
}
```
-## type [CronJob]()
+## type [CronJob]()
CronJob is a kubernetes CronJob.
@@ -253,7 +262,7 @@ type CronJob struct {
```
-### func \(\*CronJob\) [Filename]()
+### func \(\*CronJob\) [Filename]()
```go
func (c *CronJob) Filename() string
@@ -264,7 +273,7 @@ Filename returns the filename of the cronjob.
Implements the Yaml interface.
-### func \(\*CronJob\) [Yaml]()
+### func \(\*CronJob\) [Yaml]()
```go
func (c *CronJob) Yaml() ([]byte, error)
@@ -275,7 +284,7 @@ Yaml returns the yaml representation of the cronjob.
Implements the Yaml interface.
-## type [CronJobValue]()
+## type [CronJobValue]()
CronJobValue is a cronjob configuration that will be saved in values.yaml.
@@ -310,7 +319,7 @@ func NewFileMap(service types.ServiceConfig, appName, kind string) DataMap
NewFileMap creates a new DataMap from a compose service. The appName is the name of the application taken from the project name.
-## type [Deployment]()
+## type [Deployment]()
Deployment is a kubernetes Deployment.
@@ -322,7 +331,7 @@ type Deployment struct {
```
-### func [NewDeployment]()
+### func [NewDeployment]()
```go
func NewDeployment(service types.ServiceConfig, chart *HelmChart) *Deployment
@@ -331,7 +340,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.
-### func \(\*Deployment\) [AddContainer]()
+### func \(\*Deployment\) [AddContainer]()
```go
func (d *Deployment) AddContainer(service types.ServiceConfig)
@@ -340,7 +349,7 @@ func (d *Deployment) AddContainer(service types.ServiceConfig)
AddContainer adds a container to the deployment.
-### func \(\*Deployment\) [AddHealthCheck]()
+### func \(\*Deployment\) [AddHealthCheck]()
```go
func (d *Deployment) AddHealthCheck(service types.ServiceConfig, container *corev1.Container)
@@ -349,7 +358,7 @@ func (d *Deployment) AddHealthCheck(service types.ServiceConfig, container *core
-### func \(\*Deployment\) [AddIngress]()
+### func \(\*Deployment\) [AddIngress]()
```go
func (d *Deployment) AddIngress(service types.ServiceConfig, appName string) *Ingress
@@ -358,7 +367,7 @@ func (d *Deployment) AddIngress(service types.ServiceConfig, appName string) *In
AddIngress adds an ingress to the deployment. It creates the ingress object.
-### func \(\*Deployment\) [AddVolumes]()
+### 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.
-### func \(\*Deployment\) [BindFrom]()
+### 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)
-### func \(\*Deployment\) [DependsOn]()
+### func \(\*Deployment\) [DependsOn]()
```go
func (d *Deployment) DependsOn(to *Deployment, servicename string) error
@@ -385,7 +394,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.
-### func \(\*Deployment\) [Filename]()
+### func \(\*Deployment\) [Filename]()
```go
func (d *Deployment) Filename() string
@@ -394,7 +403,7 @@ func (d *Deployment) Filename() string
Filename returns the filename of the deployment.
-### func \(\*Deployment\) [SetEnvFrom]()
+### func \(\*Deployment\) [SetEnvFrom]()
```go
func (d *Deployment) SetEnvFrom(service types.ServiceConfig, appName string)
@@ -403,7 +412,7 @@ func (d *Deployment) SetEnvFrom(service types.ServiceConfig, appName string)
SetEnvFrom sets the environment variables to a configmap. The configmap is created.
-### func \(\*Deployment\) [Yaml]()
+### func \(\*Deployment\) [Yaml]()
```go
func (d *Deployment) Yaml() ([]byte, error)
@@ -453,7 +462,7 @@ type HelmChart struct {
```
-### func [Generate]()
+### func [Generate]()
```go
func Generate(project *types.Project) (*HelmChart, error)
@@ -505,7 +514,7 @@ type Help struct {
```
-## type [Ingress]()
+## type [Ingress]()
@@ -517,7 +526,7 @@ type Ingress struct {
```
-### func [NewIngress]()
+### func [NewIngress]()
```go
func NewIngress(service types.ServiceConfig, Chart *HelmChart) *Ingress
@@ -526,7 +535,7 @@ func NewIngress(service types.ServiceConfig, Chart *HelmChart) *Ingress
NewIngress creates a new Ingress from a compose service.
-### func \(\*Ingress\) [Filename]()
+### func \(\*Ingress\) [Filename]()
```go
func (ingress *Ingress) Filename() string
@@ -535,7 +544,7 @@ func (ingress *Ingress) Filename() string
-### func \(\*Ingress\) [Yaml]()
+### func \(\*Ingress\) [Yaml]()
```go
func (ingress *Ingress) Yaml() ([]byte, error)
@@ -697,7 +706,7 @@ func (r *RoleBinding) Yaml() ([]byte, error)
-## type [Secret]()
+## type [Secret]()
Secret is a kubernetes Secret.
@@ -711,7 +720,7 @@ type Secret struct {
```
-### func [NewSecret]()
+### func [NewSecret]()
```go
func NewSecret(service types.ServiceConfig, appName string) *Secret
@@ -720,7 +729,7 @@ func NewSecret(service types.ServiceConfig, appName string) *Secret
NewSecret creates a new Secret from a compose service
-### func \(\*Secret\) [AddData]()
+### func \(\*Secret\) [AddData]()
```go
func (s *Secret) AddData(key, value string)
@@ -729,7 +738,7 @@ func (s *Secret) AddData(key, value string)
AddData adds a key value pair to the secret.
-### func \(\*Secret\) [Filename]()
+### func \(\*Secret\) [Filename]()
```go
func (s *Secret) Filename() string
@@ -738,7 +747,7 @@ func (s *Secret) Filename() string
Filename returns the filename of the secret.
-### func \(\*Secret\) [SetData]()
+### func \(\*Secret\) [SetData]()
```go
func (s *Secret) SetData(data map[string]string)
@@ -747,7 +756,7 @@ func (s *Secret) SetData(data map[string]string)
SetData sets the data of the secret.
-### func \(\*Secret\) [Yaml]()
+### func \(\*Secret\) [Yaml]()
```go
func (s *Secret) Yaml() ([]byte, error)
@@ -756,7 +765,7 @@ func (s *Secret) Yaml() ([]byte, error)
Yaml returns the yaml representation of the secret.
-## type [Service]()
+## type [Service]()
Service is a kubernetes Service.
@@ -768,7 +777,7 @@ type Service struct {
```
-### func [NewService]()
+### func [NewService]()
```go
func NewService(service types.ServiceConfig, appName string) *Service
@@ -777,7 +786,7 @@ func NewService(service types.ServiceConfig, appName string) *Service
NewService creates a new Service from a compose service.
-### func \(\*Service\) [AddPort]()
+### func \(\*Service\) [AddPort]()
```go
func (s *Service) AddPort(port types.ServicePortConfig, serviceName ...string)
@@ -786,7 +795,7 @@ func (s *Service) AddPort(port types.ServicePortConfig, serviceName ...string)
AddPort adds a port to the service.
-### func \(\*Service\) [Filename]()
+### func \(\*Service\) [Filename]()
```go
func (s *Service) Filename() string
@@ -795,7 +804,7 @@ func (s *Service) Filename() string
Filename returns the filename of the service.
-### func \(\*Service\) [Yaml]()
+### func \(\*Service\) [Yaml]()
```go
func (s *Service) Yaml() ([]byte, error)
@@ -804,7 +813,7 @@ func (s *Service) Yaml() ([]byte, error)
Yaml returns the yaml representation of the service.
-## type [ServiceAccount]()
+## type [ServiceAccount]()
ServiceAccount is a kubernetes ServiceAccount.
@@ -816,7 +825,7 @@ type ServiceAccount struct {
```
-### func \(\*ServiceAccount\) [Filename]()
+### func \(\*ServiceAccount\) [Filename]()
```go
func (r *ServiceAccount) Filename() string
@@ -825,7 +834,7 @@ func (r *ServiceAccount) Filename() string
-### func \(\*ServiceAccount\) [Yaml]()
+### func \(\*ServiceAccount\) [Yaml]()
```go
func (r *ServiceAccount) Yaml() ([]byte, error)
@@ -883,7 +892,7 @@ func (v *Value) AddPersistence(volumeName string)
AddPersistence adds persistence configuration to the Value.
-## type [VolumeClaim]()
+## type [VolumeClaim]()
VolumeClaim is a kubernetes VolumeClaim. This is a PersistentVolumeClaim.
@@ -895,7 +904,7 @@ type VolumeClaim struct {
```
-### func [NewVolumeClaim]()
+### func [NewVolumeClaim]()
```go
func NewVolumeClaim(service types.ServiceConfig, volumeName, appName string) *VolumeClaim
diff --git a/doc/docs/packages/utils.md b/doc/docs/packages/utils.md
index 6fb81fb..cbe4062 100644
--- 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 [Confirm]()
+## func [Confirm]()
```go
func Confirm(question string, icon ...Icon) bool
@@ -26,7 +26,7 @@ func CountStartingSpaces(line string) int
CountStartingSpaces counts the number of spaces at the beginning of a string.
-## func [EncodeBasicYaml]()
+## func [EncodeBasicYaml]()
```go
func EncodeBasicYaml(data any) ([]byte, error)
@@ -34,6 +34,15 @@ func EncodeBasicYaml(data any) ([]byte, error)
EncodeBasicYaml encodes a basic yaml from an interface.
+
+## func [FixedResourceName]()
+
+```go
+func FixedResourceName(name string) string
+```
+
+FixedResourceName returns a resource name without underscores to respect the kubernetes naming convention.
+
## func [GetContainerByName]()
@@ -62,7 +71,7 @@ func GetServiceNameByPort(port int) string
GetServiceNameByPort returns the service name for a port. It the service name is not found, it returns an empty string.
-## func [GetValuesFromLabel]()
+## func [GetValuesFromLabel]()
```go
func GetValuesFromLabel(service types.ServiceConfig, LabelValues string) map[string]*EnvConfig
@@ -89,7 +98,7 @@ func Int32Ptr(i int32) *int32
Int32Ptr returns a pointer to an int32.
-## func [MapKeys]()
+## func [MapKeys]()
```go
func MapKeys(m map[string]interface{}) []string
@@ -143,7 +152,7 @@ func Warn(msg ...interface{})
Warn prints a warning message
-## func [WordWrap]()
+## func [WordWrap]()
```go
func WordWrap(text string, lineWidth int) string
@@ -170,7 +179,7 @@ func WrapBytes(src, above, below []byte) []byte
WrapBytes wraps a byte array with a byte array above and below. It will respect the indentation of the src string.
-## type [EnvConfig]()
+## type [EnvConfig]()
EnvConfig is a struct to hold the description of an environment variable.