[FR] Helm Chart #243

deploy/kubernetes/Makefile

@@ -0,0 +1,26 @@
+SHELL := /bin/bash
+
+check-helm:
+	@helm version || $(MAKE) install-helm
+
+check-kubectl:
+	@kubectl version || $(MAKE) install-kubectl
+
+install-helm:
+	@curl -fsSL -o get_helm.sh https://raw.github.com/helm/helm/main/scripts/get-helm-3
+	@chmod 700 get_helm.sh
+	@./get_helm.sh
+	@rm get_helm.sh
+
+install-kubectl:
+	@curl -LO 'https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl'
+	@sudo install -o root -g root -m 0755 kubectl /usr/local/bin/kubectl
+	@rm kubectl
+
+install-iris:
+	@helm upgrade --install iris charts/ --values charts/values.yaml -n <name_space>
+
+delete-iris:
+	@helm delete iris -n <name_space>
+
+check-dependencies: check-helm check-kubectl

deploy/kubernetes/README.md

@@ -0,0 +1,125 @@
+# Prerequisites    
+- Kubernetes cluster must be on the running stage (Kubernetes 1.26+)     
+- Helm 3.1.0      
+
+# Installing the Charts    
+
+## Installing Nginx Ingress Controller 
+
+The Ingress is a Kubernetes resource that lets you configure an HTTP load balancer for applications running on Kubernetes, represented by one or more Services. Such a load balancer is necessary to deliver those applications to clients outside of the Kubernetes cluster
+
+The Ingress resource supports the following features:
+
+⦿  Content-based routing:
+
+- `Host-based routing:` For example, routing requests with the host header foo.example.com to one group of services and the host header bar.example.com to another group.
+
+- `Path-based routing:` For example, routing requests with the URI that starts with /serviceA to service A and requests with the URI that starts with /serviceB to service B.
+
+⦿ **TLS/SSL** termination for each hostname, such as foo.example.com.
+
+Before installing Iris-web install the Nginx ingress controller
+```
+helm repo add ingress-nginx https://kubernetes.github.io/ingress-nginx
+helm install my-release ingress-nginx/ingress-nginx -n <Name_Space>
+```
+> **Info**: `my-release` is the name that you choose
+
+## Installing Iris Web
+
+Clone this Repository       
+```bash     
+$ git clone https://github.com/dfir-iris/iris-web.git      
+```      
+
+
+To install the chart with the release name `my-release`:      
+```bash    
+$ helm install my-release charts/ --values charts/values.yaml  -n <Name_Space>  
+```      
+The command deploys **iris-web** on the Kubernetes cluster in the default configuration.  
+
+## Checking Dependencies
+
+To check if Helm and kubectl are installed, run the following command:
+
+```
+make check-dependencies
+```
+If any of the dependencies are missing, the corresponding installation command will be executed automatically.
+
+## Installing Iris
+To install Iris, run the following command:
+```
+make install-iris
+```
+
+This will upgrade or install the Iris application using Helm. The installation uses the provided charts/values.yaml file and installs it in the specified namespace.
+
+Replace `<name_space>` with the desired namespace for the Iris application.
+
+## Deleting Iris
+To delete the Iris application, run the following command:
+```
+make delete-iris
+```
+This will delete the Iris application using Helm. The application will be removed from the specified namespace.
+
+Replace `<name_space>` with the namespace where the Iris application is installed.
+
+> **Tip**: List all releases using `helm list`  
+
+# Uninstalling the Charts    
+
+To uninstall/delete the `my-release` deployment:      
+
+The command removes all the Kubernetes components associated with the chart and deletes the release.      
+
+```bash     
+$ helm delete my-release -n <Name_Space>   
+``` 
+# Parameters    
+The [Parameters](#parameters) section lists the parameters that can be configured during installation.
+
+### Common parameters       
+| Name | Description | Value |     
+| --| -- | -- |     
+| `replicaCount` | Number of Iris replicas to deploy | `1` |     
+
+
+### Lable parameters
+| Name | Description | Value |     
+| --| -- | -- |     
+| `app` | Define metadata app name	 | `string` |  
+| `name` | Define lables name		 | `string` | 
+
+
+### Image parameters     
+Using Dockerfile or Docker compose create images for Iris and apply image to their respective yaml file.
+> **Note**: For kubernetes  use modified Dockerfile.k8s file to create an images
+
+| Name | Description | Value |      
+| --| -- | -- |      
+| `image.repository` | Iris image repository | `string` |       
+| `image.tag` | Iris image tag  | `latest` |        
+| `image.pullPolicy` | Iris image pull policy | `string` |       
+
+
+### Service parameters
+| Name | Description | Value |     
+| --| -- | -- |     
+| `service.type` | Iris service type | `LoadBalancer`|     
+| `service.port` | Iris service port | `80` |       
+
+## Ingress parameters
+| Name | Description | Value |     
+| --| -- | -- |     
+| `host_name` | Hostname for Iris app | `string`|     
+
+## How to expose the application?
+
+List the Ingress resource on the Kubernetes cluster
+```
+kubectl get ingress -n <Name_Space>
+```
+Expose the application with your Hostname

deploy/kubernetes/TODO.md

@@ -0,0 +1,11 @@
+### Todo
+
+- [ ] ArtifactHub configuration
+
+### In Progress  
+
+- [ ] ArtifactHub configuration
+
+### Done ✓  
+
+- [ ] ArtifactHub configuration

deploy/kubernetes/charts/Chart.yaml

@@ -0,0 +1,24 @@
+apiVersion: v2
+name: iris-web
+description: A Helm chart for Iris Web 
+
+# A chart can be either an 'application' or a 'library' chart.
+#
+# Application charts are a collection of templates that can be packaged into versioned archives
+# to be deployed.
+#
+# Library charts provide useful utilities or functions for the chart developer. They're included as
+# a dependency of application charts to inject those utilities and functions into the rendering
+# pipeline. Library charts do not define any templates and therefore cannot be deployed.
+type: application
+
+# This is the chart version. This version number should be incremented each time you make changes
+# to the chart and its templates, including the app version.
+# Versions are expected to follow Semantic Versioning (https://semver.org/)
+version: 0.1.0
+
+# This is the version number of the application being deployed. This version number should be
+# incremented each time you make changes to the application. Versions are not expected to
+# follow Semantic Versioning. They should reflect the version the application is using.
+# It is recommended to use it with quotes.
+appVersion: "1.16.0"

deploy/kubernetes/charts/templates/NOTES.txt

@@ -0,0 +1,28 @@
+Release Name: {{ .Release.Name }}
+Chart Name: {{ .Chart.Name }}
+Chart Version: {{ .Chart.Version }}
+Chart Description: {{ .Chart.Description }}
+
+The following Kubernetes resources have been deployed:
+
+{{- if .Values.ingress.enabled }}
+Ingress:
+- Name: {{ .Release.Name }}-ingress
+  Host: {{ index .Values.ingress.hosts 0 "host" }}
+  Path: {{ index .Values.ingress.hosts 0 "paths" 0 "path" }}
+  Service Name: {{ index .Values.ingress.hosts 0 "paths" 0 "serviceName" }}
+  Service Port: {{ index .Values.ingress.hosts 0 "paths" 0 "servicePort" }}
+{{- end }}
+
+{{- if eq .Values.ingress.enabled true }}
+To access your application, ensure that the necessary configurations are set up in your cluster.
+
+- If you have DNS set up:
+  - Access your application using the configured domain: http://{{ index .Values.ingress.hosts 0 "host" }}
+{{- else }}
+No Ingress resources deployed.
+{{- end }}
+
+Ensure that your application service ({{ index .Values.ingress.hosts 0 "paths" 0 "serviceName" }}) is up and running on port {{ index .Values.ingress.hosts 0 "paths" 0 "servicePort" }}.
+
+Happy exploring!

deploy/kubernetes/charts/templates/_helpers.tpl

@@ -0,0 +1,62 @@
+{{/*
+Expand the name of the chart.
+*/}}
+{{- define "iris-web.name" -}}
+{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }}
+{{- end }}
+
+{{/*
+Create a default fully qualified app name.
+We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
+If release name contains chart name it will be used as a full name.
+*/}}
+{{- define "iris-web.fullname" -}}
+{{- if .Values.fullnameOverride }}
+{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }}
+{{- else }}
+{{- $name := default .Chart.Name .Values.nameOverride }}
+{{- if contains $name .Release.Name }}
+{{- .Release.Name | trunc 63 | trimSuffix "-" }}
+{{- else }}
+{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" }}
+{{- end }}
+{{- end }}
+{{- end }}
+
+{{/*
+Create chart name and version as used by the chart label.
+*/}}
+{{- define "iris-web.chart" -}}
+{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
+{{- end }}
+
+{{/*
+Common labels
+*/}}
+{{- define "iris-web.labels" -}}
+helm.sh/chart: {{ include "iris-web.chart" . }}
+{{ include "iris-web.selectorLabels" . }}
+{{- if .Chart.AppVersion }}
+app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
+{{- end }}
+app.kubernetes.io/managed-by: {{ .Release.Service }}
+{{- end }}
+
+{{/*
+Selector labels
+*/}}
+{{- define "iris-web.selectorLabels" -}}
+app.kubernetes.io/name: {{ include "iris-web.name" . }}
+app.kubernetes.io/instance: {{ .Release.Name }}
+{{- end }}
+
+{{/*
+Create the name of the service account to use
+*/}}
+{{- define "iris-web.serviceAccountName" -}}
+{{- if .Values.serviceAccount.create }}
+{{- default (include "iris-web.fullname" .) .Values.serviceAccount.name }}
+{{- else }}
+{{- default "default" .Values.serviceAccount.name }}
+{{- end }}
+{{- end }}

deploy/kubernetes/charts/templates/iris_app.yaml

@@ -0,0 +1,85 @@
+---
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: {{ .Values.irisapp.name }}
+spec:
+  replicas: {{ .Values.irisapp.replicaCount }}
+  selector:
+    matchLabels:
+      app: {{ .Values.irisapp.app }}
+  template:
+    metadata:
+      labels:
+        app: {{ .Values.irisapp.app }}
+    spec:
+      containers:
+        - name: {{ .Values.irisapp.name }}
+          image: "{{ .Values.irisapp.image}}:{{ .Values.irisapp.tag }}"
+          imagePullPolicy: "{{ .Values.irisapp.imagePullPolicy }}"
+          command: ['nohup', './iris-entrypoint.sh', 'iriswebapp']
+
+          env:
+
+          - name: DOCKERIZED  # Setting Database name 
+            value: {{ .Values.irisapp.DOCKERIZED | quote }}
+
+          - name: POSTGRES_USER  # Setting Database username 
+            value: {{ .Values.irisapp.POSTGRES_USER| quote }}
+
+          - name:  POSTGRES_PASSWORDD # Setting Database password 
+            value: {{ .Values.irisapp.POSTGRES_PASSWORD | quote }}
+
+          - name:  POSTGRES_ADMIN_USER # Setting Database admin user 
+            value: {{ .Values.irisapp.POSTGRES_ADMIN_USER | quote }}
+
+          - name:  POSTGRES_ADMIN_PASSWORD # Setting Database admin password 
+            value: {{ .Values.irisapp.POSTGRES_ADMIN_PASSWORD | quote }}    
+
+          - name:  POSTGRES_PORT # Setting Database port
+            value: {{ .Values.irisapp.POSTGRES_PORT | quote }}   
+
+          - name:  POSTGRES_SERVER # Setting Database server
+            value: {{ .Values.irisapp.POSTGRES_SERVER | quote }}  
+
+          - name:  IRIS_SECRET_KEY 
+            value: {{ .Values.irisapp.IRIS_SECRET_KEY | quote }}
+
+          - name:  IRIS_SECURITY_PASSWORD_SALT 
+            value: {{ .Values.irisapp.IRIS_SECURITY_PASSWORD_SALT | quote }}         
+
+
+          ports:
+            - containerPort: 8000
+
+          volumeMounts:
+            - mountPath: /home/iris/downloads
+              name: iris-downloads  
+            - mountPath: /home/iris/user_templates
+              name: user-templates
+            - mountPath: /home/iris/server_data
+              name: server-data
+      volumes:
+        - name: iris-downloads
+          emptyDir: {}  
+        - name: user-templates
+          emptyDir: {}
+        - name: server-data 
+          emptyDir: {}
+
+---
+
+apiVersion: v1
+kind: Service
+metadata:
+  name: {{ .Values.irisapp.name }}
+  labels:
+    app: {{ .Values.irisapp.app }}
+spec:
+  type: {{ .Values.irisapp.type }}
+  ports:
+   - port: {{ .Values.irisapp.service.port }}
+     targetPort: {{ .Values.irisapp.service.targetPort }}
+  selector:
+   app: {{ .Values.irisapp.app }}
+---