Skip to content

Commit f7bb9cf

Browse files
authored
Update README.md
1 parent f32d626 commit f7bb9cf

File tree

1 file changed

+28
-8
lines changed

1 file changed

+28
-8
lines changed

developers-guide/README.md

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,19 @@ This document provides instructions for setting up a development environment to
3232

3333
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.
3434

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-
```
35+
4. Forward the necessary service ports (e.g., PostgreSQL, NATS) for local access
36+
37+
```
38+
#Required
39+
kubectl -n devtroncd port-forward svc/devtron-nats 4222:4222 # Allows event driven communictation between microservices.
40+
kubectl -n devtroncd port-forward svc/postgresql-postgresql 5432:5432 #Allows your local code to connect to the database running in the cluster.
41+
42+
#Optional
43+
kubectl -n devtroncd port-forward svc/argocd-server 8000:80 #Required to interact with ArgoCD's API (GitOps)
44+
kubectl -n devtroncd port-forward svc/argocd-dex-server 5556:5556 #Required for SSO Logins.
45+
kubectl -n devtroncd port-forward svc/kubelink-service 50051:50051 #Required for no-gitops (helm) and fetches the status of resources.
46+
kubectl -n devtroncd port-forward svc/git-sensor-service 7070:80 # Monitors Git repositories for changes and triggers appropriate workflows in Devtron.
47+
```
4148
4249
5. Use this command to extract the password of PostgreSQL (Required to put in ENV):
4350
@@ -52,7 +59,7 @@ Navigate to the `github.com` directory on your local machine:
5259
- `cd go/src/github.com`
5360
- `git clone http://github.com/devtron-labs/devtron`
5461
- Configure [Environment Variables](https://github.com/devtron-labs/devtron/blob/main/scripts/dev-conf/envfile.env)
55-
- Install [wire]{https://github.com/google/wire} (Required)
62+
- Install [wire](ttps://github.com/google/wire) (Required)
5663
- Run the server:
5764
5865
```bash
@@ -61,7 +68,20 @@ Navigate to the `github.com` directory on your local machine:
6168
6269
This will start your server on `localhost:8080`.
6370
64-
### Need help?
71+
## Cleanup
72+
73+
```
74+
1. Uninstall Devtron and delete the 'devtroncd' namespace
75+
helm uninstall devtron -n devtroncd
76+
kubectl delete namespace devtroncd
77+
78+
2. Remove the local Devtron codebase
79+
rm -rf ~/go/src/github.com/devtron-labs/devtron
80+
```
81+
## Contributing
82+
Please check [contributing guidelines](https://github.com/devtron-labs/devtron/blob/main/CONTRIBUTING.md)
83+
84+
## Need help?
6585
6686
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.
6787

0 commit comments

Comments
 (0)