Skip to content

Commit b3afd13

Browse files
authored
Merge pull request #6873 from devtron-labs/update-readme
docs: Updates third party license list
2 parents bc8cecc + 4fa4b8a commit b3afd13

File tree

14 files changed

+45
-7
lines changed

14 files changed

+45
-7
lines changed

README.md

Lines changed: 45 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ Note: We have restructured the readme. If you are looking for Devtron's CI/CD ca
77
<source media="(prefers-color-scheme: light)" srcset="./assets/devtron-lightmode-logo.png">
88
<img width="333.333" height="260" src="./assets/devtron-logo-dark-light.png">
99
</picture>
10-
<h1 align= "center">Kubernetes Dashboard for a Centralized DevOps Hub</h1>
10+
<h1 align= "center">The Kubernetes Platform That Eliminates Operational Chaos</h1>
1111
</p>
1212

1313
<p align="center">
1414
<br>
15-
<a href="https://docs.dashboard.devtron.ai/" rel="nofollow"><strong>«Explore Documentation»</strong></a> <strong>||</strong>
15+
<a href="https://docs.devtron.ai/" rel="nofollow"><strong>«Explore Documentation»</strong></a> <strong>||</strong>
1616
<a href="https://preview.devtron.ai/dashboard/" rel="nofollow"><strong>«Try Devtron Demo»</strong></a>
1717
<br>
1818
<a href="https://devtron.ai/">Website</a>
@@ -56,7 +56,9 @@ Out of the box, Devtron's Kubernetes Dashboard includes:
5656
- [Single Sign On (SSO)](https://docs.dashboard.devtron.ai/operator-guide/authorization/sso-login-services) to simplify onboarding and authenticating team members.
5757
- [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.
5858

59-
[Devtron](#install-devtron) helps you deploy, observe, manage & debug existing Helm apps in all your clusters.
59+
[Devtron](#devtron-platform) helps you deploy, observe, manage & debug existing Helm apps in all your clusters.
60+
61+
---
6062

6163
## Devtron Dashboard
6264

@@ -113,6 +115,8 @@ kubectl -n devtroncd get secret devtron-secret -o jsonpath='{.data.ACD_PASSWORD}
113115

114116
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).
115117

118+
---
119+
116120
## Devtron Platform
117121

118122
The Devtron Platform provides a complete solution for all DevOps requirements, helping to create a single centralized DevOps Platform for managing all applications across Kubernetes clusters. <br>
@@ -157,11 +161,39 @@ helm install devtron devtron/devtron-operator --namespace devtroncd \
157161
--set security.enabled=true --set notifier.enabled=true \
158162
--set security.trivy.enabled=true --set monitoring.grafana.enabled=true
159163
```
160-
## :blue_heart: Technology
164+
165+
---
166+
167+
## Core Tools and Technologies
161168

162-
Devtron is built on some of the most trusted and loved technologies:
163-
<br>
164-
<p align="center"><img width="70%" height="70%" src="./assets/we-support.jpg"></p>
169+
Here are the components that Devtron uses internally as part of its own architecture:
170+
171+
| Logo | Tool | Purpose | GitHub Repository | License |
172+
| -------- | -------- | ---------- | ------------------- | ------- |
173+
| <img src="./assets/readme-logos/kubernetes.jpg" width="64px"> | **Kubernetes** | Core orchestration platform managing deployments, scaling, and container lifecycle automation. | [kubernetes/kubernetes](https://github.com/kubernetes/kubernetes) | [Apache License 2.0](https://github.com/kubernetes/kubernetes/blob/master/LICENSE) |
174+
| <img src="./assets/readme-logos/golang.jpg" width="64px"> | **Golang** | Backend language powering high-performance, scalable Devtron core services. | [golang/go](https://github.com/golang/go) | [BSD 3-Clause License](https://github.com/golang/go/blob/master/LICENSE) |
175+
| <img src="./assets/readme-logos/helm.jpg" width="64px"> | **Helm** | Manages Kubernetes application packaging, versioning, and consistent deployment workflows. | [helm/helm](https://github.com/helm/helm) | [Apache License 2.0](https://github.com/helm/helm/blob/main/LICENSE) |
176+
| <img src="./assets/readme-logos/trivy.jpg" width="64px"> | **Trivy** | Ensures security by scanning vulnerabilities, misconfigurations, secrets, and SBOMs. | [aquasecurity/trivy](https://github.com/aquasecurity/trivy) | [Apache License 2.0](https://github.com/aquasecurity/trivy/blob/main/LICENSE) |
177+
| <img src="./assets/readme-logos/nats.jpg" width="64px"> | **NATS** | Enables reliable, high-speed messaging between Devtron microservices and workflows. | [nats-io/nats-server](https://github.com/nats-io/nats-server) | [Apache License 2.0](https://github.com/nats-io/nats-server/blob/main/LICENSE) |
178+
| <img src="./assets/readme-logos/dex.jpg" width="64px"> | **Dex** | Provides secure SSO integration with enterprise identity providers. | [dexidp/dex](https://github.com/dexidp/dex) | [Apache License 2.0](https://github.com/dexidp/dex/blob/master/LICENSE) |
179+
| <img src="./assets/readme-logos/casbin.jpg" width="64px"> | **Casbin** | Enforces fine-grained RBAC policies for secure user authorization. | [casbin/casbin](https://github.com/casbin/casbin) | [Apache License 2.0](https://github.com/casbin/casbin/blob/master/LICENSE) |
180+
181+
182+
---
183+
184+
## Optional Components
185+
186+
Here are some of the optional components that Devtron supports:
187+
188+
| Logo | Tool | Purpose | GitHub Repository | License |
189+
| -------- | -------- | ---------- | ------------------- | ------- |
190+
| <img src="./assets/readme-logos/argo.jpg" width="64px"> | **Argo CD / Argo Workflows** | Enables GitOps-based deployments and workflow automation within Devtron | [argoproj/argo-cd](https://github.com/argoproj/argo-cd) | [Apache License 2.0](https://github.com/argoproj/argo-cd/blob/master/LICENSE) |
191+
| <img src="./assets/readme-logos/clair.jpg" width="64px"> | **Clair** | Scans container images for known security vulnerabilities | [quay/clair](https://github.com/quay/clair) | [Apache License 2.0](https://github.com/quay/clair/blob/main/LICENSE) |
192+
| <img src="./assets/readme-logos/keda.jpg" width="64px"> | **KEDA** | Enables event-driven autoscaling for Kubernetes applications | [kedacore/keda](https://github.com/kedacore/keda) | [Apache License 2.0](https://github.com/kedacore/keda/blob/main/LICENSE) |
193+
| <img src="./assets/readme-logos/k8s_external_secrets.jpg" width="64px"> | **Kubernetes External Secrets** | Syncs external secrets securely into Kubernetes clusters | [external-secrets/external-secrets](https://github.com/external-secrets/external-secrets) | [Apache License 2.0](https://github.com/external-secrets/external-secrets/blob/main/LICENSE) |
194+
| <img src="./assets/readme-logos/prometheus.jpg" width="64px"> | **Prometheus** | Collects metrics for monitoring, alerting, and performance insights | [prometheus/prometheus](https://github.com/prometheus/prometheus) | [Apache License 2.0](https://github.com/prometheus/prometheus/blob/main/LICENSE) |
195+
196+
---
165197

166198
## :question: FAQs & Troubleshooting
167199

@@ -185,6 +217,8 @@ Get updates on Devtron's development and chat with project maintainers, contribu
185217
</a>
186218
</p>
187219
220+
---
221+
188222
## :handshake: Contribute
189223

190224
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.
@@ -198,10 +232,14 @@ We are deeply grateful to all our amazing contributors!
198232
<a href="https://github.com/devtron-labs/devtron/graphs/contributors">
199233
<img src="https://contrib.rocks/image?repo=devtron-labs/devtron" />
200234
</a>
235+
236+
---
201237

202238
## :bug: Vulnerability Reporting
203239

204240
We at Devtron, take security and our users' trust very seriously. If you believe you have found a security issue, please report it to <b>security@devtron.ai</b>.
241+
242+
---
205243

206244
## :bookmark: License
207245

assets/readme-logos/argo.jpg

17.4 KB
Loading

assets/readme-logos/casbin.jpg

29.6 KB
Loading

assets/readme-logos/clair.jpg

15 KB
Loading

assets/readme-logos/dex.jpg

51.7 KB
Loading

assets/readme-logos/golang.jpg

83.6 KB
Loading

assets/readme-logos/grafana.jpg

15.8 KB
Loading

assets/readme-logos/helm.jpg

14.3 KB
Loading
20.6 KB
Loading

assets/readme-logos/keda.jpg

16 KB
Loading

0 commit comments

Comments
 (0)