Add temporary logo

Fix #2

.gitignore

@@ -5,3 +5,4 @@ docker-compose.yaml
 katenary
 *.env
 docker-compose*
+!examples/**/docker-compose*

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Patrice Ferlet
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,10 +1,18 @@
+![Logo](misc/logo.png)
+
 Katenary is a tool to help transforming `docker-compose` files to a working Helm Chart for Kubernetes.
 
 > **Important Note** Katenary is a tool to help building Helm Chart from a docker-compose file, but docker-compose doesn't propose as many features as what can do Kubernetes. So, we strongly recommend to use Katenary as a "bootstrap" tool and then to manually enhance the generated helm chart.
 
+This project is partially made at [Smile](https://smile.eu)
+
+![smile logo](misc/Logo_Smile.png)
+
 
 # Install
 
+You can download the binaries from the [Release](https://github.com/metal3d/katenary/releases) section. Copy the binary and rename it to `katenary`. Place the binary inside your `PATH`. You should now be able to call the `katenary` command.
+
 If you've got `podman` or `docker`, you can build `katenary` by using:
 
 ```bash
@@ -93,7 +101,7 @@ What can be interpreted by Katenary:
 - `env_file` list will create a configMap object per environemnt file (⚠ todo: the "to-service" label doesn't work with configMap for now)
 - some labels can help to bind values, for example:
     - `katenary.io/ingress: 80` will expose the port 80 in a ingress
-    - `katenary.io/to-service: VARNAME` will convert the value to a variable `{{ .Release.Name }}-VARNAME` - it's usefull when you want to pass the name of a service as a variable (think about the service name for mysql to pass to a container that wants to connect to this)
+    - `katenary.io/env-to-service: VARNAME` will convert the value to a variable `{{ .Release.Name }}-VARNAME` - it's usefull when you want to pass the name of a service as a variable (think about the service name for mysql to pass to a container that wants to connect to this)
 
 Exemple of a possible `docker-compose.yaml` file:
 

examples/basic/README.md

@@ -0,0 +1,10 @@
+# Basic example
+
+This is a basic example of what can do Katenary with standard docker-compose file.
+
+In this example:
+
+- `depends_on` yield a `initContainer` in the webapp ddeployment to wait for database
+- so we need to declare the listened port inside `database` container as we don't use it with docker-compose- also, we needed to declare that `DB_HOST` is actually a service name
+
+Take a look on [chart/basic](chart/basic) directory to see what `katenary convert` command has generated.

examples/basic/chart/basic/Chart.yaml

@@ -0,0 +1,8 @@
+# Create on 2022-02-17T10:27:30+01:00
+# Katenary command line: katenary convert
+apiVersion: v2
+appVersion: 0.0.1
+description: A helm chart for basic
+name: basic
+type: application
+version: 0.1.0

examples/basic/chart/basic/templates/NOTES.txt

@@ -0,0 +1,8 @@
+
+Congratulations,
+
+Your application is now deployed. This may take a while to be up and responding.
+
+{{ if .Values.webapp.ingress.enabled -}}
+- webapp is accessible on : http://{{ .Values.webapp.ingress.host }}
+{{- end }}

examples/basic/chart/basic/templates/database.deployment.yaml

@@ -0,0 +1,39 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: '{{ .Release.Name }}-database'
+  labels:
+    katenary.io/component: database
+    katenary.io/project: basic
+    katenary.io/release: '{{ .Release.Name }}'
+  annotations:
+    katenary.io/docker-compose-sha1: b9f12bb7d1e97901c1d7680394209525763f6640
+    katenary.io/version: master-3619cc4
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      katenary.io/component: database
+      katenary.io/release: '{{ .Release.Name }}'
+  template:
+    metadata:
+      labels:
+        katenary.io/component: database
+        katenary.io/release: '{{ .Release.Name }}'
+    spec:
+      containers:
+        - name: database
+          image: '{{ .Values.database.image }}'
+          ports:
+            - name: database
+              containerPort: 3306
+          env:
+            - name: MARIADB_PASSWORD
+              value: foo
+            - name: MARIADB_DATABASE
+              value: myapp
+            - name: MARIADB_ROOT_PASSWORD
+              value: foobar
+            - name: MARIADB_USER
+              value: foo
+

examples/basic/chart/basic/templates/database.service.yaml

@@ -0,0 +1,19 @@
+apiVersion: v1
+kind: Service
+metadata:
+  name: '{{ .Release.Name }}-database'
+  labels:
+    katenary.io/component: database
+    katenary.io/project: basic
+    katenary.io/release: '{{ .Release.Name }}'
+  annotations:
+    katenary.io/docker-compose-sha1: b9f12bb7d1e97901c1d7680394209525763f6640
+    katenary.io/version: master-3619cc4
+spec:
+  selector:
+    katenary.io/component: database
+    katenary.io/release: '{{ .Release.Name }}'
+  ports:
+    - protocol: TCP
+      port: 3306
+      targetPort: 3306

examples/basic/chart/basic/templates/webapp.deployment.yaml

@@ -0,0 +1,48 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: '{{ .Release.Name }}-webapp'
+  labels:
+    katenary.io/component: webapp
+    katenary.io/project: basic
+    katenary.io/release: '{{ .Release.Name }}'
+  annotations:
+    katenary.io/docker-compose-sha1: b9f12bb7d1e97901c1d7680394209525763f6640
+    katenary.io/version: master-3619cc4
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      katenary.io/component: webapp
+      katenary.io/release: '{{ .Release.Name }}'
+  template:
+    metadata:
+      labels:
+        katenary.io/component: webapp
+        katenary.io/release: '{{ .Release.Name }}'
+    spec:
+      initContainers:
+        - name: check-database
+          image: busybox
+          command:
+            - sh
+            - -c
+            - |-
+              OK=0
+              echo "Checking database port"
+              while [ $OK != 1 ]; do
+                  echo -n "."
+                  nc -z {{ .Release.Name }}-database 3306 2>&1 >/dev/null && OK=1 || sleep 1
+              done
+              echo
+              echo "Done"
+      containers:
+        - name: webapp
+          image: '{{ .Values.webapp.image }}'
+          ports:
+            - name: webapp
+              containerPort: 80
+          env:
+            - name: DB_HOST
+              value: '{{ .Release.Name }}-database'
+

examples/basic/chart/basic/templates/webapp.ingress.yaml

@@ -0,0 +1,34 @@
+{{- if .Values.webapp.ingress.enabled -}}
+apiVersion: networking.k8s.io/v1
+kind: Ingress
+metadata:
+  name: '{{ .Release.Name }}-webapp'
+  labels:
+    katenary.io/component: webapp
+    katenary.io/project: basic
+    katenary.io/release: '{{ .Release.Name }}'
+  annotations:
+    katenary.io/docker-compose-sha1: b9f12bb7d1e97901c1d7680394209525763f6640
+    katenary.io/version: master-3619cc4
+spec:
+  {{- if and .Values.webapp.ingress.class (semverCompare ">=1.18-0" .Capabilities.KubeVersion.GitVersion) }}
+  ingressClassName: '{{ .Values.webapp.ingress.class }}'
+  {{- end }}
+  rules:
+    - host: '{{ .Values.webapp.ingress.host }}'
+      http:
+        paths:
+          - path: /
+            pathType: Prefix
+            backend:
+              {{- if semverCompare ">=1.18-0" .Capabilities.KubeVersion.GitVersion }}
+              service:
+                name: '{{ .Release.Name }}-webapp'
+                port:
+                  number: 80
+              {{- else }}
+              serviceName: '{{ .Release.Name }}-webapp'
+              servicePort: 80
+              {{- end }}
+
+{{- end -}}

examples/basic/chart/basic/templates/webapp.service.yaml

@@ -0,0 +1,19 @@
+apiVersion: v1
+kind: Service
+metadata:
+  name: '{{ .Release.Name }}-webapp'
+  labels:
+    katenary.io/component: webapp
+    katenary.io/project: basic
+    katenary.io/release: '{{ .Release.Name }}'
+  annotations:
+    katenary.io/docker-compose-sha1: b9f12bb7d1e97901c1d7680394209525763f6640
+    katenary.io/version: master-3619cc4
+spec:
+  selector:
+    katenary.io/component: webapp
+    katenary.io/release: '{{ .Release.Name }}'
+  ports:
+    - protocol: TCP
+      port: 80
+      targetPort: 80

examples/basic/chart/basic/values.yaml

@@ -0,0 +1,8 @@
+database:
+  image: mariadb:10
+webapp:
+  image: php:7-apache
+  ingress:
+    class: nginx
+    enabled: false
+    host: webapp.basic.tld

examples/basic/docker-compose.yaml

@@ -0,0 +1,30 @@
+version: "3"
+
+services:
+
+  webapp:
+    image: php:7-apache
+
+    environment:
+      DB_HOST: database
+    ports:
+      - "8080:80"
+    labels:
+      # expose an ingress
+      katenary.io/ingress: 80
+      # DB_HOST is actually a service name
+      katenary.io/env-to-service: DB_HOST
+    depends_on:
+      - database
+
+  database:
+    image: mariadb:10
+    environment:
+      MARIADB_ROOT_PASSWORD: foobar
+      MARIADB_USER: foo
+      MARIADB_PASSWORD: foo
+      MARIADB_DATABASE: myapp
+    labels:
+      # because we don't provide "ports" or "expose", alert katenary
+      # to use the mysql port for service declaration
+      katenary.io/ports: 3306

examples/same-pod/README.md

@@ -0,0 +1,13 @@
+# Make it possible to bind several containers in one pod
+
+In this example, we need to make nginx and php-fpm to run inside the same "pod". The reason is that we configured FPM to listen an unix socket instead of the 9000 port.
+
+Because NGinx will need to connect to the unix socket wich is a file, both containers should share the same node and work together.
+
+So, in the docker-compose file, we need to declare:
+- `katenary.io/empty-dirs: socket` where `socket` is the "volume name", this will avoid the creation of a PVC
+- `katenary.io/same-pod: http` in `php` container to declare that this will be added in the `containers` section of the `http` deployment
+
+You can note that we also use `configmap-volumes` to declare our configuration as `configMap`.
+
+Take a look on [chart/same-pod](chart/same-pod) directory to see the result of the `katenary convert` command.

examples/same-pod/chart/same-pod/Chart.yaml

@@ -0,0 +1,8 @@
+# Create on 2022-02-17T11:36:02+01:00
+# Katenary command line: katenary convert --force
+apiVersion: v2
+appVersion: 0.0.1
+description: A helm chart for same-pod
+name: same-pod
+type: application
+version: 0.1.0

examples/same-pod/chart/same-pod/templates/NOTES.txt

@@ -0,0 +1,8 @@
+
+Congratulations,
+
+Your application is now deployed. This may take a while to be up and responding.
+
+{{ if .Values.http.ingress.enabled -}}
+- http is accessible on : http://{{ .Values.http.ingress.host }}
+{{- end }}

examples/same-pod/chart/same-pod/templates/http.config-nginx-http.configmap.yaml

@@ -0,0 +1,23 @@
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: '{{ .Release.Name }}-config-nginx-http'
+  labels:
+    katenary.io/component: ""
+    katenary.io/project: same-pod
+    katenary.io/release: '{{ .Release.Name }}'
+  annotations:
+    katenary.io/docker-compose-sha1: 74e67695bfdbb829f15531321e158808018280e0
+    katenary.io/version: master-bf44d44
+data:
+  default.conf: |
+    upstream _php {
+      server unix:/sock/fpm.sock;
+    }
+    server {
+      listen 80;
+      location ~ ^/index\.php(/|$) {
+        fastcgi_pass _php;
+        include fastcgi_params;
+      }
+    }

examples/same-pod/chart/same-pod/templates/http.config-php-php.configmap.yaml

@@ -0,0 +1,30 @@
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: '{{ .Release.Name }}-config-php-php'
+  labels:
+    katenary.io/component: ""
+    katenary.io/project: same-pod
+    katenary.io/release: '{{ .Release.Name }}'
+  annotations:
+    katenary.io/docker-compose-sha1: 74e67695bfdbb829f15531321e158808018280e0
+    katenary.io/version: master-bf44d44
+data:
+  www.conf: |
+    [www]
+    user = www-data
+    group = www-data
+
+    listen = /sock/fpm.sock
+
+    pm = dynamic
+    pm.max_children = 5
+    pm.start_servers = 2
+    pm.min_spare_servers = 1
+    pm.max_spare_servers = 3
+
+    access.log = /proc/self/fd/2
+    log_limit = 8192
+    clear_env = no
+    catch_workers_output = yes
+    decorate_workers_output = no

examples/same-pod/chart/same-pod/templates/http.deployment.yaml

@@ -0,0 +1,52 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: '{{ .Release.Name }}-http'
+  labels:
+    katenary.io/component: http
+    katenary.io/project: same-pod
+    katenary.io/release: '{{ .Release.Name }}'
+  annotations:
+    katenary.io/docker-compose-sha1: 74e67695bfdbb829f15531321e158808018280e0
+    katenary.io/version: master-bf44d44
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      katenary.io/component: http
+      katenary.io/release: '{{ .Release.Name }}'
+  template:
+    metadata:
+      labels:
+        katenary.io/component: http
+        katenary.io/release: '{{ .Release.Name }}'
+    spec:
+      containers:
+        - name: http
+          image: '{{ .Values.http.image }}'
+          ports:
+            - name: http
+              containerPort: 80
+          volumeMounts:
+            - mountPath: /sock
+              name: sock
+            - mountPath: /etc/nginx/conf.d
+              name: config-nginx
+        - name: php
+          image: '{{ .Values.php.image }}'
+          volumeMounts:
+            - mountPath: /sock
+              name: sock
+            - mountPath: /usr/local/etc/php-fpm.d/www.conf
+              name: config-php
+              subPath: www.conf
+      volumes:
+        - emptyDir: {}
+          name: sock
+        - configMap:
+            name: '{{ .Release.Name }}-config-nginx-http'
+          name: config-nginx
+        - configMap:
+            name: '{{ .Release.Name }}-config-php-php'
+          name: config-php
+

examples/same-pod/chart/same-pod/templates/http.ingress.yaml

@@ -0,0 +1,34 @@
+{{- if .Values.http.ingress.enabled -}}
+apiVersion: networking.k8s.io/v1
+kind: Ingress
+metadata:
+  name: '{{ .Release.Name }}-http'
+  labels:
+    katenary.io/component: http
+    katenary.io/project: same-pod
+    katenary.io/release: '{{ .Release.Name }}'
+  annotations:
+    katenary.io/docker-compose-sha1: 74e67695bfdbb829f15531321e158808018280e0
+    katenary.io/version: master-bf44d44
+spec:
+  {{- if and .Values.http.ingress.class (semverCompare ">=1.18-0" .Capabilities.KubeVersion.GitVersion) }}
+  ingressClassName: '{{ .Values.http.ingress.class }}'
+  {{- end }}
+  rules:
+    - host: '{{ .Values.http.ingress.host }}'
+      http:
+        paths:
+          - path: /
+            pathType: Prefix
+            backend:
+              {{- if semverCompare ">=1.18-0" .Capabilities.KubeVersion.GitVersion }}
+              service:
+                name: '{{ .Release.Name }}-http'
+                port:
+                  number: 80
+              {{- else }}
+              serviceName: '{{ .Release.Name }}-http'
+              servicePort: 80
+              {{- end }}
+
+{{- end -}}

examples/same-pod/chart/same-pod/templates/http.service.yaml

@@ -0,0 +1,19 @@
+apiVersion: v1
+kind: Service
+metadata:
+  name: '{{ .Release.Name }}-http'
+  labels:
+    katenary.io/component: http
+    katenary.io/project: same-pod
+    katenary.io/release: '{{ .Release.Name }}'
+  annotations:
+    katenary.io/docker-compose-sha1: 74e67695bfdbb829f15531321e158808018280e0
+    katenary.io/version: master-bf44d44
+spec:
+  selector:
+    katenary.io/component: http
+    katenary.io/release: '{{ .Release.Name }}'
+  ports:
+    - protocol: TCP
+      port: 80
+      targetPort: 80

examples/same-pod/chart/same-pod/values.yaml

@@ -0,0 +1,8 @@
+http:
+  image: nginx:alpine
+  ingress:
+    class: nginx
+    enabled: false
+    host: http.same-pod.tld
+php:
+  image: php:fpm

examples/same-pod/config/nginx/default.conf

@@ -0,0 +1,10 @@
+upstream _php {
+  server unix:/sock/fpm.sock;
+}
+server {
+  listen 80;
+  location ~ ^/index\.php(/|$) {
+    fastcgi_pass _php;
+    include fastcgi_params;
+  }
+}

examples/same-pod/config/php/www.conf

@@ -0,0 +1,17 @@
+[www]
+user = www-data
+group = www-data
+
+listen = /sock/fpm.sock
+
+pm = dynamic
+pm.max_children = 5
+pm.start_servers = 2
+pm.min_spare_servers = 1
+pm.max_spare_servers = 3
+
+access.log = /proc/self/fd/2
+log_limit = 8192
+clear_env = no
+catch_workers_output = yes
+decorate_workers_output = no

examples/same-pod/docker-compose.yaml

@@ -0,0 +1,38 @@
+version: "3"
+
+services:
+  
+  http:
+    image: nginx:alpine
+    ports:
+      - "8080:80"
+    volumes:
+      - "sock:/sock"
+      - "./config/nginx:/etc/nginx/conf.d:z"
+
+    labels:
+      # the "sock" volume will need to be shared to the same pod, so let's
+      # declare that this is not a PVC
+      katenary.io/empty-dirs: sock
+
+      # use ./config/nginx as a configMap
+      katenary.io/configmap-volumes: ./config/nginx
+
+      # declare an ingress
+      katenary.io/ingress: 80
+
+  php:
+    image: php:fpm
+    volumes:
+      - "sock:/sock"
+      - "./config/php/www.conf:/usr/local/etc/php-fpm.d/www.conf:z"
+    labels:
+      # fpm will need to use a unix socket shared
+      # with nginx (http service above), so we want here
+      # make a single pod containing nginx and php
+      katenary.io/same-pod: http
+      # use the ./config/php files as a configMap
+      katenary.io/configmap-volumes: ./config/php/www.conf
+
+volumes:
+  sock:

generator/main.go

@@ -403,11 +403,21 @@ func prepareVolumes(deployment, name string, s *compose.Service, container *helm
 			continue
 		}
 		if isCM {
+			// check if the volname path points on a file, if so, we need to add subvolume to the interface
+			stat, _ := os.Stat(volname)
+			pointToFile := ""
+			if !stat.IsDir() {
+				pointToFile = filepath.Base(volname)
+				volname = filepath.Dir(volname)
+			}
+
 			// the volume is a path and it's explicitally asked to be a configmap in labels
 			cm := buildCMFromPath(volname)
 			volname = strings.Replace(volname, "./", "", 1)
+			volname = strings.ReplaceAll(volname, "/", "-")
 			volname = strings.ReplaceAll(volname, ".", "-")
 			cm.K8sBase.Metadata.Name = RELEASE_NAME + "-" + volname + "-" + name
+
 			// build a configmap from the volume path
 			volumes = append(volumes, map[string]interface{}{
 				"name": volname,
@@ -415,10 +425,18 @@ func prepareVolumes(deployment, name string, s *compose.Service, container *helm
 					"name": cm.K8sBase.Metadata.Name,
 				},
 			})
+			if len(pointToFile) > 0 {
+				mountPoints = append(mountPoints, map[string]interface{}{
+					"name":      volname,
+					"mountPath": volepath,
+					"subPath":   pointToFile,
+				})
+			} else {
 				mountPoints = append(mountPoints, map[string]interface{}{
 					"name":      volname,
 					"mountPath": volepath,
 				})
+			}
 			ret <- cm
 		} else {
 			// rmove minus sign from volume name
@@ -432,6 +450,11 @@ func prepareVolumes(deployment, name string, s *compose.Service, container *helm
 						"name":     volname,
 						"emptyDir": map[string]string{},
 					})
+					mountPoints = append(mountPoints, map[string]interface{}{
+						"name":      volname,
+						"mountPath": volepath,
+					})
+					container.VolumeMounts = mountPoints
 					isEmptyDir = true
 					break
 				}