Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Need Help Creating Helm Chart for Buggregator Server Deployment #140

Open
butschster opened this issue Apr 18, 2024 · 2 comments
Open

Need Help Creating Helm Chart for Buggregator Server Deployment #140

butschster opened this issue Apr 18, 2024 · 2 comments
Labels
Milestone

Comments

@butschster
Copy link
Member

butschster commented Apr 18, 2024

Hello everyone,

We are looking to enhance the deployment process of the Buggregator Server in Kubernetes environments, aiming to make it more streamlined and accessible. To achieve this, we want to develop a Helm chart that encapsulates all the necessary configurations and simplifies the setup process.

Project Goals:

  • Ease of Use: Simplify the deployment of Buggregator Server on Kubernetes.
  • Configuration Flexibility: Allow users to easily customize the deployment according to their needs through Helm values.
  • Scalability and Reliability: Ensure the Helm chart supports scalable deployments and integrates well with Kubernetes' native features for high availability.

We Need Your Help! We are reaching out to the community for help with creating this Helm chart. Whether you're experienced with Helm or Kubernetes, or are looking to get involved in open source development, we welcome your contributions!

How You Can Help:

  • Chart Development: Contributing to the initial creation of the Helm chart, including templates for deployments, services, and other necessary Kubernetes resources.
  • Documentation: Assisting in writing clear, user-friendly documentation for setting up the Helm chart.
  • Testing: Helping to test the Helm chart in different Kubernetes environments and providing feedback on its usability and functionality.

Here is a guide on how to create: https://helm.sh/docs/chart_template_guide/getting_started/

@butschster butschster added this to the 1.0 milestone Apr 18, 2024
@butschster butschster changed the title Add Helm Chart for kubernetes Need Help Creating Helm Chart for Buggregator Server Deployment Apr 18, 2024
@butschster butschster pinned this issue Apr 19, 2024
@shanginn
Copy link

I will start with providing an example just to get the ball rolling. not very production ready, but works for me.
This is probably will work with default newly created helm chart with name chartname.

apiVersion: apps/v1
kind: Deployment
metadata:
  name: {{ include "chartname.fullname" . }}-buggregator
  labels:
    {{- include "chartname.labels" . | nindent 4 }}
spec:
  replicas: 1
  selector:
    matchLabels:
      {{- include "chartname.selectorLabels" . | nindent 6 }}
  template:
    metadata:
      {{- with .Values.podAnnotations }}
      annotations:
        {{- toYaml . | nindent 8 }}
      {{- end }}
      labels:
        {{- include "chartname.selectorLabels" . | nindent 8 }}
    spec:
      {{- with .Values.imagePullSecrets }}
      imagePullSecrets:
        {{- toYaml . | nindent 8 }}
      {{- end }}
      serviceAccountName: {{ include "chartname.serviceAccountName" . }}
      securityContext:
        {{- toYaml .Values.podSecurityContext | nindent 8 }}
      containers:
        - name: "{{ .Release.Name }}"
          securityContext:
            {{- toYaml .Values.securityContext | nindent 12 }}
          image: "ghcr.io/buggregator/server:{{ .Values.imageBuggregator.tag }}"
          imagePullPolicy: {{ .Values.imageBuggregator.pullPolicy }}
          ports:
            - containerPort: 8000
              name: buggregator-dashboard
            - containerPort: 1025
              name: smtp
            - containerPort: 9912
              name: var-dumper
            - containerPort: 9913
              name: monolog
          resources:
            {{- toYaml .Values.resources | nindent 12 }}
      {{- with .Values.nodeSelector }}
      nodeSelector:
        {{- toYaml . | nindent 8 }}
      {{- end }}
      {{- with .Values.affinity }}
      affinity:
        {{- toYaml . | nindent 8 }}
      {{- end }}
      {{- with .Values.tolerations }}
      tolerations:
        {{- toYaml . | nindent 8 }}
      {{- end }}

---
apiVersion: v1
kind: Service
metadata:
  name: {{ include "chartname.fullname" . }}-buggregator
  labels:
    {{- include "chartname.labels" . | nindent 4 }}
spec:
    type: ClusterIP
    ports:
        - port: 8000
          targetPort: 8000
          protocol: TCP
          name: buggregator-dashboard
        - port: 1025
          targetPort: 1025
          protocol: TCP
          name: smtp
        - port: 9912
          targetPort: 9912
          protocol: TCP
          name: var-dumper
        - port: 9913
          targetPort: 9913
          protocol: TCP
          name: monolog
    selector:
        {{- include "chartname.selectorLabels" . | nindent 4 }}
    {{- end }}
    {{- if .Values.imageBuggregator.enabled }}
    {{- $fullName := include "chartname.fullname" . -}}

and values.yaml with:

imageBuggregator:
  pullPolicy: Always
  tag: "1.10.4"

@Richarddesk
Copy link

Hi! I noticed there hasn't been any recent activity on this issue.
If the work on it is paused, I'm available to take it over and continue. Please let me know if it's okay for me to start working on it. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: No status
Development

No branches or pull requests

3 participants