devtron

README

Devtron is an open source software delivery workflow for kubernetes written in go.
Explore documentation »

Website · Blog · Join Discord · Twitter

📖 Menu

• Why Devtron
• Features
• Getting Started
• Documentation
• Compatibility Notes
• Community
• Contribute
• Vulnerability Reporting
• License

💡 Why Devtron?

It is designed as a self-serve platform for operationalizing and maintaining applications (AppOps) on kubernetes in a developer friendly way.

🎉 Features

Zero code software delivery workflow

• Workflow which understands the domain of kubernetes, testing, CD, SecOps so that you dont have to write scripts
• Reusable and composable components so that workflows are easy to contruct and reason through

Multi cloud deployment

• Deploy to multiple kubernetes cluster

Easy dev-sec-ops integration

• Multi level security policy at global, cluster, environment and application for efficient hierarchical policy management
• Behavior driven security policy
• Define policies and exception for kubernetes resources
• Define policies for events for faster resolution

Application debugging dashboard

• One place for all historical kubernetes events
• Access all manifests securely for e.g. secret obfuscation
• Application metrics for cpu, ram, http status code and latency with comparison between new and old
• Advanced logging with grep and json search
• Intelligent correlation between events, logs for faster triangulation of issue
• Auto issue identification

Enterprise grade security and compliances

• Fine grained access control; control who can edit configuration and who can deploy
• Audit log to know who did what and when
• History of all CI and CD events
• Kubernetes events impacting application
• Relevant cloud events and their impact on applications
• Advanced workflow policies like blackout window, branch environment relationship to secure build and deployment pipelines

Gitops aware

• Gitops exposed through API and UI so that you dont have to interact with git cli
• Gitops backed by postgres for easier analysis
• Enforce finer access control than git

Operational insights

• Deployment metrics to measure success of agile process. It captures mttr, change failure rate, deployment frequency, deployment size out of the box.
• Audit log to understand the failure causes
• Monitor changes across deployments and revert easily

🚀 Getting Started

Quick in stallation with default settings

This installation will use Minio for storing build logs and cache. Please make sure to edit the POSTGRESQL_PASSWORD value.

helm repo add devtron https://helm.devtron.ai
helm install devtron devtron/devtron-operator --create-namespace --namespace devtroncd \
--set secrets.POSTGRESQL_PASSWORD=change-me

For detailed instructions and other options, check out devtron installation documentation

🔑 Access Devtron dashboard

If you did not provide a BASE_URL during install or have used the default installation, Devtron creates a loadbalancer for you on its own. Use the following command to get the dashboard url.

kubectl get svc -n devtroncd devtron-service -o jsonpath='{.status.loadBalancer.ingress}'

You will get result something like below

[test2@server ~]$ kubectl get svc -n devtroncd devtron-service -o jsonpath='{.status.loadBalancer.ingress}'
[map[hostname:aaff16e9760594a92afa0140dbfd99f7-305259315.us-east-1.elb.amazonaws.com]]

The hostname mentioned here ( aaff16e9760594a92afa0140dbfd99f7-305259315.us-east-1.elb.amazonaws.com ) is the Loadbalancer URL where you can access the Devtron dashboard.

PS: You can also do a CNAME entry corresponding to your domain/subdomain to point to this Loadbalancer URL to access it at a custom domain.

Host	Type	Points to
devtron.yourdomain.com	CNAME	aaff16e9760594a92afa0140dbfd99f7-305259315.us-east-1.elb.amazonaws.com

Devtron Admin credentials

For admin login use username:admin and for password run the following command.

kubectl -n devtroncd get secret devtron-secret -o jsonpath='{.data.ACD_PASSWORD}' | base64 -d

Detail configuration options

Using devtron

• Deploying First Application
• Deploying Helm charts
• Configure Security policy
• Detail Userguide

📝 Compatibility notes

• It uses modified version of argo rollout
• Application metrics only works for k8s 1.16+

👥 Community

Get updates on Devtron's development and chat with the project maintainers, contributors and community members.

• Join the Discord Community
• Follow @DevtronL on Twitter
• Raise feature requests, suggest enhancements, report bugs at GitHub issues
• Read the Devtron blog

🤝 Contribute

Check out our contributing guidelines. Included are directions for opening issues, coding standards, and notes on our development processes.

🪲 Vulnerability Reporting

We at Devtron take security and our users' trust very seriously. If you believe you have found a security issue in Devtron, please responsibly disclose us at security@devtron.ai.

🔖 License

Devtron is available under the Apache License, Version 2.0