Skip to content

Commit 72a11e2

Browse files
authored
Update development.md
1 parent d3fa62e commit 72a11e2

File tree

1 file changed

+63
-7
lines changed

1 file changed

+63
-7
lines changed

developers-guide/README.md

Lines changed: 63 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,68 @@
1-
# Local Devtron Dev Setup
1+
# Development Guide for Devtron
22

3-
For all the open source contributors out there looking for contributing to Devtron’s code base, here’s how easily you can start contributing in Devtron.
3+
This document provides instructions for setting up a development environment to help you get started with contributing to [Devtron](github.com/devtron-labs/devtron). Make sure to review the [contributing.md](https://github.com/devtron-labs/devtron/blob/main/CONTRIBUTING.md) file for more details on contributing. This document will help guide you through understanding the build process.
44

5-
## Prerequisite
6-
Any kubernetes Cluster
5+
## Requirements
6+
- [Go Programming language](https://go.dev/)
7+
- [Docker](https://www.docker.com/)
8+
- [Kubernetes Cluster](https://kubernetes.io/)
9+
- [Helm v3](https://helm.sh/)
710

811
## Setup Guide
9-
We have documented some of the most popular and easiest ways of creating local kubernetes clusters and setting up the development environment for devtron in our machine.
1012

11-
* [Over Minikube Cluster](https://dev.to/arushi09/local-kubernetes-development-made-easy-with-minikube-devtron-17hf)
12-
* [Over k3s Cluster using k3d](https://hackernoon.com/how-to-install-k3d-and-devtron-locally-for-local-kubernetes-development)
13+
### Install Devtron in a Kubernetes cluster
14+
15+
1. [Create a Kubernetes Cluster](https://docs.devtron.ai/getting-started#create-a-kubernetes-cluster)
16+
- 2 vCPUs
17+
- 4GB+ of free memory
18+
- 20GB+ free disk space
19+
20+
2. [Install Devtron with CI/CD along with GitOps (Argo CD) - Full mode](https://docs.devtron.ai/install/install-devtron-with-cicd-with-gitops)
21+
22+
```bash
23+
helm repo add devtron https://helm.devtron.ai
24+
helm repo update devtron
25+
helm install devtron devtron/devtron-operator \
26+
--create-namespace --namespace devtroncd \
27+
--set installer.modules={cicd} \
28+
--set argo-cd.enabled=true
29+
```
30+
31+
Note: If you want to install Devtron on a Managed Kubernetes cluster, please [refer to the guide](https://docs.devtron.ai/install/demo-tutorials).
32+
33+
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.
34+
35+
4. Forward the port of PostgreSQL service and Devtron NATS service:
36+
37+
```bash
38+
kubectl -n devtroncd port-forward svc/devtron-nats 4222:4222
39+
kubectl -n devtroncd port-forward svc/postgresql-postgresql 5432:5432
40+
```
41+
42+
5. Use this command to extract the password of PostgreSQL (Required to put in ENV):
43+
44+
```bash
45+
kubectl exec -it -n devtroncd postgresql-postgresql-0 -- printenv | grep POSTGRES_PASSWORD
46+
```
47+
48+
### Prepare Your Local Workspace
49+
50+
Navigate to the `github.com` directory on your local machine:
51+
52+
- `cd go/src/github.com`
53+
- `git clone http://github.com/devtron-labs/devtron`
54+
- Configure [Environment Variables](https://github.com/devtron-labs/devtron/blob/main/scripts/dev-conf/envfile.env)
55+
- Run the server:
56+
57+
```bash
58+
make run
59+
```
60+
61+
This will start your server on `localhost:8080`.
62+
63+
### Need help?
64+
65+
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](https://discord.com/channels/769482988882493450/801441246849007667) channel, where our team and community members are actively available to assist you on discord channel.
66+
67+
68+

0 commit comments

Comments
 (0)