Skip to content

Latest commit

 

History

History
68 lines (45 loc) · 2.71 KB

README.md

File metadata and controls

68 lines (45 loc) · 2.71 KB

Development Guide for Devtron

This document provides instructions for setting up a development environment to help you get started with contributing to Devtron. Make sure to review the contributing.md file for more details on contributing. This document will help guide you through understanding the build process.

Requirements

Setup Guide

Install Devtron in a Kubernetes cluster

  1. Create a Kubernetes Cluster

    • 2 vCPUs
    • 4GB+ of free memory
    • 20GB+ free disk space

  2. Install Devtron with CI/CD along with GitOps (Argo CD) - Full mode

    helm repo add devtron https://helm.devtron.ai
helm repo update devtron
helm install devtron devtron/devtron-operator \
  --create-namespace --namespace devtroncd \
  --set installer.modules={cicd} \
  --set argo-cd.enabled=true

    Note: If you want to install Devtron on a Managed Kubernetes cluster, please refer to the guide.

  3. Download the kubeconfig file to access your cluster. It’s a good idea to set it up locally and configure the context to point to the specific cluster you’re working with.

  4. Forward the port of PostgreSQL service and Devtron NATS service:

    kubectl -n devtroncd port-forward svc/devtron-nats 4222:4222 
kubectl -n devtroncd port-forward svc/postgresql-postgresql 5432:5432

  5. Use this command to extract the password of PostgreSQL (Required to put in ENV):

    kubectl exec -it -n devtroncd postgresql-postgresql-0 -- printenv | grep POSTGRES_PASSWORD

Prepare Your Local Workspace

Navigate to the github.com directory on your local machine:

  • cd go/src/github.com

  • git clone http://github.com/devtron-labs/devtron

  • Configure Environment Variables

  • Run the server:

    make run

This will start your server on localhost:8080.

Need help?

If you’re looking for the fastest response to your questions, we encourage you to visit our Discord community. Specifically, you can post your inquiries in the #setup-and-installation channel, where our team and community members are actively available to assist you on discord channel.