chore: Add Doc

.changelog/13.txt

@@ -0,0 +1,3 @@
+```release-note:enhancement
+`doc` - Add a technical/logical documentation section
+```

.gitignore

@@ -2,3 +2,4 @@ examples/
 bin/
 dist/
 config/manifests/mutatingWebhookConfiguration.yaml
+site/

README.md

@@ -32,7 +32,27 @@ Useful links:
 
 To quickly get started with the Kube Image Updater, you can use the following example:
 
-TODO
+```yaml
+apiVersion: kimup.cloudavenue.io/v1alpha1
+kind: Image
+metadata:
+  labels:
+    app.kubernetes.io/name: kube-image-updater
+    app.kubernetes.io/managed-by: kustomize
+  name: demo
+  namespace: default
+spec:
+  image: ghcr.io/orange-cloudavenue/kube-image-updater
+  baseTag: v0.0.19
+  triggers:
+    - type: crontab
+      value: "00 00 */12 * * *"
+  rules:
+    - name: Automatic update semver minor
+      type: semver-minor
+      actions:
+        - type: apply
+```
 
 ## Contributing
 

config/manifests/image.yaml

@@ -0,0 +1,19 @@
+apiVersion: kimup.cloudavenue.io/v1alpha1
+kind: Image
+metadata:
+  labels:
+    app.kubernetes.io/name: kube-image-updater
+    app.kubernetes.io/managed-by: kustomize
+  name: demo
+  namespace: default
+spec:
+  image: ghcr.io/azrod/golink
+  baseTag: v0.0.19
+  triggers:
+    - type: crontab
+      value: "00 00 */12 * * *"
+  rules:
+    - name: Automatic update semver minor
+      type: semver-minor
+      actions:
+        - type: apply

config/manifests/mutatingWebhookConfiguration.yaml

@@ -16,7 +16,7 @@ webhooks:
       #   path: /mutate
       #   port: 8443
       # CA certificate with BEGIN and END lines - base64 encoded
-      caBundle: "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUZFekNDQXZ1Z0F3SUJBZ0lDQitZd0RRWUpLb1pJaHZjTkFRRUxCUUF3R3pFWk1CY0dBMVVFQ2hNUWVXOTEKY2k1bGVHRnRjR3hsTG1OdmJUQWVGdzB5TkRBNU1qY3dPVEV5TURsYUZ3MHlOVEE1TWpjd09URXlNRGxhTUJzeApHVEFYQmdOVkJBb1RFSGx2ZFhJdVpYaGhiWEJzWlM1amIyMHdnZ0lpTUEwR0NTcUdTSWIzRFFFQkFRVUFBNElDCkR3QXdnZ0lLQW9JQ0FRQytmTjl6VTRHRXBpZXZ0S2Q1SnVnOE5sSFozNVdHcUp6MG5lSmo2dGpBK2Jkbjd3UmUKTHQ3STBQMk1Ta2hDWExqa2s3WmZqREtveEdlVGNZdzdYejI0UVVyR0J2Y3RpcFpJVWh6QkVmbVdYWWk3SlduUgpWSTRVMEw5cWFiclJZTTJ1am5Rc3RVTk9wS2U4Q1M3dStsNFNvMzFxNXFIRFF4dUJjTUJBS1YrbWs2V0JCWWU5CitNeDlWS1hLbFkrbUZBVU55NUFRaXFhRUcxQWE4Y3pZaGdMQTljdHBBWkNQWnF1a2twVUhiRzUvMWI4VVpZUHoKY2ZDcUNQTE8vd2dqbjN1R2ZqdCtFamZCRUdHZUJTU0xDdERhQVdMazlQUmxyZmdhOURJZ0Z0VTJwK3kxc0hLcgpBd0F3bG0zRG1CVEpNYWQ3Tks5TnloSmFRaXF4bVZ2QkgwdXRMSGpjdlRHNTlreDBWSmhhYjVVWVZKNFh2TmRYCjZRS2Rzc1Jldmd1TWo2VlJYd0RKcWtyTS9YRmdqcUJrVTUzSUQ1MlhXa3BUSHRQWTZkeWdrNmM4VkdFNjR6VnkKYWc5b2FIMzltT2piUmxFbG9hMGpnR0ltdTdiUUk4a3QrWjhiOVZRUWl4eTlvOTRRVmlYSVU0RUc0N2RaZUhQbwpMaXByZXNkdDJ0cDJwY2NPbDR0eUZUenNaRkVNK29PQ052MzlzTXc0bUI0dVRyd1V5MDA1d0FsVjJqTkxyN1Q0CjVYK3RtSGwvOXpLZnJmckxCbEJqN2lESytlTWNyaXM0SDVMdGx1dm9QWHBhZk4vMk9wTUY4MGxJd2ZDV01WdTEKSXpJS2kxWXhWSnBiR3VBOTduampZY0FZY1BWMExZYmNYc0s1UVNFeE1ZcXJQSHlsSEpROUtaUHJud0lEQVFBQgpvMkV3WHpBT0JnTlZIUThCQWY4RUJBTUNBb1F3SFFZRFZSMGxCQll3RkFZSUt3WUJCUVVIQXdJR0NDc0dBUVVGCkJ3TUJNQThHQTFVZEV3RUIvd1FGTUFNQkFmOHdIUVlEVlIwT0JCWUVGSms3SjQySER0Q0FMVjRtTlNrTGlsdkYKWjFReU1BMEdDU3FHU0liM0RRRUJDd1VBQTRJQ0FRQlVvSlg3bGlmQ2UrM3FuMWhpTzY0MStLZm9iM3N6V3F0bwp4eUdvZU5IRU03S2d2dDNBdkNpSWg1b0Z2SXc4Tlc4Zjh1N2ltUk1UZ1BoaEJrTWZZckJrSU9JK2VtaUpwZStlCm9Hck0xWFlTQXJ1ZitKalpuOVNPY2I0Mlpnb1NCeHI2cVdNMDdpZm9lU2E4YmJwbEh3Y085SDFJWU1TRWsxazQKdnd1Z2RaNjlIOVp1N3hvaHRRODVwZEpUcWw1Z3laSi9xMno0YnNUSSthMWdRM29OQzE0QVJXVnZtRU5xTTdZbgp4eGNGOWV4UWRMUUdoVnpveUFVZ2RkZlB6YjVXVG5vVHBOTThEdVdmMHdSUTE0b2JOdXduUGpUNFF6ekI2VlIxCkVjdjFWeUpYVlVxNGlGRldBQTBEbmI2MnhoekFtMjN2c0dOMGJjUHR6K3h4V3BpN2JJYi9FcklGTytIYXE2UVcKVUlSVXVjckZOeExYZlZuR3RWRkpGSjI1NlFHdW11L21DSUdwckl1TTVsRTFjc0VJWWNUKzdyNm5CemZyWVMzbAp0TC9GeFhqWjJvekdNaHNyNTZMN2x6SjNiZkJZSzJ0eHlPakxKdWQ1L04zSWxiS2Nna0YvSnZYYnZyam0yWUMxCitsd1d4TUxxbjhqenl3YnlveDQvRUgxVXR0Tm8xK3U2WFAzWmpCU2pkUTErYmMzZktsUGgwWTNMaVlzWm5JYlEKN3BPRjFiRTR5OWxoSHpweFBObWwrTHN2SmVyQzlWV0ZYcUg3d2lUOXBaRE5QaEdWTTNFMEFJbENZSFZBV1F0TQpBV1ZNSVpyeVFpb0JFNTdMaFNCeVJFdGxkYkVnbEpIWTQ0cFFmOFUxL2dvb3VKcW1sbmdyejI0YWduL2Y0UW1ZCjZSd08wTUtDZHc9PQotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg=="
+      caBundle: "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUZFekNDQXZ1Z0F3SUJBZ0lDQitZd0RRWUpLb1pJaHZjTkFRRUxCUUF3R3pFWk1CY0dBMVVFQ2hNUWVXOTEKY2k1bGVHRnRjR3hsTG1OdmJUQWVGdzB5TkRBNU1qY3hNalExTWpoYUZ3MHlOVEE1TWpjeE1qUTFNamhhTUJzeApHVEFYQmdOVkJBb1RFSGx2ZFhJdVpYaGhiWEJzWlM1amIyMHdnZ0lpTUEwR0NTcUdTSWIzRFFFQkFRVUFBNElDCkR3QXdnZ0lLQW9JQ0FRQzNKeW1LNjF0UEJQUVJJL013MldwekZlckpwN3YwWFFsK0tuc1N2ak5NWFUrNXJDWTEKb1J1cUwzVkxNQnN4ZXl3SlVxZ3k3dllJWFZOOFZMT0xKS2VDem9ybUE5dVlVb3czRE9sTzQwMGFuOEFNS0wzUAovWHl3VGltRUJqYXU1WHRRVXRRU1FodG9GRmpTUWRGdVlya1Q5Y0YwKzEzRmdSOEJ5eGN3WUQ3RTU1K3RZWUJUCktmMWdZblNBTzJmWkpybUxTWHpzYjBSS0F2N3lXQVpkd2ZZNCtNSDlMQUFjNzNVSzhOUjZVeStia2k0WXNQSFEKdDMxUXpWR1h4UlJGclFkUS9ER1hFVGRRbVhVdjlRc3dvd2tMM1BYZllrdmE5VmQ2cWVZYTBZMlEyVWtyTG5DdwpoODRONlpWbVB5UjBYemVWOTY3NmNTTm83Nk4wQVFJNmhPTi9BL1lYei9LMXdHTWxYd0RWQ29tMDl4V0hzODYzCkZHSDQ2S0EzZDZMZ0doZFhaYkUzSndzWkorakh5UDZIZ2N3NHQ2a1pBc0MrQ0wzYS9uZGptYmZzc3RITVRhaHoKS1BpaWY5elNOejd1TVIyb29IeXg0VHlEaGZFLzFRWDRhL00rLzFSM0hidU54SWlnQzVKY3hRZ2hFaVhPczdZQQpNU2VrYVZnOTM4YWF2Ymx3NzI2ZHBvVzJNZFk2K29VMGxhUnAyUnVxQTB4U2RGMlZ1N1h0NHBLdlpPZzlxejAxCno1blVYa0lZTUtyd2hrWi9ZVW9UNEVZN0JiN3VSYmJZOGpvWnA2aS9tWWx6NnJGVjdBaFBGelJydWZaa3JHeTkKV1ZVanVySVZqTVpWb1dvOVdsTnNReTI3K1hDQnltOW1WdG4wOEdwczkzcTY0UTFCaFIwMjFZU25aUUlEQVFBQgpvMkV3WHpBT0JnTlZIUThCQWY4RUJBTUNBb1F3SFFZRFZSMGxCQll3RkFZSUt3WUJCUVVIQXdJR0NDc0dBUVVGCkJ3TUJNQThHQTFVZEV3RUIvd1FGTUFNQkFmOHdIUVlEVlIwT0JCWUVGQ1RrV0VBZzBnd3lQam5aRml6SHdZa04KZGVrak1BMEdDU3FHU0liM0RRRUJDd1VBQTRJQ0FRQnVGazJWMEJjN2VVdDFEZmM2czFoRklLL1QwZEpYSVFveQplSXovZEVhaTRxdlNiVks1a2RjcUowQmdabWk4dkY4Uk5FeW5xNXUrNVNHek5TSzMxWDA5dEZuOXhMOXNkWHJ6CmY0TW5ia3VFb3dLMFZUUzRDWXFKREVQVHZjc1dYZjd1VXhGaThCbi81T29xNm9qUjIvUllCTEtjQXp1emVIYksKM3BSWXNRbEJDZ0RQUVRvRCthRWhFVXcwbUlqc1pSQ2F6ZWwwNmpBaTFBWHJyM3duWDM0VlhPOHVYbnpJNGI0YQpxSUtDaHFMcjdNNEpmTnZaVXUzWnlXYkZOREVVNDFQWWVqNVpFOEdLV0xOYStta2xXb3ovdkV0QUh3c254Ull1ClFrOGphdktRYkVCY2QzK0I1a1NwODh1Q1NxeDdPeHMxTEw0S2orODZYR05iejNnNFpUU0F5UWlaaEVSSERrQ0gKKzNhVFhURlNpbWtZRmZ3NWptVWtpUDdXUU1zODJkRmV4OXh6Lzl2aTB6MFQya3M5UWpTTXBqaWR2Nk1UenpvYgpNOXdKcVMwVnUxU2RTWE9iN2wyM1d6NnlGZ01FZGN4NzhxakFaOFNuNnE2dVJrdnB4RnZrZHpjR1NKVlY2UXlhCm9yVm8rYkpJdEhUQ3Z3T1ZqR00vWEhReHAvb2c1MHN6ZzZKSUN5MXB1TnFZaUFtWitXSENIWmtNdTluRHl1alUKTnF4TDliZi9wMkI1b3hDa0xRSUpLcW9jd0NCYmx3UCs0d2NLQnNQcGZuelVIZUdaOGlXN1BpNStZZE1idHR0NwpMYjJKT0g3NTdIcnRaTFFlSUtsRE1FZnNKbWNnU2pVMHZiemhITDFEaHVtQ1hzQzBETXltQkhJbG1pZkFEbFRNCm44TWVrQ2lBWWc9PQotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg=="
     rules:
       - operations: [ "CREATE", "UPDATE"]
         apiGroups: [""]

docs/howto.md

@@ -0,0 +1,90 @@
+# HowTo
+
+## How to Use
+
+1 - Create an `Image` resource:
+
+```yaml
+apiVersion: kimup.cloudavenue.io/v1alpha1
+kind: Image
+metadata:
+  labels:
+    app.kubernetes.io/name: kube-image-updater
+    app.kubernetes.io/managed-by: kustomize
+  name: demo
+  namespace: default
+spec:
+  image: ghcr.io/orange-cloudavenue/kube-image-updater
+  baseTag: v0.0.19
+  triggers:
+    - type: crontab
+      value: "00 00 */12 * * *"
+  rules:
+    - name: Automatic update semver minor
+      type: semver-minor
+      actions:
+        - type: apply
+```
+
+2 - Apply the `Image` resource:
+
+```bash
+kubectl apply -f image.yaml
+```
+In this example the image `ghcr.io/orange-cloudavenue/kube-image-updater` will be updated every 12 hours with the latest minor version.
+
+3 - Check the Image TAG:
+
+```bash
+kubectl get image demo'
+
+NAME   IMAGE                  TAG
+demo   ghcr.io/azrod/golink   
+```
+But you can force the update by running the following command:
+
+```bash
+kubectl annotate image demo kimup.cloudavenue.io/action=refresh
+```
+
+The Image TAG is now updated:
+
+```bash
+NAME   IMAGE                  TAG
+demo   ghcr.io/azrod/golink   v0.1.0
+```
+
+4 - Make a deployment with the image:
+
+```yaml
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: golink
+  namespace: default
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app: golink
+  template:
+    metadata:
+      labels:
+        app: golink
+    spec:
+      containers:
+        - name: golink
+          image: ghcr.io/azrod/golink
+          ports:
+            - containerPort: 8080
+```
+
+5 - Apply the deployment:
+
+```bash
+kubectl apply -f deployment.yaml
+```
+
+Now the deployment is running with the image `ghcr.io/azrod/golink:v0.1.0` define by your rules in the CRD `Image`.
+
+

docs/index.md

@@ -13,7 +13,17 @@ hide:
 
 **kube-image-updater** (A.K.A. **kimup**, which is pronounced /kim up/) is a tool that helps you to update the image of a Kubernetes Deployment, StatefulSet, DaemonSet, or CronJob. It can be used to update the image of a single resource or multiple resources at once.
 
-kimup is designed to be simple to use and easy to deploy. It is an kubernetes operator with custom resource definition (CRD) that allows you to define the image update strategy and schedule.
+**kimup** is designed to be simple to use and easy to deploy. It is an kubernetes operator with custom resource definition (CRD) that allows you to define the image update strategy and schedule.
+
+The project is composed of 3 main components:
+**kimup-operator:**
+:     The main component that reconcile `Image` and CRD definition.
+
+**kimup:**
+:     The component that updates TAG of the `Image` resource.
+
+**kimup-webhook:**
+:     The component that patch resource creation with rules defined in `Image` resource.
 
 Basic example of usage:
 
@@ -46,3 +56,25 @@ It is structured around the following concepts:
 - **Triggers**: define when the image should be updated. (Multiple triggers can be defined)
 - **Rules**: define how the image should be updated. (Multiple rules can be defined)
 - **Actions**: define what should be done after the image is updated (rule matched). (Multiple actions can be defined)
+
+## Features
+
+- **baseTag**: version of the image to update and on which we will apply the rules.
+
+Type of **Triggers**:
+
+- **crontab**: Update the image based on a crontab schedule.
+
+Type of **Rules**:
+
+- **semver-major**: Update the major version of the image.
+- **semver-minor**: Update the minor version of the image.
+- **semver-patch**: Update the patch version of the image.
+- **regex**: Update the image based on a regex pattern.
+
+Type of **Actions**:
+
+- **refresh**: Apply the new image to the resource.
+- **notify**: Notify a webhook with the new image.(Not implemented yet)
+- **request-approval**: Request approval to apply the new image.(Not implemented yet)
+

docs/install.md

@@ -0,0 +1,27 @@
+# Install
+
+## How to Install (In Development...)
+
+1 - **Install the CRD:**
+
+Git clone project and run the following command:
+```bash
+kubectl apply -f config/crd/bases/kimup.cloudavenue.io_images.yaml
+```
+
+2 - Start all services:
+
+For Operator
+```bash
+make run-operator
+```
+
+For Webhook
+```bash
+go run ./cmd/webhook --insideCluster=false
+```
+
+For kimup
+```bash
+go run ./cmd/kimup --insideCluster=false
+```

mkdocs.yml

@@ -42,6 +42,9 @@ plugins:
 
 nav:
   - Overview: "index.md"
+  - Getting Started:
+    - Installation: install.md
+    - Howto: howto.md
 
 markdown_extensions:
   # Python Markdown
@@ -76,7 +79,6 @@ markdown_extensions:
       custom_checkbox: true
   - pymdownx.tilde
 
-
 extra:
   social:
     - icon: fontawesome/brands/github