DOCSEARCHbyAlgolia
Submit Docs

Devtron Documentation

repository·main·Indexed 26 days ago

https://github.com/devtron-labs/devtron

An AI-native Kubernetes management platform that unifies application and infrastructure management. Devtron provides a centralized DevOps hub for deploying, observing, managing, and debugging applications across multiple Kubernetes clusters. The platform includes features for CI/CD, GitOps, SSO integration via Dex, and a lightweight deployment dashboard called Hyperion for resource grouping and multi-cluster observation.

Tokens
149.1K
Snippets
245
Records
756
Agent score
90%

What's inside Devtron

  1. Overview of Hyperion Dashboard

    main
    Hyperion is a lightweight Kubernetes deployment dashboard designed for Development and Infrastructure teams. It provides resource grouping for easier debugging and monitoring of microservices. Users can upgrade from Hyperion to the full Devtron platform to access more comprehensive full-stack features.

  2. Overview of Software Distribution Hub (SDH)

    main

    Software Distribution Hub (SDH) is an enterprise-grade platform designed to simplify the packaging, versioning, and delivery of software products across multiple clients or environments. It is specifically built for scenarios involving:

    • Tenanted Deployment: Managing separate application and data layers for distinct clients (tenants).
    • Complex Release Management: Centralizing software updates and ensuring collaboration between Release Managers, Developers, and DevOps.
    • Visibility and Monitoring: Providing stakeholders (SREs, POCs, etc.) with clear insights into release statuses and debugging information.
    • Standardization: Eliminating inconsistent deployment processes and manual errors through automated, requirement-enforced rollouts.

  3. Overview of Devtron Jobs

    main
    Devtron Jobs allow for the manual and automated execution of your source code. Unlike standard CI/CD pipelines, a Job pipeline is limited strictly to your source code, allowing you to execute tasks quickly and easily without the overhead of a full CI/CD lifecycle. This optimizes execution time for code-specific tasks. You can also configure preset plugins within your job pipeline.

  4. Overview of Devtron

    main
    Devtron is a tool integration platform for Kubernetes designed to manage the lifecycle of microservices. It provides an intuitive web interface to integrate CI/CD, security, cost, debugging, and observability. Devtron allows you to deploy, observe, manage, and debug existing Helm applications across multiple Kubernetes clusters.

  5. Overview of Build and Deploy (CI/CD) features

    main

    The Devtron CI/CD integration automates software build and deployment workflows with the following capabilities:

    • Scalable CI Workers: Uses Kubernetes auto-scaling and centralized caching for cost-efficient workers.
    • Code Quality: Supports pre-CI and post-CI integrations for monitoring.
    • Security: Seamless integration with Clair for image vulnerability scanning.
    • Deployment Strategies: Supports Blue/Green, Rolling, Canary, and Recreate strategies.
    • GitOps & CD: Implements GitOps for Kubernetes state management and integrates with ArgoCD for continuous deployment.
    • Observability:
      • Debugging via logs, events, manifests, or container exec.
      • Deployment metrics: deployment frequency, lead time, change failure rate, and mean-time recovery.
      • Grafana integration for application metrics (CPU, memory, status codes, throughput, and latency).

  6. Overview of Devtron capabilities

    main

    Devtron is an open-source software delivery workflow for Kubernetes written in Go. It is designed as a self-serve platform for operationalizing and maintaining applications (AppOps) on Kubernetes in a developer-friendly way.

    Key capabilities include:

    • Zero code software delivery: Workflows for Kubernetes, testing, CD, and SecOps that use reusable and composable components instead of custom scripts.
    • Multi-cloud deployment: Support for deploying to multiple Kubernetes clusters (currently supports AWS; GCP and Azure support are coming soon).
    • DevSecOps integration: Hierarchical security policy management at global, cluster, environment, and application levels, including behavior-driven policies and resource/event policies.
    • Application debugging dashboard: Centralized view for historical Kubernetes events, secure manifest access (with secret obfuscation), application metrics (CPU, RAM, HTTP status, latency), advanced logging (grep and JSON search), and intelligent correlation between events and logs.
    • Enterprise security: Fine-grained access control, audit logs, CI/CD event history, and advanced workflow policies like blackout windows and branch-environment relationships.
    • GitOps integration: GitOps functionality exposed via API and UI, backed by Postgres for easier analysis.
    • Operational insights: Out-of-the-box deployment metrics including MTTR, change failure rate, deployment frequency, and deployment size.

  7. Understand the behavior of locked deployment keys

    main

    When deployment keys are locked, the following behaviors occur for non-super-admins:

    • Visibility: Users can hide or unhide locked keys in the UI.
    • Basic Mode vs. Advanced (YAML) Mode: In 'Basic' mode, locked keys may still be displayed in the GUI. Users can attempt to modify them, but the system will block the save operation.
    • Validation on Save: If a user attempts to save changes that include locked (non-eligible) keys, a modal window will appear highlighting the non-eligible edits.
    • Saving Permissible Changes: If a user edits both locked and unlocked keys, they must check the box Save changes which are eligible for update to save only the allowed modifications. The locked keys will be excluded from the update.
    • Permissions: Only a super-admin, manager, or application admin can edit configuration values. If the template is also a 'protected template', changes will trigger the standard configuration approval flow.

  8. Understand the 'Login as administrator' option

    main

    When Devtron is installed for the first time, it creates a default administrator user and password with unrestricted access. This option allows you to log in using these initial credentials.

    Best Practice: After the initial login, it is recommended to configure an SSO service (such as Google or GitHub) and add your users via SSO for subsequent logins.

  9. Devtron Dashboard Features

    main

    The Devtron Kubernetes Dashboard provides visibility and management capabilities for clusters, including:

    • Helm Application Management: Streamlined deployment, configuration, and rollback of Helm apps.
    • Resource Browser: Visualization and management of cluster resources (Nodes, Pods, ConfigMaps, CRDs, etc.).
    • Single Sign On (SSO): Simplified team onboarding and authentication.
    • Fine Grained RBAC: Access control for Dashboard and Cluster resources.
    • Configuration Drift: Compare and reconcile drifts across environments.
    • Multi-cluster Management: Single pane of glass for Helm, ArgoCD, and FluxCD across multiple clusters.

  10. Understand Deployment Windows

    main

    Devtron's Deployment Window feature allows you to define specific timeframes during which application deployments or other critical actions are either blocked or allowed in specific environments. This helps prevent unplanned deployments during peak business hours or critical periods.

    Restricted Actions: When a deployment window is active and blocking, the following actions are restricted:

    • Deployment
    • Rollback
    • Hibernation
    • Restart Workloads
    • Deletion of Workloads
    • Deletion of CD Pipeline

    Note: Users explicitly exempted from the window can still perform these actions.

    Window Types:

    TypeDefinitionPriority
    Blackout WindowTime period during which deployments are not allowed.Higher priority if overlapping with Maintenance Window.
    Maintenance WindowOnly time period during which deployments are allowed.Lower priority if overlapping with Blackout Window.

  11. Understand Devtron Telemetry Data Collection

    main
    Devtron collects anonymous, non-PII (Personally Identifiable Information) telemetry data to understand product usage and prioritize development. The data is statistical in nature and cannot be used to uniquely identify a user. Data is sent to a Posthog server and access is strictly limited to the Devtron team.

  12. Benefits of using AWS Graviton for Devtron

    main

    Running Devtron on AWS Graviton (Arm-based) instances provides several performance and cost advantages compared to traditional AMD instances:

    • Reduced Build Time: Building Graviton architecture on Graviton machines reduces build time by approximately 30%.
    • Lower Resource Utilization: Devtron micro-services exhibit lower resource consumption on Graviton, specifically:
      • ~5% less memory utilization.
      • ~2% less CPU utilization.
    • Cost Efficiency: Lower resource requirements translate directly to cost savings in cloud operations.