Skip to content

Commit 36636c0

Browse files
doc: Updated Readme for K8s Dashboard & Devtron platform (#6074)
* docs: update readme to k8s dashboard * docs: update readme with features * docs:formatting of readme * docs: Update documentation links * docs: added devtron platform to readme * docs: devtron platform * docs: add installation with integrations
1 parent 6afcca4 commit 36636c0

File tree

4 files changed

+79
-108
lines changed

4 files changed

+79
-108
lines changed

COMMUNITY_CONTRIBUTIONS.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
* https://www.financialexpress.com/industry/sme/devtron-a-business-opportunity-in-developers-needs/2274094/ - By Srinath Srinivasan
2323

2424

25-
## Videos
25+
## :video_camera: Videos
2626

2727
* https://www.youtube.com/watch?v=ZKcfZC-zSMM - By Victor Farcic
2828

@@ -33,3 +33,4 @@
3333
* https://www.youtube.com/watch?v=W4-UorfDQxI - Carbon_Capital Consulting
3434

3535
* https://www.youtube.com/watch?v=FB5BI3Ef7uw&t=363s - Let's learn Devtron
36+

README.md

Lines changed: 77 additions & 107 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,19 @@
1+
Note: We have restrucutred the readme. If you are looking for Devtron's CI/CD capabilites, please [click here](#devtron-platform)
2+
#
3+
14
<p align="center">
25
<picture>
36
<source media="(prefers-color-scheme: dark)" srcset="./assets/devtron-darkmode-logo.png">
47
<source media="(prefers-color-scheme: light)" srcset="./assets/devtron-lightmode-logo.png">
58
<img width="333.333" height="260" src="./assets/devtron-logo-dark-light.png">
69
</picture>
7-
<h1 align= "center">Cloud Native tool integration platform for Kubernetes</h1>
10+
<h1 align= "center">Kubernetes Dashboard for a Centralized DevOps Hub</h1>
811
</p>
912

1013
<p align="center">
1114
<br>
12-
<a href="https://docs.devtron.ai/" rel="nofollow"><strong>Explore documentation »</strong></a>
13-
<br>
14-
<a href="https://preview.devtron.ai/dashboard/" rel="nofollow"><strong>Try Devtron Demo »</strong></a>
15+
<a href="https://docs.dashboard.devtron.ai/" rel="nofollow"><strong>«Explore Documentation»</strong></a> <strong>||</strong>
16+
<a href="https://preview.devtron.ai/dashboard/" rel="nofollow"><strong>«Try Devtron Demo»</strong></a>
1517
<br>
1618
<a href="https://devtron.ai/">Website</a>
1719
·
@@ -23,92 +25,67 @@
2325
.
2426
<a href="https://www.youtube.com/channel/UCAHRp9qp0z1y9MMtQlcFtcw">YouTube</a>
2527

28+
2629
</p>
2730
<p align="center">
28-
<a href="https://discord.gg/jsRG5qx2gp"><img src="https://img.shields.io/badge/Join%20us%20on-Discord-e01563.svg" alt="Join Discord"></a>
31+
<a href="https://discord.gg/jsRG5qx2gp"><img src="https://img.shields.io/discord/687207715902193673?logo=discord&label=Discord&color=5865F2&logoColor=white" alt="Join Discord"></a>
2932
<a href="https://goreportcard.com/badge/github.com/devtron-labs/devtron"><img src="https://goreportcard.com/badge/github.com/devtron-labs/devtron" alt="Go Report Card"></a>
3033
<a href="./LICENSE"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg" alt="License"></a>
34+
<a href="./CONTRIBUTING.md"><img src="https://img.shields.io/github/contributors/devtron-labs/devtron" alt="contributors"></a>
35+
<a href="https://github.com/devtron-labs/devtron"><img src="https://img.shields.io/github/commit-activity/m/devtron-labs/devtron" alt="Commit Activity"></a>
3136
<a href="https://bestpractices.coreinfrastructure.org/projects/4411"><img src="https://bestpractices.coreinfrastructure.org/projects/4411/badge" alt="CII Best Practices"></a>
3237
<a href="http://golang.org"><img src="https://img.shields.io/badge/Made%20with-Go-1f425f.svg" alt="made-with-Go"></a>
3338
<a href="http://devtron.ai/"><img src="https://img.shields.io/website-up-down-green-red/http/shields.io.svg" alt="Website devtron.ai"></a>
39+
<a href="https://github.com/devtron-labs/devtron/releases"><img src="https://img.shields.io/github/v/release/devtron-labs/devtron"></a>
3440
<a href="https://twitter.com/intent/tweet?text=Devtron%20helps%20in%20simplifying%20software delivery%20workflow%20for%20Kubernetes,%20check%20it%20out!!%20&hashtags=OpenSource,Kubernetes,DevOps,CICD,go&url=https://github.com/devtron-labs/devtron%0a"><img src="https://img.shields.io/twitter/url/http/shields.io.svg?style=social" alt="Tweet"></a>
35-
36-
<p align="center">
37-
<a href="https://devtron.ai/devops-in-a-box.html">🔥 Want to accelerate K8s adoption? Introducing DevOps in a Box; Leave DevOps on Devtron 🔥
38-
</a>
39-
<br>
40-
</p>
4141
<h1></h1>
4242

43-
Devtron deeply integrates with products across the lifecycle of microservices,i.e., CI, CD, security, cost, debugging, and observability via an intuitive web interface.
44-
<br>
45-
<p align="center"><img src="./assets/readme-comic.png"></p>
46-
47-
[Devtron](#install-devtron) helps you deploy, observe, manage & debug existing Helm apps in all your clusters.
48-
49-
50-
## Devtron Demo Environment
51-
52-
Please log in the <a href="https://preview.devtron.ai/dashboard/" rel="nofollow">Demo environment</a> using github credentials. Please note the user is granted view access.
43+
Devtron's **extensible Kubernetes Dashboard** provides clear visibility into your Kubernetes clusters and streamlines Helm app management through a single, intuitive interface.<br>
44+
With built-in RBAC, it ensures secure access while offering integrated insights into workloads deployed via GitOps tools like **ArgoCD** and **FluxCD** across multiple clusters. Devtron creates a centralized DevOps hub, accelerating operations by up to 20x :rocket:
5345

54-
## Devtron Features
55-
56-
<details><summary><b>Application-level Resource grouping for easier Debugging</b></summary>
57-
<br>
58-
59-
- Devtron groups your Kubernetes objects deployed via Helm charts and display them in a slick UI for easier monitoring or debugging. Access pod logs and resource manifests right from the Devtron UI and even edit them!
60-
61-
</details>
62-
<details><summary> <b>Centralized Access Management</b></summary>
63-
<br>
64-
65-
- Control and give customizable view-only, edit access to users on Project, Environment and Application levels
66-
</details>
67-
68-
<details><summary> <b>Deploy, Manage and Observe on multiple clusters</b></summary>
69-
<br>
70-
71-
- Deploy and manage Helm charts, applications across multiple Kubernetes clusters (hosted on multiple clouds/on-prem) right from a single Devtron setup
72-
</details>
46+
Check out the below video to experince the full power of the **Kubernetes Dashboard**.
7347

48+
<a href="https://youtu.be/oqCAB9b-SGQ?si=YoUJfHL43VXRU5wx">
7449
<br>
50+
<p align="center"><img src="./assets/dashboard.png"></p>
51+
</a>
7552

76-
## Integrations
53+
Out of the box, Devtron's Kubernetes Dashboard includes:
54+
- [Helm Application Management](https://docs.dashboard.devtron.ai/user-guide/helm-apps) to streamline deploying, configuration, and management of Helm apps
55+
- [Resource Browser](https://docs.dashboard.devtron.ai/user-guide/resource-browser) to visualize and manage different cluster resources like Nodes, Pods, ConfigMaps, Custom Resource Definations (CRDs), etc
56+
- [Single Sign On (SSO)](https://docs.dashboard.devtron.ai/operator-guide/authorization/sso-login-services) to simplify onboarding and authenticating team members.
57+
- [Fine Grained RBAC](https://docs.dashboard.devtron.ai/operator-guide/authorization) to control the level of access users have to different Dashboard and Cluster resources.
7758

78-
Devtron is designed to be modular, and its functionality can be easily extended with the help of integrations.
59+
[Devtron](#install-devtron) helps you deploy, observe, manage & debug existing Helm apps in all your clusters.
7960

80-
### CI/CD Integration
61+
## Devtron Dashboard
8162

82-
[Devtron CI/CD with GitOps](#install-devtron-with-cicd-integration) integration is used to automate the builds and deployments and enables the software development teams to focus on meeting the business requirements, code quality, and security.
63+
Devtron's Kubernetes Dashboard offers a variety of different features, giving you flexibility to manage your clusters as you desire.
8364

84-
* Devtron leverages Kubernetes auto-scaling and centralized caching to give you unlimited cost-efficient CI workers.
85-
* Supports pre-CI and post-CI integrations for code quality monitoring.
86-
* Seamlessly integrates with Clair for image vulnerability scanning.
87-
* Supports different deployment strategies: Blue/Green, Rolling, Canary, and Recreate.
88-
* Implements GitOps to manage the state of Kubernetes applications.
89-
* Integrates with ArgoCD for continuous deployment.
90-
* Checks logs, events, and manifests or exec inside containers for debugging.
91-
* Provides deployment metrics like; deployment frequency, lead time, change failure rate, and mean-time recovery.
92-
* Seamlessly integrates with Grafana for continuous application metrics like CPU and memory usage, status code, throughput, and latency on the dashboard.
65+
### Features 🤩
9366

94-
## Architecture
67+
- Simplified configuration and management for Helm applications with easy rollback
68+
- Compare and reconcile configuration drifts across enviornments
69+
- Manage Helm deployments to multiple Kubernetes enviornments
70+
- A single pane of glass for Helm, ArgoCD and FluxCD applications across multiple clusters
71+
- Centralized Dashboard to view and manage K8s resources across multiple clusters
72+
- Comprehensive SSO and RBAC to ensure secure dashboard access for team collaboration
9573

96-
<p align="center"><img src="./assets/Architecture.jpg"></p>
74+
To get a more comprehensive understanding of Devtron's Kubernetes Dashboard, please visit the [documentation](https://docs.dashboard.devtron.ai/)
9775

98-
## Installation
76+
### Installation
9977

10078
Before you begin, you must create a [Kubernetes cluster](https://kubernetes.io/docs/tutorials/kubernetes-basics/create-cluster/) (preferably K8s 1.16 or higher) and install [Helm](https://helm.sh/docs/intro/install/).
10179

102-
### 1. Install Devtron with CI/CD Integration
80+
### Install Devtron's Kubernetes Dashboard
10381

104-
Run the following command to install the latest version of Devtron along with the CI/CD module:
82+
Run the following command to install the latest version of Devtron's Kubernetes Dashboard:
10583

10684
```bash
10785
helm repo add devtron https://helm.devtron.ai
10886

10987
helm install devtron devtron/devtron-operator \
110-
--create-namespace --namespace devtroncd \
111-
--set installer.modules={cicd}
88+
--create-namespace --namespace devtroncd
11289
```
11390

11491
### Access Devtron
@@ -135,80 +112,73 @@ kubectl -n devtroncd get secret devtron-secret -o jsonpath='{.data.ACD_PASSWORD}
135112
```
136113

137114

138-
Please refer to the document for more information on how to [access the Devtron Dashboard](./docs/setup/install/install-devtron-with-cicd.md/#access-devtron-dashboard).
115+
Please refer to the document for more information on how to [access the Devtron Dashboard](https://docs.dashboard.devtron.ai/getting-started/install-devtron-dashboard).
139116

140-
#### Installation Status
117+
### Install Multi-Architecture Nodes (ARM and AMD)
141118

142-
The above install command for CI/CD integration starts Devtron-operator, which takes about 20 minutes to spin up all of the Devtron microservices one by one. You can check the status of the installation with the following command:
119+
To install Devtron on clusters with the multi-architecture nodes (ARM and AMD), append the Devtron installation command with ```--set installer.arch=multi-arch```
143120

144-
```bash
145-
kubectl -n devtroncd get installers installer-devtron \
146-
-o jsonpath='{.status.sync.status}'
147-
```
121+
## Devtron Platform
148122

149-
The command executes with one of the following output messages, indicating the status of the installation:
123+
The Devtron Platform provides a complete solution for all DevOps requirements, helping to create a single centrailzed DevOps Platform for managing all applications across Kubernetes clusters. <br>
150124

151-
* **Downloaded**: The installer has downloaded all the manifests, and installation is in progress.
152-
* **Applied**: The installer has successfully applied all the manifests, and the installation is complete.
125+
With Devtron Platform, you can accelerate your application delivery lifecycle by leveraging advanced features like canary deployments, A/B testing, and automated rollbacks. Devtron Platform helps you achieve faster time-to-market and improved application reliability by simplifying Kubernetes operations and streamlining development workflows.
153126

154-
### 2. Install Devtron with Helm Bundle
127+
<p align="center"><img src="./assets/devtron-feat-glance.png"></p>
155128

156-
```bash
157-
helm repo add devtron https://helm.devtron.ai
129+
Devtron deeply integrates with products across the lifecycle of microservices,i.e., CI, CD, security, cost, debugging, and observability via an intuitive web interface and helps you deploy, observe, manage & debug applications across all your Kubernetes clusters.
158130

159-
helm install devtron devtron/devtron-operator --create-namespace --namespace devtroncd
131+
### Devtron Integrations
160132

161-
```
133+
By harnessing the potential of diverse integrations, Devtron Dashboard can evolve into a robust platform, automating Kubernetes application workflows, from CI/CD pipelines to ongoing maintenance
162134

163-
### Install Multi-Architecture Nodes (ARM and AMD)
135+
Devtron comes with the following integrations:
164136

165-
To install Devtron on clusters with the multi-architecture nodes (ARM and AMD), append the Devtron installation command with ```--set installer.arch=multi-arch```
137+
- [Build and Deploy (CI/CD)](https://docs.devtron.ai/usage/integrations/build-and-deploy-ci-cd) integration enables software development teams to automate the build and deployment process, allowing them to focus on meeting the business requirements, maintaining code quality, and ensuring security
138+
- [GitOps (Argo CD)](https://docs.devtron.ai/usage/integrations/argocd) integration uses ArgoCD to implement GitOps for continuous delivery with GitOps patterns
139+
- [Vulnerability Scanning (Clair)](https://docs.devtron.ai/usage/integrations/clair) integration enables you to scan the vulnerabilities of the images during the time of image build only.
140+
- [Vulnerability Scanning (Trivy)](https://docs.devtron.ai/usage/integrations/clair) integration enables you to scan the vulnerabilities of the images during the time of image build only.
141+
- [Notifications](https://docs.devtron.ai/usage/integrations/notifications) integration, lets you receive alerts for build and deployment pipelines on trigger, success, and failure events to your email or a Slack channel via SES and SMTP.
142+
- [Monitoring (Grafana)](https://docs.devtron.ai/usage/integrations/grafana) integration uses Grafana to gather application metrics like CPU, Memory utilization, Status 4xx/ 5xx/ 2xx, Throughput, and Latency.
143+
144+
145+
### Features 🤩
146+
147+
- End-to-End CI/CD pipeline enabling a No Code software delivery workflow for Kubernetes through Helm or GitOps with ArgoCD
148+
- Deploy applications to multiple Kubernetes clusters on multiple cloud/on-prem from one Devtron setup
149+
- Robust DevSecOps implementation with battle tested tools like Trivy and Clair
150+
- A Single dashboard to cater to all debugging requirements for applications
151+
- Deployment metrics to measure the success of the agile process. It captures MTTR, change failure rate, deployment frequency, and deployment size.
152+
153+
To get a more comprehensive understanding of Devtron Platform's features, please visit the [documentation](https://docs.devtron.ai/)
154+
155+
### Install Devtron Platform
156+
157+
Run the following command to install the latest version of the Devtron Platform:
166158

159+
```bash
160+
helm install devtron devtron/devtron-operator --namespace devtroncd \
161+
--set installer.modules={cicd} --set argo-cd.enabled=true \
162+
--set security.enabled=true --set notifier.enabled=true \
163+
--set security.trivy.enabled=true --set monitoring.grafana.enabled=true
164+
```
167165
## :blue_heart: Technology
168166

169167
Devtron is built on some of the most trusted and loved technologies:
170168
<br>
171169
<p align="center"><img width="70%" height="70%" src="./assets/we-support.jpg"></p>
172-
173-
## :video_camera: Videos
174-
175-
- [Devtron - A Comprehensive Overview](https://youtu.be/FB5BI3Ef7uw?t=363)
176-
- [Viktor Farcic's review](https://youtu.be/ZKcfZC-zSMM)
177-
- [Running an application on Devtron](https://youtu.be/bA6zgjPD_yA?t=2927)
178-
- [Devtron Demo](https://youtu.be/ekxHV2Gje-E?t=7856)
179170

180-
## :memo: Blogs from Community
181-
182-
* [How Livspace revolutionised its CI/CD saga](https://blog.livspace.io/how-livspace-revolutionised-its-ci-cd-saga-3120724e271b)
183-
* [AppOps with Kubernetes and Devtron: The Perfect Fit](https://hackernoon.com/appops-with-kubernetes-and-devtron-the-perfect-fit-sj934qj)
184-
* [Getting started with GitOps on Kubernetes with Devtron](https://piotrminkowski.com/2022/05/04/getting-started-with-gitops-on-kubernetes-with-devtron)
185-
* [Zero to hero on Kubernetes with Devtron](https://dzone.com/articles/zero-to-hero-on-kubernetes-with-devtron)
186-
* [Kubernetes deployment made easy](https://medium.com/container-talks/kubernetes-deployment-made-easy-cc74f0242f06)
187-
188-
## :muscle: Trusted By
189-
190-
Devtron is trusted by communities all across the globe. The list of organizations using Devtron can be found [here](./USERS.md).
191-
192-
193171
## :question: FAQs & Troubleshooting
194172

195-
- Devtron - [see here](https://docs.devtron.ai/resources/devtron-troubleshoot)
196-
197-
## :page_facing_up: Compatibility
198-
199-
### Current build
200-
201-
- Devtron uses modified version of [Argo Rollout](https://argoproj.github.io/argo-rollouts/)
202-
- Application metrics only work for K8s version 1.16+
203-
204-
## Support, Contribution, and Community
173+
- For troubleshooting Devtron please [refer to this docs page](https://docs.devtron.ai/resources/devtron-troubleshoot)
205174

206175
## :busts_in_silhouette: Community
207176

208177
Get updates on Devtron's development and chat with project maintainers, contributors, and community members
209178
- Follow [@DevtronL on Twitter](https://twitter.com/DevtronL)
210179
- Raise feature requests, suggest enhancements, and report bugs in our [GitHub Issues](https://github.com/devtron-labs/devtron/issues)
211180
- Articles, Howtos, Tutorials - [Devtron Blogs](https://devtron.ai/blog/)
181+
- Devtron is trusted by communities all across the globe. The list of organizations using Devtron can be found [here](./USERS.md).
212182

213183
### Join us at Discord channel
214184
<p>

assets/dashboard.png

334 KB
Loading

assets/devtron-feat-glance.png

2.13 MB
Loading

0 commit comments

Comments
 (0)