Welcome, this document consists of Devtron Use Cases

In this comprehensive guide, you will find a wide range of use cases, illustrating how Devtron can help optimize and streamline various aspects of your development and deployment processes. Explore the possibilities and discover how Devtron can enhance your workflows and empower your teams. Explore the following use cases to gain insights into the potential of Devtron:

Run Cron Jobs or One Time Job using Devtron Generic Helm Chart

Connect SpringBoot with Mysql Database

Connect Expressjs With Mongodb Database

Connect Django With Mysql Database

Introduction

This document will help you to deploy a sample Spring Boot Application, using mysql Helm Chart

1. Deploy a mysql Helm Chart

To deploy mysql Helm Chart, you can refer to our documentation on Deploy mysql Helm Chart

2. Fork the Git Repository

For this example, we are using the following GitHub Repo, you can clone this repository and make following changes in the files.

*Configure application.properties

Set the database configuration in this file.

spring.datasource.url=jdbc:mysql://<service-name>/<mysql database-name>
spring.jpa.hibernate.ddl-auto=update
spring.jpa.show-sql=true
spring.datasource.username=<mysql-user>
spring.datasource.password=<mysql-password>
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.MySQL5Dialect
spring.jpa.open-in-view=true

Configure the Dockerfile

# syntax=docker/dockerfile:experimental
FROM maven:3.5-jdk-8-alpine as build
WORKDIR /workspace/app

COPY pom.xml .

RUN mvn -B -e -C -T 1C org.apache.maven.plugins:maven-dependency-plugin:3.0.2:go-offline

COPY . .
RUN mvn clean package -Dmaven.test.skip=true


FROM openjdk:8-jdk-alpine
RUN addgroup -S demo && adduser -S demo -G demo
VOLUME /tmp
USER demo
ARG DEPENDENCY=/workspace/app/target/dependency
COPY --from=build /workspace/app/target/docker-demo-0.0.1-SNAPSHOT.jar app.jar
ENTRYPOINT ["java","-jar", "app.jar"]

3. Create Application on Devtron

To learn how to create an application on Devtron, refer to our documentation on Creating Application

*Git Repository

In this example, we are using the url of the forked Git repository.

*Docker configuration

Give, the path of the Dockerfile.

**_Configure Deployment Template*_

Enable Ingress, and give the path on which you want to host the application.

*Set up the CI/CD Pipelines

Set up the CI/CD pipelines. You can set them to trigger automatically or manually.

*Trigger Pipelines

Trigger the CI Pipeline, build should be Successful. Then trigger the CD Pipeline, deployment pipeline will be initiated, after some time the status should be Healthy.

4. Final Step

*Test Rest API

It exposes 3 REST endpoints for it's users to create, to view specific student record and view all student records.

To test Rest API, you can use curl command line tool

Create a new Student Record

Create a new POST request to create a new Transaction. Once the transaction is successfully created, you will get the student id as a response.

Curl Request is as follows:

sudo curl -d '{"name": "Anushka", "marks": 98}' -H "Content-Type: application/json" -X POST http://<hostname>/<path-name>/create

View All Student's Data

To view all student records, GET Request is:

path will be the one that you have given in Step 3 while configuring the Deployment Template.

http://<hostname>/<path>/viewAll

View student's data By student ID

To view student data by student id, GET Request is:

http://<hostname>/<path>/view/<id>

path will be the one that you have given in Step 3 while configuring the Deployment Template.

Introduction

Devtron supports the installation of from both: Helm and . Unlike Helm repos, OCI registries do not have an index file to discover all the charts. However, Devtron makes it easier for you to populate your charts from multiple sources to the .

Prerequisites

• Helm Chart(s)

• OCI-compliant Registry (e.g. Docker Hub and )

You must to Devtron with the Use as chart repository option enabled.

Tutorial

Populating your Charts to the Chart Store

1. Go to Global Configurations → Container/OCI Registry.

2. Search your OCI registry in the list, and click it.

3. In the List of repositories, add the chart repo(s). The format should be username/chartname. You can find the username from your registry provider account.
4. Click Save or Update.

5. From the left sidebar, go to Chart Store.

6. You can find your chart(s) either by using the search bar or by selecting your chart source.

You have successfully pulled your charts to the chart store.

Unable to find your Charts?

Deprecated charts won't show up in the Chart Store unless you enable the Show deprecated charts filter as shown below

Or, you may try performing a resync as shown below

Removing your Chart from the Chart Store

1. Go to your OCI registry settings in Devtron.

2. In the List of repositories field, remove the unwanted chart repo.
3. Click Update.

The removed chart would no longer appear in the Chart Store.

Devtron also supports Job and Cronjob pipelines. If you need to regularly update the image and configurations of your cronjob/job, you should prefer to create a pipeline,To know more about this you can refer the link .

Using Devtron-generic-Helm Chart to run Cron Job or One Time job

You can discover over 200 Charts from the Devtron Chart store to perform different tasks such as to deploy a YAML file.

You can use Devtron's generic helm chart to run the CronJobs or one time Job.

Select the devtron-charts/devtron-generic-helm chart from the Devtron Chart Store.

Select the Chart Version and the Chart Value of the Chart.

And, then click on Deploy

Configure devtron-generic-helm chart

Click on Deploy Chart

In values.yaml, you can specify the YAML file that schedules the CronJob for your application.

Introduction

Django is a free, open-source web framework written in Python programming language. It allows for scalability, re-usability, and rapid development. Django can be connected to different databases like MySQL, PostgreSQL, etc.

1. Deploy a mysql Helm Chart

To deploy mysql Helm Chart, you can refer to our documentation on

2. Fork the Git Repository

For this example, we are using the following , you can clone this repository and make following changes in the files.

*Configure Database Settings

Go to mysite/settings.py.

The settings.py contains the configuration for your SQL database. Make sure the configurations in settings.py matches the configurations of the mysql Helm Chart, that you have deployed in Step 1.

3. Create Application on Devtron

*Git Repository

In this example, we are using the url of the forked Git Repository.

*Docker configuration

Give, the path of the Dockerfile.

*Configure Deployment Template

Enable Ingress, and give the path on which you want to host the application.

*Set up the CI/CD Pipelines

Set up the CI/CD pipelines. You can set them to trigger automatically or manually.

*Trigger Pipelines

Trigger the CI Pipeline, build should be Successful, then trigger the CD Pipeline, deployment pipeline will be initiated, after some time the status should be Healthy.

4. Final Step

Check the Django app connected to mysql database, running successfully by hitting your application url.

The syntax is: http://<hostname>/<path>/

path will be the one that you have given in Step 3 while configuring the Deployment Template.

Introduction

In this application, you will learn about how to create a Expressjs Application that connects to mongoDb.

Follow the below-mentioned steps, to deploy the application on Devtron using mongoDb Helm Chart.

1. Deploy mongoDb Helm Chart

To deploy mongoDb Helm Chart, you can refer to our documentation on

2. Fork the Git Repository

For this example, we are using the following , you can clone this repository and make following changes in the files.

*Dockerfile

This is the Dockerfile. This exposes our expressjs application to port number 8080

*db.js File

This file will be used to connect to our database. This will include the service-name of the mongoDb Helm Chart, that you have deployed in Step1.

The syntax is as follows:

<service-name>:27017/<database-name>

This maps our service name to mongoDb's port number 27017.

3. Create Application on Devtron

*Git Repository

In this example, we are using the url of the forked Git Repository.

*Docker configuration

Give, the path of the Dockerfile.

*Configure Deployment Template

Enable Ingress, and give the path on which you want to host the application.

*Set up the CI/CD Pipelines

Set up the CI/CD pipelines. You can set them to trigger automatically or manually.

*Trigger Pipelines

Trigger the CI Pipeline, build should be Successful, then trigger the CD Pipeline, deployment pipeline will be initiated, after some time the status should be Healthy

4. Final Step

Check the Expressjs app connected to mongodb database, running successfully by hitting your application url.

The syntax is: http://<hostname>/<path>/

path will be the one that you have given in Step 3 while configuring the Deployment Template.

The output of our application would be as follows:

You can see that we are getting the JSON response. We have successfully connected our expressjs application to the mongoDb database.