Merge pull request #119 from metal3d/develop

Develop

Makefile

@@ -4,7 +4,7 @@ VERSION=$(shell git describe --exact-match --tags $(CUR_SHA) 2>/dev/null || echo
 CTN:=$(shell which podman 2>&1 1>/dev/null && echo "podman" || echo "docker")
 PREFIX=~/.local
 
-GOVERSION=1.23
+GOVERSION=1.24
 GO=container
 OUT=katenary
 RELEASE=""
@@ -33,7 +33,7 @@ SHELL := bash
 .DELETE_ON_ERROR:
 MAKEFLAGS += --warn-undefined-variables
 MAKEFLAGS += --no-builtin-rules
-.PHONY: help clean build install tests test
+.PHONY: help clean build install tests test doc
 
 all: build
 
@@ -204,6 +204,11 @@ push-release: build-all
 	@rm -f release.id
 
 
+doc:
+	@echo "=> Generating documentation..."
+	# generate the labels doc and code doc
+	$(MAKE) __label_doc
+
 __label_doc:
 	@command -v gomarkdoc || (echo "==> We need to install gomarkdoc..." && \
 		go install github.com/princjef/gomarkdoc/cmd/gomarkdoc@latest)

doc/docs/labels.md

@@ -61,6 +61,7 @@ labels:
     - ./conf.d
 ```
 
+
 ### katenary.v3/cronjob
 
 Create a cronjob from the service.
@@ -70,7 +71,6 @@ Create a cronjob from the service.
 This adds a cronjob to the chart.
 
 The label value is a YAML object with the following attributes:
-
 - command: the command to be executed 
 - schedule: the cron schedule (cron format or @every where "every" is a 
   duration like 1h30m, daily, hourly...)
@@ -86,6 +86,7 @@ labels:
         schedule: "* */1 * * *" # or @hourly for example
 ```
 
+
 ### katenary.v3/dependencies
 
 Add Helm dependencies to the service.
@@ -132,6 +133,7 @@ labels:
           password: the secret password
 ```
 
+
 ### katenary.v3/description
 
 Description of the service
@@ -152,6 +154,7 @@ labels:
     It can be multiline.
 ```
 
+
 ### katenary.v3/env-from
 
 Add environment variables from antoher service.
@@ -177,6 +180,7 @@ service2:
         - myservice1
 ```
 
+
 ### katenary.v3/exchange-volumes
 
 Add exchange volumes (empty directory on the node) to share data
@@ -194,10 +198,9 @@ This will create:
 - a `initContainer` for each definition
 
 Fields:
-
-- name: the name of the volume (manadatory)
-- mountPath: the path where the volume is mounted in the pod (optional, default is `/opt`)
-- init: a command to run to initialize the volume with data (optional)
+  - name: the name of the volume (manadatory)
+  - mountPath: the path where the volume is mounted in the pod (optional, default is `/opt`)
+  - init: a command to run to initialize the volume with data (optional)
 
 !!! Warning
     This is highly experimental. This is mainly useful when using the "same-pod" label.
@@ -220,6 +223,7 @@ php:
         init: cp -ra /var/www/html/* /opt
 ```
 
+
 ### katenary.v3/health-check
 
 Health check to be added to the deployment.
@@ -239,6 +243,7 @@ labels:
         port: 8080
 ```
 
+
 ### katenary.v3/ignore
 
 Ignore the service
@@ -254,6 +259,7 @@ labels:
   katenary.v3/ignore: "true"
 ```
 
+
 ### katenary.v3/ingress
 
 Ingress rules to be added to the service.
@@ -272,6 +278,7 @@ labels:
     hostname: mywebsite.com (optional)
 ```
 
+
 ### katenary.v3/main-app
 
 Mark the service as the main app.
@@ -298,6 +305,7 @@ ghost:
     katenary.v3/main-app: true
 ```
 
+
 ### katenary.v3/map-env
 
 Map env vars from the service to the deployment.
@@ -325,6 +333,7 @@ labels:
     DB_HOST: '{{ include "__APP__.fullname" . }}-database'
 ```
 
+
 ### katenary.v3/ports
 
 Ports to be added to the service.
@@ -343,6 +352,7 @@ labels:
     - 8081
 ```
 
+
 ### katenary.v3/same-pod
 
 Move the same-pod deployment to the target deployment.
@@ -367,6 +377,7 @@ php:
     katenary.v3/same-pod: web
 ```
 
+
 ### katenary.v3/secrets
 
 Env vars to be set as secrets.
@@ -390,6 +401,7 @@ labels:
     - PASSWORD
 ```
 
+
 ### katenary.v3/values
 
 Environment variables to be added to the values.yaml
@@ -426,6 +438,7 @@ labels:
         It can be, of course,  a multiline text.
 ```
 
+
 ### katenary.v3/values-from
 
 Add values from another service.
@@ -463,4 +476,5 @@ php:
       DB_PASSWORD: database.MARIADB_PASSWORD
 ```
 
+
 <!-- STOP_DETAILED_DOC : do not remove this tag !-->