Skip to content

Commit 670cc7e

Browse files
authored
Update README.md (#1382)
1 parent b34cd6f commit 670cc7e

File tree

1 file changed

+21
-17
lines changed

1 file changed

+21
-17
lines changed

README.md

Lines changed: 21 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -36,18 +36,18 @@
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, Debugging and Observability.
4040

4141
<br>
4242
<p align="center"><img src="./assets/readme-comic.png"></p>
4343

44-
<h3><b>Devtron is built in a modular fashion. It consists of the below modules which can be installed independently:</b></h3>
44+
<h3><b>Devtron is built in a modular fashion. It consists of the below modules which can be installed independently.</b></h3>
4545

4646

4747
| Module | Features |
4848
| :-----------: | :-----------: |
49-
| [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. |
49+
| [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) | Perform CI/CD, Security Scanning, GitOps, Access Control, Debugging and Observability. Comes with Hyperion included. |
5151

5252

5353
<!---
@@ -92,7 +92,7 @@ https://user-images.githubusercontent.com/66381465/159458292-a4d8e212-54b6-444f-
9292

9393
</details>
9494

95-
Hyperion is a great way to get familiar with Devtron's UI and some of its light weight features. You can always [upgrade to Devtron full stack](https://docs.devtron.ai/hyperion/upgrade-to-devtron), that includes all the features.
95+
Hyperion is a great way to get familiar with Devtron's UI and some of its light weight features. You can always [upgrade to Devtron full stack](https://docs.devtron.ai/hyperion/upgrade-to-devtron), that comes loaded with all the features.
9696

9797
## :rocket: Getting Started
9898

@@ -114,13 +114,15 @@ helm install devtron devtron-operator-latest.tgz --create-namespace --namespace
114114

115115
### Hyperion Dashboard
116116

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.
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.
118118

119119
```text
120120
kubectl get svc -n devtroncd devtron-service -o jsonpath='{.status.loadBalancer.ingress}'
121121
```
122122

123-
You will get result something like this
123+
Please note that it may take some time for the Cloud provider to provision the load balancer and in case of on-prem installation of Kubernetes, please use port-forward or ingress.
124+
125+
You will get an output, something like this
124126

125127
```text
126128
[test2@server ~]$ kubectl get svc -n devtroncd devtron-service -o jsonpath='{.status.loadBalancer.ingress}'
@@ -144,7 +146,7 @@ kubectl -n devtroncd get secret devtron-secret -o jsonpath='{.data.ACD_PASSWORD}
144146

145147
# :bulb: Devtron
146148

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.
149+
Devtron is a No-Code CI/CD Orchestrator with a complete experience - providing you with CI/CD, Security Scanning, GitOps, Access Control, Debugging and Observability from a single web-console. Hyperion module is included by default, in Devtron.
148150

149151
## :tada: Features
150152
<br>
@@ -215,19 +217,21 @@ For detailed setup instructions and other options, check out [Devtron setup](htt
215217

216218
### :key: Devtron Dashboard
217219

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.
220+
By default, Devtron creates a load balancer. Use the following command to get the dashboard URL.
219221

220222
```text
221223
kubectl get svc -n devtroncd devtron-service -o jsonpath='{.status.loadBalancer.ingress}'
222224
```
223225

226+
Please note that it may take some time for the Cloud provider to provision the load balancer and in case of on-prem installation of Kubernetes, please use port-forward or ingress.
227+
224228
*****Devtron admin credentials*****
225229

226230
For admin login, use
227231
<br>
228232
Username:`admin`
229233
<br>
230-
And for the password, run the following command:
234+
And for the password, run the following command
231235

232236
```bash
233237
kubectl -n devtroncd get secret devtron-secret -o jsonpath='{.data.ACD_PASSWORD}' | base64 -d
@@ -252,11 +256,11 @@ Devtron is built on some of the most trusted and loved technologies
252256
Devtron is trusted by Enterprises and Community, all across the globe:
253257
<br>
254258

255-
- [Delhivery:](https://www.delhivery.com/) Delhivery is one the largest and most profitable logistics company in India
256-
- [BharatPe:](https://bharatpe.com/) Bharatpe is a business utility application to accept payments transactions in settlements
257-
- [Livspace:](https://www.livspace.com/in) Livspace is an one-stop shop for all home interiors and renovation services
258-
- [Moglix:](https://www.moglix.com/) A B2B commerce company working in the procurement of industrial supplies
259-
- [Xoxoday:](https://www.xoxoday.com/) Xoxoday helps to send rewards, perks & incentives to employees, customers and partners
259+
- [Delhivery:](https://www.delhivery.com/) Delhivery is an Indian delivery and e-commerce logistics company, that provides end-to-end Supply Chain solutions through cutting-edge technology
260+
- [BharatPe:](https://bharatpe.com/) Bharatpe is a Indian fintech company that offers a range of products including interoperable QR code for UPI payments, POS machines for card acceptance, and small business financing
261+
- [Livspace:](https://www.livspace.com/in) Livspace is a home interior and renovation company, that provides interior design and renovation services in Singapore and India
262+
- [Moglix:](https://www.moglix.com/) Moglix is an industrial B2B marketplace and an e-commerce platform for industrial tools and equipment, used largely by businesses in India
263+
- [Xoxoday:](https://www.xoxoday.com/) Xoxoday provides technology infrastructure to enable businesses to automate rewards, incentives & payouts for employees, customers & channel partners
260264

261265
# :question: FAQ & Troubleshooting
262266

@@ -292,7 +296,7 @@ Get updates on Devtron's development and chat with project maintainers, contribu
292296

293297
## :handshake: Contribute
294298

295-
Check out our [contributing guidelines](CONTRIBUTING.md). Included are directions for opening issues, coding standards and notes on our development processes. We deeply appreciate your contributions.
299+
Check out our [contributing guidelines](CONTRIBUTING.md). Included, are directions for opening issues, coding standards and notes on our development processes. We deeply appreciate your contribution.
296300

297301
Please look at our [community contributions](COMMUNITY_CONTRIBUTIONS.md) and feel free to create a video or blog around Devtron and add your valuable contribution in the list.
298302

@@ -306,7 +310,7 @@ We are deeply grateful to all our amazing contributors!
306310

307311
## :bug: Vulnerability Reporting
308312

309-
We at Devtron take security and our users' trust very seriously. If you believe you have found a security issue, please disclose this to us at <b>[email protected]</b>.
313+
We at Devtron, take security and our users' trust very seriously. If you believe you have found a security issue, please report to <b>[email protected]</b>.
310314

311315
# :bookmark: License
312316

0 commit comments

Comments
 (0)