From 9a2aa8749ae69a227fb3b473622da0f15178e192 Mon Sep 17 00:00:00 2001 From: Mair nousH Date: Thu, 27 Mar 2025 16:48:10 +0100 Subject: [PATCH 1/2] feat: implemented helm chart for keyDB --- xtuple/.helmignore | 23 ++++ xtuple/Chart.yaml | 24 ++++ xtuple/templates/NOTES.txt | 22 ++++ xtuple/templates/_helpers.tpl | 62 ++++++++++ xtuple/templates/agent_deployment.yaml | 19 +++ xtuple/templates/configmap.yaml | 6 + xtuple/templates/deployment.yaml | 78 ++++++++++++ xtuple/templates/hpa.yaml | 32 +++++ xtuple/templates/ingress.yaml | 43 +++++++ xtuple/templates/keydb-deployment.yaml | 32 +++++ xtuple/templates/service.yaml | 15 +++ xtuple/templates/serviceaccount.yaml | 13 ++ xtuple/templates/tests/test-connection.yaml | 15 +++ xtuple/values.yaml | 130 ++++++++++++++++++++ 14 files changed, 514 insertions(+) create mode 100644 xtuple/.helmignore create mode 100644 xtuple/Chart.yaml create mode 100644 xtuple/templates/NOTES.txt create mode 100644 xtuple/templates/_helpers.tpl create mode 100644 xtuple/templates/agent_deployment.yaml create mode 100644 xtuple/templates/configmap.yaml create mode 100644 xtuple/templates/deployment.yaml create mode 100644 xtuple/templates/hpa.yaml create mode 100644 xtuple/templates/ingress.yaml create mode 100644 xtuple/templates/keydb-deployment.yaml create mode 100644 xtuple/templates/service.yaml create mode 100644 xtuple/templates/serviceaccount.yaml create mode 100644 xtuple/templates/tests/test-connection.yaml create mode 100644 xtuple/values.yaml diff --git a/xtuple/.helmignore b/xtuple/.helmignore new file mode 100644 index 0000000..0e8a0eb --- /dev/null +++ b/xtuple/.helmignore @@ -0,0 +1,23 @@ +# Patterns to ignore when building packages. +# This supports shell glob matching, relative path matching, and +# negation (prefixed with !). Only one pattern per line. +.DS_Store +# Common VCS dirs +.git/ +.gitignore +.bzr/ +.bzrignore +.hg/ +.hgignore +.svn/ +# Common backup files +*.swp +*.bak +*.tmp +*.orig +*~ +# Various IDEs +.project +.idea/ +*.tmproj +.vscode/ diff --git a/xtuple/Chart.yaml b/xtuple/Chart.yaml new file mode 100644 index 0000000..6395a16 --- /dev/null +++ b/xtuple/Chart.yaml @@ -0,0 +1,24 @@ +apiVersion: v2 +name: xtuple +description: A Helm chart for Kubernetes + +# 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" diff --git a/xtuple/templates/NOTES.txt b/xtuple/templates/NOTES.txt new file mode 100644 index 0000000..ec70e7a --- /dev/null +++ b/xtuple/templates/NOTES.txt @@ -0,0 +1,22 @@ +1. Get the application URL by running these commands: +{{- if .Values.ingress.enabled }} +{{- range $host := .Values.ingress.hosts }} + {{- range .paths }} + http{{ if $.Values.ingress.tls }}s{{ end }}://{{ $host.host }}{{ .path }} + {{- end }} +{{- end }} +{{- else if contains "NodePort" .Values.service.type }} + export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "xtuple.fullname" . }}) + export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}") + echo http://$NODE_IP:$NODE_PORT +{{- else if contains "LoadBalancer" .Values.service.type }} + NOTE: It may take a few minutes for the LoadBalancer IP to be available. + You can watch its status by running 'kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "xtuple.fullname" . }}' + export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "xtuple.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}") + echo http://$SERVICE_IP:{{ .Values.service.port }} +{{- else if contains "ClusterIP" .Values.service.type }} + export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "xtuple.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}") + export CONTAINER_PORT=$(kubectl get pod --namespace {{ .Release.Namespace }} $POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}") + echo "Visit http://127.0.0.1:8080 to use your application" + kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 8080:$CONTAINER_PORT +{{- end }} diff --git a/xtuple/templates/_helpers.tpl b/xtuple/templates/_helpers.tpl new file mode 100644 index 0000000..431dca6 --- /dev/null +++ b/xtuple/templates/_helpers.tpl @@ -0,0 +1,62 @@ +{{/* +Expand the name of the chart. +*/}} +{{- define "xtuple.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 "xtuple.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 "xtuple.chart" -}} +{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }} +{{- end }} + +{{/* +Common labels +*/}} +{{- define "xtuple.labels" -}} +helm.sh/chart: {{ include "xtuple.chart" . }} +{{ include "xtuple.selectorLabels" . }} +{{- if .Chart.AppVersion }} +app.kubernetes.io/version: {{ .Chart.AppVersion | quote }} +{{- end }} +app.kubernetes.io/managed-by: "Helm" +{{- end }} + +{{/* +Selector labels +*/}} +{{- define "xtuple.selectorLabels" -}} +app.kubernetes.io/name: {{ include "xtuple.name" . }} +app.kubernetes.io/instance: {{ .Release.Name }} +{{- end }} + +{{/* +Create the name of the service account to use +*/}} +{{- define "xtuple.serviceAccountName" -}} +{{- if .Values.serviceAccount.create }} +{{- default (include "xtuple.fullname" .) .Values.serviceAccount.name }} +{{- else }} +{{- default "default" .Values.serviceAccount.name }} +{{- end }} +{{- end }} diff --git a/xtuple/templates/agent_deployment.yaml b/xtuple/templates/agent_deployment.yaml new file mode 100644 index 0000000..b512fd9 --- /dev/null +++ b/xtuple/templates/agent_deployment.yaml @@ -0,0 +1,19 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + name: xtuples-agent +spec: + replicas: 1 + selector: + matchLabels: + app: xtuples-agent + template: + metadata: + labels: + app: xtuples-agent + spec: + containers: + - name: xtuples-agent + image: {{ .Values.image.agent.repository }}:{{ .Values.image.agent.tag }} + ports: + - containerPort: 80 diff --git a/xtuple/templates/configmap.yaml b/xtuple/templates/configmap.yaml new file mode 100644 index 0000000..be6b9ac --- /dev/null +++ b/xtuple/templates/configmap.yaml @@ -0,0 +1,6 @@ +apiVersion: v1 +kind: ConfigMap +metadata: + name: {{ .Release.Name }}-configmap +data: + imageNameOverride: {{ .Values.image.jobs.repository | quote }} \ No newline at end of file diff --git a/xtuple/templates/deployment.yaml b/xtuple/templates/deployment.yaml new file mode 100644 index 0000000..696e8ac --- /dev/null +++ b/xtuple/templates/deployment.yaml @@ -0,0 +1,78 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + name: {{ include "xtuple.fullname" . }} + labels: + {{- include "xtuple.labels" . | nindent 4 }} +spec: + {{- if not .Values.autoscaling.enabled }} + replicas: {{ .Values.replicaCount }} + {{- end }} + selector: + matchLabels: + {{- include "xtuple.selectorLabels" . | nindent 6 }} + template: + metadata: + {{- with .Values.podAnnotations }} + annotations: + {{- toYaml . | nindent 8 }} + {{- end }} + labels: + {{- include "xtuple.labels" . | nindent 8 }} + {{- with .Values.podLabels }} + {{- toYaml . | nindent 8 }} + {{- end }} + spec: + {{- with .Values.imagePullSecrets }} + imagePullSecrets: + {{- toYaml . | nindent 8 }} + {{- end }} + serviceAccountName: {{ include "xtuple.serviceAccountName" . }} + {{- with .Values.podSecurityContext }} + securityContext: + {{- toYaml . | nindent 8 }} + {{- end }} + containers: + - name: {{ .Chart.Name }} + {{- with .Values.securityContext }} + securityContext: + {{- toYaml . | nindent 12 }} + {{- end }} + image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}" + imagePullPolicy: {{ .Values.image.pullPolicy }} + ports: + - name: http + containerPort: {{ .Values.service.port }} + protocol: TCP + {{- with .Values.livenessProbe }} + livenessProbe: + {{- toYaml . | nindent 12 }} + {{- end }} + {{- with .Values.readinessProbe }} + readinessProbe: + {{- toYaml . | nindent 12 }} + {{- end }} + {{- with .Values.resources }} + resources: + {{- toYaml . | nindent 12 }} + {{- end }} + {{- with .Values.volumeMounts }} + volumeMounts: + {{- toYaml . | nindent 12 }} + {{- end }} + {{- with .Values.volumes }} + volumes: + {{- toYaml . | nindent 8 }} + {{- end }} + {{- with .Values.nodeSelector }} + nodeSelector: + {{- toYaml . | nindent 8 }} + {{- end }} + {{- with .Values.affinity }} + affinity: + {{- toYaml . | nindent 8 }} + {{- end }} + {{- with .Values.tolerations }} + tolerations: + {{- toYaml . | nindent 8 }} + {{- end }} diff --git a/xtuple/templates/hpa.yaml b/xtuple/templates/hpa.yaml new file mode 100644 index 0000000..f248059 --- /dev/null +++ b/xtuple/templates/hpa.yaml @@ -0,0 +1,32 @@ +{{- if .Values.autoscaling.enabled }} +apiVersion: autoscaling/v2 +kind: HorizontalPodAutoscaler +metadata: + name: {{ include "xtuple.fullname" . }} + labels: + {{- include "xtuple.labels" . | nindent 4 }} +spec: + scaleTargetRef: + apiVersion: apps/v1 + kind: Deployment + name: {{ include "xtuple.fullname" . }} + minReplicas: {{ .Values.autoscaling.minReplicas }} + maxReplicas: {{ .Values.autoscaling.maxReplicas }} + metrics: + {{- if .Values.autoscaling.targetCPUUtilizationPercentage }} + - type: Resource + resource: + name: cpu + target: + type: Utilization + averageUtilization: {{ .Values.autoscaling.targetCPUUtilizationPercentage }} + {{- end }} + {{- if .Values.autoscaling.targetMemoryUtilizationPercentage }} + - type: Resource + resource: + name: memory + target: + type: Utilization + averageUtilization: {{ .Values.autoscaling.targetMemoryUtilizationPercentage }} + {{- end }} +{{- end }} diff --git a/xtuple/templates/ingress.yaml b/xtuple/templates/ingress.yaml new file mode 100644 index 0000000..176fa37 --- /dev/null +++ b/xtuple/templates/ingress.yaml @@ -0,0 +1,43 @@ +{{- if .Values.ingress.enabled -}} +apiVersion: networking.k8s.io/v1 +kind: Ingress +metadata: + name: {{ include "xtuple.fullname" . }} + labels: + {{- include "xtuple.labels" . | nindent 4 }} + {{- with .Values.ingress.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +spec: + {{- with .Values.ingress.className }} + ingressClassName: {{ . }} + {{- end }} + {{- if .Values.ingress.tls }} + tls: + {{- range .Values.ingress.tls }} + - hosts: + {{- range .hosts }} + - {{ . | quote }} + {{- end }} + secretName: {{ .secretName }} + {{- end }} + {{- end }} + rules: + {{- range .Values.ingress.hosts }} + - host: {{ .host | quote }} + http: + paths: + {{- range .paths }} + - path: {{ .path }} + {{- with .pathType }} + pathType: {{ . }} + {{- end }} + backend: + service: + name: {{ include "xtuple.fullname" $ }} + port: + number: {{ $.Values.service.port }} + {{- end }} + {{- end }} +{{- end }} diff --git a/xtuple/templates/keydb-deployment.yaml b/xtuple/templates/keydb-deployment.yaml new file mode 100644 index 0000000..edf7390 --- /dev/null +++ b/xtuple/templates/keydb-deployment.yaml @@ -0,0 +1,32 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + name: keydb +spec: + replicas: 1 + selector: + matchLabels: + app: keydb + template: + metadata: + labels: + app: keydb + spec: + containers: + - name: keydb + image: eqalpha/keydb:latest + ports: + - containerPort: 6379 + args: ["--server-threads", "2"] # TODO: tune this +--- +apiVersion: v1 +kind: Service +metadata: + name: keydb +spec: + selector: + app: keydb + ports: + - port: 6379 + targetPort: 6379 + type: ClusterIP diff --git a/xtuple/templates/service.yaml b/xtuple/templates/service.yaml new file mode 100644 index 0000000..9303bbf --- /dev/null +++ b/xtuple/templates/service.yaml @@ -0,0 +1,15 @@ +apiVersion: v1 +kind: Service +metadata: + name: {{ include "xtuple.fullname" . }} + labels: + {{- include "xtuple.labels" . | nindent 4 }} +spec: + type: {{ .Values.service.type }} + ports: + - port: {{ .Values.service.port }} + targetPort: http + protocol: TCP + name: http + selector: + {{- include "xtuple.selectorLabels" . | nindent 4 }} diff --git a/xtuple/templates/serviceaccount.yaml b/xtuple/templates/serviceaccount.yaml new file mode 100644 index 0000000..940ba0c --- /dev/null +++ b/xtuple/templates/serviceaccount.yaml @@ -0,0 +1,13 @@ +{{- if .Values.serviceAccount.create -}} +apiVersion: v1 +kind: ServiceAccount +metadata: + name: {{ include "xtuple.serviceAccountName" . }} + labels: + {{- include "xtuple.labels" . | nindent 4 }} + {{- with .Values.serviceAccount.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +automountServiceAccountToken: {{ .Values.serviceAccount.automount }} +{{- end }} diff --git a/xtuple/templates/tests/test-connection.yaml b/xtuple/templates/tests/test-connection.yaml new file mode 100644 index 0000000..0cfa6b2 --- /dev/null +++ b/xtuple/templates/tests/test-connection.yaml @@ -0,0 +1,15 @@ +apiVersion: v1 +kind: Pod +metadata: + name: "{{ include "xtuple.fullname" . }}-test-connection" + labels: + {{- include "xtuple.labels" . | nindent 4 }} + annotations: + "helm.sh/hook": test +spec: + containers: + - name: wget + image: busybox + command: ['wget'] + args: ['{{ include "xtuple.fullname" . }}:{{ .Values.service.port }}'] + restartPolicy: Never diff --git a/xtuple/values.yaml b/xtuple/values.yaml new file mode 100644 index 0000000..9dc58db --- /dev/null +++ b/xtuple/values.yaml @@ -0,0 +1,130 @@ +# Default values for xtuple. +# This is a YAML-formatted file. +# Declare variables to be passed into your templates. + +# This will set the replicaset count more information can be found here: https://kubernetes.io/docs/concepts/workloads/controllers/replicaset/ +replicaCount: 1 + +# This sets the container image more information can be found here: https://kubernetes.io/docs/concepts/containers/images/ + +image: + jobs: + repository: "..." + tag: "latest" + controller: + repository: "minikube:5000/xtuples_controller" + tag: "latest" + agent: + repository: "xtuples_agent" + tag: "latest" + + + +# This is for the secrets for pulling an image from a private repository more information can be found here: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/ +imagePullSecrets: [] +# This is to override the chart name. +nameOverride: "" +fullnameOverride: "" + +# This section builds out the service account more information can be found here: https://kubernetes.io/docs/concepts/security/service-accounts/ +serviceAccount: + # Specifies whether a service account should be created + create: true + # Automatically mount a ServiceAccount's API credentials? + automount: true + # Annotations to add to the service account + annotations: {} + # The name of the service account to use. + # If not set and create is true, a name is generated using the fullname template + name: "" + +# This is for setting Kubernetes Annotations to a Pod. +# For more information checkout: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/ +podAnnotations: {} +# This is for setting Kubernetes Labels to a Pod. +# For more information checkout: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ +podLabels: {} + +podSecurityContext: {} + # fsGroup: 2000 + +securityContext: {} + # capabilities: + # drop: + # - ALL + # readOnlyRootFilesystem: true + # runAsNonRoot: true + # runAsUser: 1000 + +# This is for setting up a service more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/ +service: + # This sets the service type more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types + type: ClusterIP + # This sets the ports more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/#field-spec-ports + port: 80 + +# This block is for setting up the ingress for more information can be found here: https://kubernetes.io/docs/concepts/services-networking/ingress/ +ingress: + enabled: false + className: "" + annotations: {} + # kubernetes.io/ingress.class: nginx + # kubernetes.io/tls-acme: "true" + hosts: + - host: chart-example.local + paths: + - path: / + pathType: ImplementationSpecific + tls: [] + # - secretName: chart-example-tls + # hosts: + # - chart-example.local + +resources: {} + # We usually recommend not to specify default resources and to leave this as a conscious + # choice for the user. This also increases chances charts run on environments with little + # resources, such as Minikube. If you do want to specify resources, uncomment the following + # lines, adjust them as necessary, and remove the curly braces after 'resources:'. + # limits: + # cpu: 100m + # memory: 128Mi + # requests: + # cpu: 100m + # memory: 128Mi + +# This is to setup the liveness and readiness probes more information can be found here: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/ +livenessProbe: + httpGet: + path: / + port: http +readinessProbe: + httpGet: + path: / + port: http + +# This section is for setting up autoscaling more information can be found here: https://kubernetes.io/docs/concepts/workloads/autoscaling/ +autoscaling: + enabled: false + minReplicas: 1 + maxReplicas: 100 + targetCPUUtilizationPercentage: 80 + # targetMemoryUtilizationPercentage: 80 + +# Additional volumes on the output Deployment definition. +volumes: [] +# - name: foo +# secret: +# secretName: mysecret +# optional: false + +# Additional volumeMounts on the output Deployment definition. +volumeMounts: [] +# - name: foo +# mountPath: "/etc/foo" +# readOnly: true + +nodeSelector: {} + +tolerations: [] + +affinity: {} From 279ba16736db9ec1ab91a80b0d8ebefcddf56115 Mon Sep 17 00:00:00 2001 From: Mair nousH Date: Thu, 27 Mar 2025 16:49:17 +0100 Subject: [PATCH 2/2] docs: update repo README --- README.md | 54 +++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 53 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 155e0f5..526b3aa 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,54 @@ # XTuples - A data-driven job synchronization service inspired by the tuple space model. +A data-driven job synchronization service inspired by the tuple space model. + +# XTuples +XTuples is a data-driven job synchronization service inspired by the tuple space model. + +## Features + +- **Agent Image**: Deploys agents for monitoring and managing tasks. +- **Jobs**: Python-based package for background job processing. +- **Services**: Set of modular services, each with its own configuration. +- **Controller Image**: Manages orchestration tasks. +- **xtuple Helmchart**: Helm Chart for KeyDB uses ClusterIP. + + +## Getting Started + +### Prerequisites + +- Minikube or Docker registry running at `minikube:5000` +- Kubernetes cluster setup (local or cloud-based) +- Docker +- Python and virtualenv for jobs + +### Setup + +1. Clone the repository: + ```bash + git clone https://github.com/ditrit/XTuples.git + cd XTuples + ``` + +2. Make sure you are running uild Docker images: + Run the `build_images.sh` script to build and push images: + ```bash + ./build_images.sh + ``` + +3. Deploy to Kubernetes: + Follow the instructions for deploying to your Kubernetes cluster using Helm charts (see below). + +## Usage + +### Deploying KeyDB with Helm + +## TODO! +- XTuples uses Helm charts for managing Kubernetes deployments. +- Customize the chart values and deploy using the following steps. + + +## License + +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. +