Try Devtron Enterprise for FREE!
Start Now
LogoLogo
WebsiteDevtron demoGithub RepoJoin Discord
main
main
  • Introduction
  • Getting Started
  • Install Devtron
    • Install Devtron with CI/CD
    • Install Devtron with CI/CD and GitOps (Argo CD)
    • Install Devtron without Integrations
    • Install Devtron on Minikube, Microk8s, K3s, Kind, Cloud VMs
    • Install Devtron on Airgapped Environment
    • Demo on Popular Cloud Providers
    • Backup for Disaster Recovery
    • Uninstall Devtron
    • FAQs
  • Install Devtron Enterprise Trial
  • Devtron Kubernetes Client
  • Configurations
    • Installation Configurations
    • Override Configurations
    • Ingress Setup
  • Global Configurations
    • Host URL
    • GitOps
    • Projects
    • Clusters & Environments
    • Git Accounts
    • Container/OCI Registry
    • Chart Repositories
    • Deployment Charts
    • Authorization
      • SSO Login Services
        • Google
        • GitHub
        • GitLab
        • Microsoft
        • LDAP
        • OIDC
          • Keycloak
          • Okta
        • OpenShift
      • User Permissions
      • Permission Groups
      • API Tokens
    • Notifications
    • Deployment Window
    • Approval Policy
    • External Links
    • Catalog Framework
    • Scoped Variables
    • Plugin Policy
    • Pull Image Digest
    • Tags Policy
    • Filter Condition
    • Lock Deployment Configuration
    • Image Promotion Policy
    • Build Infra
  • Devtron Upgrade
    • Update Devtron from Devtron UI
    • Upgrade to 1.5.0
    • 0.6.x-0.7.x
    • 0.5.x-0.6.x
    • 0.4.x-0.5.x
    • 0.4.x-0.4.x
    • 0.3.x-0.4.x
    • 0.3.x-0.3.x
    • 0.2.x-0.3.x
  • Usage
    • Applications
      • Create a New Application
      • Clone an Existing Application
      • Deploy a Sample Application
      • App Configuration
        • Git Repository
        • Build Configuration
        • Base Deployment Template
          • Deployment
          • Rollout Deployment
          • Job and Cronjob
          • StatefulSets
        • GitOps Configuration
        • Workflow Editor
          • CI Pipeline
            • Pre-Build/Post-Build Stages
            • Override Build Configuration
          • CD Pipeline
        • ConfigMaps
        • Secrets
          • External Secret Operator (ESO)
            • AWS Secrets Manager
            • Google Secrets Manager
            • HashiCorp Vault
        • Environment Overrides
        • Deleting Application
      • Build and Deploy
        • Triggering CI
        • Triggering CD
        • Rollback Deployment
        • Applying Labels to Images
      • App Details
        • Debugging Deployment And Monitoring
        • Using Ephemeral Containers
        • Application Metrics
      • Application Overview
    • Jobs
      • Create a new job
      • Configurations
      • Workflow Editor
      • Trigger Job
      • Overview
    • Application Groups
    • Software Distribution Hub
      • Tenants
      • Release Hub
    • Resource Browser
    • Resource Watcher
    • Charts
      • Charts Overview
      • Deploy & Observe
      • Examples
        • Deploying Mysql Helm Chart
        • Deploying MongoDB Helm Chart
      • Chart Group
    • Security
      • Security Scans
      • Security Policies
    • Bulk Edit
    • Integrations
      • Build and Deploy (CI/CD)
      • GitOps (Argo CD)
      • Vulnerability Scanning (Clair)
      • Notifications
      • Monitoring (Grafana)
    • Pipeline Plugins
      • Create Your Plugin
      • Our Plugins
        • Ansible Runner
        • Bitbucket Runner Trigger
        • Codacy
        • Code-Scan
        • Copacetic
        • Container Image Exporter
        • Copy Container Image
        • Cosign
        • CraneCopy
        • Dependency track - Maven & Gradle
        • Dependency track - NodeJS
        • Dependency track - Python
        • Devtron CD Trigger
        • Devtron CI Trigger
        • Devtron Job Trigger
        • DockerSlim
        • EKS Create Cluster
        • GCS Create Bucket
        • GitHub Pull Request Updater
        • GKE Provisioner
        • GoLang-migrate
        • Jenkins
        • Jira Issue Validator
        • Jira Issue Updater
        • K6 Load Testing
        • Pull images from container repository
        • Semgrep
        • SonarQube
        • SonarQube v1.1.0
        • Terraform CLI
        • Vulnerability Scanning
  • Resources
    • Glossary
    • Troubleshooting
    • Use Cases
      • Devtron Generic Helm Chart To Run CronJob Or One Time Job
      • Connect SpringBoot with Mysql Database
      • Connect Expressjs With Mongodb Database
      • Connect Django With Mysql Database
      • Pull Helm Charts from OCI Registry
    • Telemetry Overview
    • Devtron on Graviton
    • Release Notes
Powered by GitBook
On this page
  • Introduction
  • Creating Release Tracks and Versions
  • Adding Applications
  • Selecting Images
  • Deploying Release
  • Extras
  • Viewing Rollout Status
  • Putting a Release on Hold
  • Rescinding a Release
  • Adding a Release Note
  • Release Catalog

Was this helpful?

Export as PDF
  1. Usage
  2. Software Distribution Hub

Release Hub

PreviousTenantsNextResource Browser

Last updated 1 month ago

Was this helpful?

Prerequisite

Create a before proceeding with any action in Release Hub.

Introduction

This section allows you to define , create and version software releases, add applications, select container images, and deploy releases to specified tenant .


Creating Release Tracks and Versions

Who Can Perform This Action?

Users need to have super-admin permission to create release track.

This involves the creation of release tracks and software versions. A release track helps you organize and keep track of different versions of your software. So if you ship multiple products (say HRMS, Web Builder, Video Editing Tools), you can create separate release tracks for each.

  1. Click + Release Track.

    Figure 1: Creating New Release Track
  2. Give a name to the track, e.g., numero

  3. (Optional) Add a description of the track.

  4. Click Create Release Track.

    Figure 2: Entering Track Details
  5. Click + Create Release.

    Figure 3: Creating New Release
  6. Select a track (e.g., numero) from the Release Track dropdown.

    Figure 4: Choosing Release Track
  7. Enter a in Release Version field, e.g., 1.0.0

    Figure 5: Versioning the Release
  8. (Optional) Give a name to the release, e.g., numero-beta. If you don’t provide one, the name will be same as release version (i.e., 1.0.0).

  9. (Optional) Add a description of the release.

  10. Click Create Release.

    Figure 6: Saving Release Details

If you are creating your first release, you may proceed with the Create from scratch option. However, for subsequent versions of your release (say 1.0.1), you may clone an existing release (e.g., 1.0.0) as shown below. Please note, you can only clone releases belonging to the same track.


Adding Applications

Who Can Perform This Action?

Users need to have super-admin permission to add applications to a release track.

This involves the inclusion of applications you wish to rollout in the release version created by you.

  1. Click + Add Application button present within the release you created.

  2. Click the Search and add applications dropdown.

  3. Use the checkbox to add applications from your projects.

  4. Click Add Release Stage.

Importance of Release Stages

By default, your selected applications will be set to release in one go. However, you can also release them in stages. In other words, you can decide which set of applications should be released first, subsequently which ones to release next, and the ones to release last. For example, if you're adding a new payment system (backend) and an updated checkout page (frontend), you would release the payment system first to ensure payments can be processed correctly.

  1. Use the drag-and-drop feature to move applications from one stage to another.

The drag-and-drop feature is designed specifically for moving applications between different release stages. It is not meant to alter the sequence of applications within the same stage.

  1. Once you have finalized the sequence and stages, click Save Changes.


Selecting Images

Who Can Perform This Action?

Users need to have super-admin permission to select images for selected applications.

Note

  1. Click SELECT next to the image you wish to deploy from the list.

  2. Repeat the above steps for other applications you added in the release.

  3. Click Save.

Tip

In case you don’t have the correct images ready for any of your applications, you can partially save your changes at this point, and return once they are ready.

  1. You may add release instructions for each application using the in-built Markdown editor. This can be detailed deployment notes and configuration guidelines for the team.

  2. Before locking the requirements, make sure the release order is correct, add applications if needed, and include environments in tenants (if not done already). Once you have finalized them, click Lock Requirements.

Once you lock the requirements, Devtron will prevent any unsolicited modifications to your release by anyone (including you). However, you can re-edit it by clicking Unlock To Edit.


Deploying Release

Who Can Perform This Action?

Users with build & deploy permission or above (for the application and target environment) can deploy a release.

Prerequisite

This involves the deployment of the release to the specified tenant installations.

  1. Go to the Rollout Release tab.

  2. Your release needs to be marked as ready to proceed further. If it isn’t, you can mark it Ready for release from this screen.

    Optionally, you can also do so by changing the status from Draft state to Ready for release within your release track.

  3. Use the checkbox to select the applications belonging to the first release stage. You may use the filters on the left-hand side to make it easier.

  1. Click Deploy.

    If the application workflow has pre-deployment/post-deployment stage, you get a dropdown where you can specifically trigger either pre-deployment, deployment, or post-deployment stage.

  2. Once the applications from the first release stage are successfully deployed, select the applications from the subsequent release stage and deploy.

An application can be deployed on the tenant in the next release stage only if other applications in the previous stage are deployed successfully on the given tenant.

Here we covered the process of performing a production installation on just one tenant. Similarly, you can perform installations on your other tenants (if any).


Extras

Viewing Rollout Status

You can view the status of your release at a particular tenant under Rollout Status. Moreover, you can go to Rollout History tab to view the deployment history.

You can view the following statuses

Rollout Status
Description

All Tenants

Overview of rollout status across all tenants installations

Yet to Trigger

Shows tenant installations for which rollout has not yet started

Ongoing

Shows tenant installations for which deployment is currently in progress

Failed

Shows tenant installations where rollout has encountered issues because some deployment stage failed

Completed

Shows tenant installations where deployment has successfully finished and services are live

Apart from the rollout status, you can also see the release status:

  • If the applications are partially released, the release status shows Partially released.

  • If all the applications in a release are successfully deployed, the release status shows Completely Released.

  • Alternatively, you can view the release status directly in the release track too.

Putting a Release on Hold

If a release is put on hold, none of the applications (in any release stage) can be deployed in that release.

When to use:

  • When a release was marked as ready, but is still not ready for deployment

  • If issues are found during pre-deployment checks

  • When waiting for approval from stakeholders before proceeding

Why to use:

  • To prevent the release from being deployed prematurely

  • To allow time for additional testing, review, or completion of necessary tasks

  • To ensure that all requirements and dependencies are met before deployment

Rescinding a Release

When to use:

  • When a release is found to be buggy or has critical issues

  • If the release does not meet the required standards or specifications

  • When a decision is made to cancel the release entirely

Why to use:

  • To ensure that faulty or incomplete software is not deployed

  • To maintain the integrity and reliability of the software environment

  • To provide a clear indication that the release is no longer valid and should not be used

Adding a Release Note

In the Overview section, you get a Markdown editor to add release notes. You can add text, images, links, and many more to clearly communicate updates and changes in each release. This keeps everyone informed and might contribute to a smoother deployment process.

Release Catalog

Figure 7: Cloning an Existing Release
Figure 8: Adding Apps to Release
Figure 9: Choosing Applications
Figure 10: Dividing Release in Stages
Figure 11: Rearranging the Sequence

Select a workflow available for your application. All the available in the selected workflow will appear.

Figure 12: Selecting Image from Specific Workflow

Only the images that were built already will appear. If there are no images present, of the application first to obtain the image.

Figure 13: Repeating Steps for Other Applications
Figure 14: Adding Release Instructions
Figure 15: Locking Requirements

All your requirements need to be locked and must be configured.

Figure 16: Rollout Release Page
Figure 17: Marking a Release as Ready
Figure 18: Alternative Way of Marking
Figure 19: Pre/Post Deployment
Figure 20: Checking Rollout Status
Figure 21: Partial Release
Figure 22: Full Release
Figure 23: Alternative Way of Checking Status
Figure 24: Pausing a Release

When a release is rescinded, it is marked as invalid or buggy, and cannot be used for further deployments. This action ensures that that the release cannot be modified further and no applications within the rescinded release can be deployed. However, deploying from the of or will still be possible.

Figure 25: Cancelling a Release
Figure 26: Release Note Section in SDH

Based on the schema provided in the catalog framework, you can add relevant details for release. Refer for more details.

Figure 27: Release Catalog
trigger the CI pipeline
tenants
Build & Deploy page
Applications
Application Groups
Catalog Framework
Tenant
semantic version
images
release tracks
installations