Skip to content

Commit b34cd6f

Browse files
authored
Update README.md (#1380)
1 parent 0736526 commit b34cd6f

File tree

1 file changed

+19
-79
lines changed

1 file changed

+19
-79
lines changed

README.md

Lines changed: 19 additions & 79 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
</p>
3737
<h1></h1>
3838

39-
Devtron is a web based CI/CD orchestrator for Kubernetes. It integrates various Open Source tools to provide AppOps, that also includes Security scanning, GitOps, Access Control and Debugging / Observability.
39+
Devtron is a web based CI/CD orchestrator for Kubernetes. It integrates various Open Source tools to provide AppOps, that also includes Security Scanning, GitOps, Access Control and Debugging / Observability.
4040

4141
<br>
4242
<p align="center"><img src="./assets/readme-comic.png"></p>
@@ -47,7 +47,7 @@ Devtron is a web based CI/CD orchestrator for Kubernetes. It integrates various
4747
| Module | Features |
4848
| :-----------: | :-----------: |
4949
| [Hyperion](https://github.com/devtron-labs/devtron#-hyperion) | Deploy, observe manage & debug existing Helm apps in all your clusters |
50-
| [Devtron](https://github.com/devtron-labs/devtron#bulb-devtron) | CI/CD, Security scanning, GitOps, Access Control, Debugging / Observability. Also Comes with Hyperion included. |
50+
| [Devtron](https://github.com/devtron-labs/devtron#bulb-devtron) | CI/CD, Security Scanning, GitOps, Access Control, Debugging / Observability. Also comes with Hyperion included. |
5151

5252

5353
<!---
@@ -61,7 +61,8 @@ Hyperion is Devtron's light weight module to manage Helm apps. It helps you depl
6161

6262
## :tada: Features
6363

64-
https://user-images.githubusercontent.com/66381465/158799442-9ac09c27-7604-46bd-b0f1-36a1072893b3.mp4
64+
https://user-images.githubusercontent.com/66381465/159458292-a4d8e212-54b6-444f-bd6d-69645fddf966.mp4
65+
6566

6667
<details><summary><b>Application-level Resource grouping for easier Debugging</b></summary>
6768
<br>
@@ -77,17 +78,17 @@ https://user-images.githubusercontent.com/66381465/158799442-9ac09c27-7604-46bd-
7778

7879
</details>
7980

80-
<details><summary> <b>Deploy, Manage and Observe on multiple Clusters</b></summary>
81+
<details><summary> <b>Deploy, Manage and Observe on multiple clusters</b></summary>
8182
<br>
8283

83-
- Deploy and Manage Helm charts, Applications across multiple Kubernetes clusters (hosted on multiple clouds / on-prem) right from a single Hyperion setup
84+
- Deploy and manage Helm charts, applications across multiple Kubernetes clusters (hosted on multiple clouds / on-prem) right from a single Hyperion setup
8485

8586
</details>
8687

87-
<details><summary> <b>View and Edit Kubernetes manifests </b></summary>
88+
<details><summary> <b>View and edit Kubernetes manifests </b></summary>
8889
<br>
8990

90-
- View and Edit all the Kubernetes resources right from the Hyperion dashboard
91+
- View and edit all the Kubernetes resources right from the Hyperion dashboard
9192

9293
</details>
9394

@@ -113,7 +114,7 @@ helm install devtron devtron-operator-latest.tgz --create-namespace --namespace
113114

114115
### Hyperion Dashboard
115116

116-
If you did not provide a **BASE\_URL** during install or have used the default installation, Devtron creates a Load Balancer for you. Use the following command to get the dashboard URL. Please note it may take some time for cloud provider to provision the loadbalancer and in case of on-prem installation of kubernetes please use port-forward or ingress.
117+
If you did not provide a **BASE\_URL** during install or have used the default installation, Devtron creates a Load Balancer for you. Use the following command to get the dashboard URL. Please note it may take some time for cloud provider to provision the load balancer and in case of on-prem installation of kubernetes, please use port-forward or ingress.
117118

118119
```text
119120
kubectl get svc -n devtroncd devtron-service -o jsonpath='{.status.loadBalancer.ingress}'
@@ -128,7 +129,7 @@ You will get result something like this
128129

129130
The hostname mentioned here \( devtronsdashboardurlhere \) is the load balancer URL from where you can access the dashboard
130131

131-
### Hyperion Admin credentials
132+
*****Hyperion admin credentials*****
132133

133134
For admin login, use
134135
<br>
@@ -143,7 +144,7 @@ kubectl -n devtroncd get secret devtron-secret -o jsonpath='{.data.ACD_PASSWORD}
143144

144145
# :bulb: Devtron
145146

146-
Devtron is a No-Code CI/CD Orchestrator with a complete experience - providing you with CI/CD, Security scanning, GitOps, Access Control and Debugging / Observability from a single web-console. Hyperion module is included in Devtron.
147+
Devtron is a No-Code CI/CD Orchestrator with a complete experience - providing you with CI/CD, Security Scanning, GitOps, Access Control and Debugging / Observability from a single web-console. Hyperion module is included in Devtron.
147148

148149
## :tada: Features
149150
<br>
@@ -162,7 +163,7 @@ Devtron is a No-Code CI/CD Orchestrator with a complete experience - providing y
162163
<details>
163164
<summary> <b>Multi-Cloud / Multi-Cluster Deployment</b></summary>
164165

165-
- Gives the ability to deploy your applications to multiple clusters / cloud, with the unified dashboard
166+
- Gives the ability to deploy your applications to multiple clusters / cloud, with unified dashboard
166167
</details>
167168

168169
<details>
@@ -176,7 +177,7 @@ Devtron is a No-Code CI/CD Orchestrator with a complete experience - providing y
176177
<summary><b>UI enabled Application Debugging Dashboard</b></summary>
177178

178179
- Application-centric view for K8s components
179-
- Built-in monitoring for CPU, RAM, Http Status Code and Latency
180+
- Built-in monitoring for CPU, RAM, HTTP Status Code and Latency
180181
- Advanced Logging, with grep and json search
181182
- Access all the manifests securely, for e.g. secret obfuscation
182183
- Auto Issue identification
@@ -214,17 +215,17 @@ For detailed setup instructions and other options, check out [Devtron setup](htt
214215

215216
### :key: Devtron Dashboard
216217

217-
By default, Devtron creates a Load Balancer. Use the following command to get the dashboard URL. Please note it may take some time for cloud provider to provision the loadbalancer and in case of on-prem installation of kubernetes please use port-forward or ingress.
218+
By default, Devtron creates a Load Balancer. Use the following command to get the dashboard URL. Please note it may take some time for cloud provider to provision the load balancer and in case of on-prem installation of Kubernetes, please use port-forward or ingress.
218219

219220
```text
220221
kubectl get svc -n devtroncd devtron-service -o jsonpath='{.status.loadBalancer.ingress}'
221222
```
222223

223-
*****Devtron Admin credentials*****
224+
*****Devtron admin credentials*****
224225

225226
For admin login, use
226227
<br>
227-
Username:`admin`.
228+
Username:`admin`
228229
<br>
229230
And for the password, run the following command:
230231

@@ -254,74 +255,13 @@ Devtron is trusted by Enterprises and Community, all across the globe:
254255
- [Delhivery:](https://www.delhivery.com/) Delhivery is one the largest and most profitable logistics company in India
255256
- [BharatPe:](https://bharatpe.com/) Bharatpe is a business utility application to accept payments transactions in settlements
256257
- [Livspace:](https://www.livspace.com/in) Livspace is an one-stop shop for all home interiors and renovation services
257-
- [Moglix:](https://www.moglix.com/) A B2B commerce company working in the B2B procurement of industrial supplies
258+
- [Moglix:](https://www.moglix.com/) A B2B commerce company working in the procurement of industrial supplies
258259
- [Xoxoday:](https://www.xoxoday.com/) Xoxoday helps to send rewards, perks & incentives to employees, customers and partners
259260

260261
# :question: FAQ & Troubleshooting
261262

262-
<!-- ## FAQ
263-
264-
<details>
265-
<summary>1.How to resolve unauthorized error/s, while trying to save global configuration like Hostname, GitOps etc, after successful Devtron installation?</summary>
266-
<br>
267-
A. This occurs most of the times, because any one or more jobs get failed during installation. To resolve this, you will need to first check, which jobs have failed. Follow these steps:
268-
269-
- Run the following command and check which are the jobs with 0/1 completions:
270-
```bash
271-
kubectl get jobs -n devtroncd
272-
```
273-
274-
- Note the names of the jobs with 0/1 completions and check if their pods are in running state, by running the command:
275-
```bash
276-
kubectl get pods -n devtroncd
277-
```
278-
279-
- If they are in running condition, please wait for the jobs to complete. This may be due to connectivity issue. If the job is not in running condition, delete those incomplete jobs using:
280-
281-
```bash
282-
kubectl delete jobs <job1-name> <job2-name> -n devtroncd..
283-
```
284-
[Read More](https://github.com/devtron-labs/devtron/blob/main/Troubleshooting.md#1-how-to-resolve-unauthorized-error-while-trying-to-save-global-configurations-like-hostname-gitops-etc-after-successful-devtron-installation)
285-
286-
<br><br>
287-
</details>
288-
289-
<details>
290-
<summary>2.What to do if Devtron dashboard is not accessible in browser, even after successful completion of all the jobs and all pods are in running mode?</summary>
291-
<br>
292-
293-
A. Check if nats-cluster is created. You can check using the following command:
294-
295-
```bash
296-
kubectl get natscluster -n devtroncd
297-
```
298-
299-
- You should see a natscluster with the name devtron-nats. If not, run the following command:
300-
301-
```bash
302-
kubectl apply -f https://raw.githubusercontent.com/devtron-labs/devtron/main/manifests/yamls/nats-server.yaml -n devtroncd
303-
```
304-
305-
- Wait util all nats pods are created and the pods are in running condition. Once completed, delete devtron and dashboard pods. Then you should be able to access the devtron dashboard without any issues.
306-
307-
- If your problem is still not resolved, you can post your query in our [Discord](https://discord.gg/jsRG5qx2gp) channel
308-
<br><br>
309-
</details>
310-
311-
<details>
312-
<summary>3.Not able to see deployment metrics in production environment / Problem with enabling application-metrics / Not able to deploy the app after creating a configmap or secret, with data-volume option enabled</summary>
313-
<br>
314-
A. Update the rollout crds to latest version, run the following command
315-
316-
```bash
317-
kubectl apply -f https://raw.githubusercontent.com/devtron-labs/devtron/main/manifests/yamls/rollout.yaml -n devtroncd
318-
```
319-
</details> -->
320-
321-
<!-- ## Troubleshooting -->
322-
323-
- Hyperion FAQ & Troubleshooting - [see here](https://docs.devtron.ai/hyperion/faqs-and-troubleshooting/hyperion-troubleshoot)
324-
- Devtron FAQ & Troubleshooting - [see here](https://docs.devtron.ai/devtron/faqs-and-troubleshooting/devtron-troubleshoot)
263+
- Hyperion - [see here](https://docs.devtron.ai/hyperion/faqs-and-troubleshooting/hyperion-troubleshoot)
264+
- Devtron - [see here](https://docs.devtron.ai/devtron/faqs-and-troubleshooting/devtron-troubleshoot)
325265

326266
# :memo: Compatibility
327267

0 commit comments

Comments
 (0)