diff --git a/README.md b/README.md index 10ea5202a9..cae02ab980 100644 --- a/README.md +++ b/README.md @@ -7,12 +7,12 @@ Note: We have restructured the readme. If you are looking for Devtron's CI/CD ca -

Kubernetes Dashboard for a Centralized DevOps Hub

+

The Kubernetes Platform That Eliminates Operational Chaos


-«Explore Documentation» || +«Explore Documentation» || «Try Devtron Demo»
Website @@ -56,7 +56,9 @@ Out of the box, Devtron's Kubernetes Dashboard includes: - [Single Sign On (SSO)](https://docs.dashboard.devtron.ai/operator-guide/authorization/sso-login-services) to simplify onboarding and authenticating team members. - [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. -[Devtron](#install-devtron) helps you deploy, observe, manage & debug existing Helm apps in all your clusters. +[Devtron](#devtron-platform) helps you deploy, observe, manage & debug existing Helm apps in all your clusters. + +--- ## Devtron Dashboard @@ -113,6 +115,8 @@ kubectl -n devtroncd get secret devtron-secret -o jsonpath='{.data.ACD_PASSWORD} 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). +--- + ## Devtron Platform 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.
@@ -157,11 +161,39 @@ helm install devtron devtron/devtron-operator --namespace devtroncd \ --set security.enabled=true --set notifier.enabled=true \ --set security.trivy.enabled=true --set monitoring.grafana.enabled=true ``` -## :blue_heart: Technology + +--- + +## Core Tools and Technologies -Devtron is built on some of the most trusted and loved technologies: -
-

+Here are the components that Devtron uses internally as part of its own architecture: + +| Logo | Tool | Purpose | GitHub Repository | License | +| -------- | -------- | ---------- | ------------------- | ------- | +| | **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) | +| | **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) | +| | **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) | +| | **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) | +| | **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) | +| | **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) | +| | **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) | + + +--- + +## Optional Components + +Here are some of the optional components that Devtron supports: + +| Logo | Tool | Purpose | GitHub Repository | License | +| -------- | -------- | ---------- | ------------------- | ------- | +| | **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) | +| | **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) | +| | **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) | +| | **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) | +| | **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) | + +--- ## :question: FAQs & Troubleshooting @@ -185,6 +217,8 @@ Get updates on Devtron's development and chat with project maintainers, contribu

+--- + ## :handshake: Contribute 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! + +--- ## :bug: Vulnerability Reporting We at Devtron, take security and our users' trust very seriously. If you believe you have found a security issue, please report it to security@devtron.ai. + +--- ## :bookmark: License diff --git a/assets/readme-logos/argo.jpg b/assets/readme-logos/argo.jpg new file mode 100644 index 0000000000..3aed969cce Binary files /dev/null and b/assets/readme-logos/argo.jpg differ diff --git a/assets/readme-logos/casbin.jpg b/assets/readme-logos/casbin.jpg new file mode 100644 index 0000000000..70a871f362 Binary files /dev/null and b/assets/readme-logos/casbin.jpg differ diff --git a/assets/readme-logos/clair.jpg b/assets/readme-logos/clair.jpg new file mode 100644 index 0000000000..cb5919b0ed Binary files /dev/null and b/assets/readme-logos/clair.jpg differ diff --git a/assets/readme-logos/dex.jpg b/assets/readme-logos/dex.jpg new file mode 100644 index 0000000000..ef8ef5103e Binary files /dev/null and b/assets/readme-logos/dex.jpg differ diff --git a/assets/readme-logos/golang.jpg b/assets/readme-logos/golang.jpg new file mode 100644 index 0000000000..c31cf7cf89 Binary files /dev/null and b/assets/readme-logos/golang.jpg differ diff --git a/assets/readme-logos/grafana.jpg b/assets/readme-logos/grafana.jpg new file mode 100644 index 0000000000..a0c6444dd4 Binary files /dev/null and b/assets/readme-logos/grafana.jpg differ diff --git a/assets/readme-logos/helm.jpg b/assets/readme-logos/helm.jpg new file mode 100644 index 0000000000..2d59636f06 Binary files /dev/null and b/assets/readme-logos/helm.jpg differ diff --git a/assets/readme-logos/k8s_external_secrets.jpg b/assets/readme-logos/k8s_external_secrets.jpg new file mode 100644 index 0000000000..0787d29780 Binary files /dev/null and b/assets/readme-logos/k8s_external_secrets.jpg differ diff --git a/assets/readme-logos/keda.jpg b/assets/readme-logos/keda.jpg new file mode 100644 index 0000000000..7a50ebfb12 Binary files /dev/null and b/assets/readme-logos/keda.jpg differ diff --git a/assets/readme-logos/kubernetes.jpg b/assets/readme-logos/kubernetes.jpg new file mode 100644 index 0000000000..9a36c279f8 Binary files /dev/null and b/assets/readme-logos/kubernetes.jpg differ diff --git a/assets/readme-logos/nats.jpg b/assets/readme-logos/nats.jpg new file mode 100644 index 0000000000..502b5588d5 Binary files /dev/null and b/assets/readme-logos/nats.jpg differ diff --git a/assets/readme-logos/prometheus.jpg b/assets/readme-logos/prometheus.jpg new file mode 100644 index 0000000000..148c221651 Binary files /dev/null and b/assets/readme-logos/prometheus.jpg differ diff --git a/assets/readme-logos/trivy.jpg b/assets/readme-logos/trivy.jpg new file mode 100644 index 0000000000..a13665744e Binary files /dev/null and b/assets/readme-logos/trivy.jpg differ