Skip to content

README: Updated readme with deployment steps through devtron #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Feb 9, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added .DS_Store
Binary file not shown.
60 changes: 56 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,14 @@
This application uses the `node` container obtained from the [Docker Hub](https://hub.docker.com/_/node/)

## Setup
lone this repo and cd into the directory:
Clone this repo and cd into the directory:

```
git clone https://github.com/wercker/getting-started-nodejs.git
git clone https://github.com/devtron-labs/getting-started-nodejs
cd getting-started-nodejs
```

## Running
You can run the sample app in a couple of different ways. The first is to simply launch the executable:
You can run the sample app while executing this command -
```
node app.js
```
Expand All @@ -39,6 +38,59 @@ and then refresh your browser pointing to `http://localhost:8080` to see:
{"cities":["Amsterdam","Berlin","New York","San Francisco","Tokyo","London"]}}
```

## Getting started with deploying application through Devtron

Lets see how to deploy a custom nodejs app through Devtron.
Make sure Global Configurations are successfully saved and validated before deploying your application.

**STEP 1**
Login into your Devtron Dashboard, Go to >> Applications >> Create new App. Give an appropriate name to this App, choose the project in which you want to keep the app, and create it.

**STEP 2**
After creating the app, setup the configurations. Copy the repo URL https://github.com/devtron-labs/getting-started-nodejs and paste it the Git repo section of your App. Click save and move to next config.

**STEP 3**
Now choose your Docker build config, the repository where you want to keep your CI build image. Select the container registry from the drop-down.

**STEP 4**
Coming up next is configuring the deployment template. As this is a very simple nodejs application we will be only covering the required the configs.
```
ContainerPort :
port : 8080
servicePort : 80
```
`8080` is the port number on which my nodejs application is running.

Now, select the serviceType, keep it as `LoadBalancer`.

```
service:
type: LoadBalancer
```

**STEP 5**
Now, create a CI/CD workflow for deploying this application. Select the type of pipeline & you can also add “Pre-build” “Post-build” & "Docker build" stages as well. Next add your CD pipeline, by choosing in which environment you want to deploy your app in.

**STEP 6**
You can add or create secrets or configmaps as per your requirement. These values will be automatically mounted with pods and made available as volumes or as env variables as per your selection.

**STEP 7**
That’s it, now trigger your CI pipeline by selecting the latest image and deploy it on your chosen project.

**STEP 8**
After the successful deployment, check out your service manifest for fetching the LoadBalancer URL from the dashboard present in the App Details section.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

show them how they can get it from Devtron


![](/gifs/fetching_loadbalancer.gif)

**STEP 9**
Use this URL on your browser and you can get the output as.

```
{"cities":["Amsterdam","Berlin","New York","San Francisco","Tokyo"]}
```

Find out a detailed documentation about the configurations from here - https://docs.devtron.ai/devtron/user-guide/creating-application

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

also add link to detailed configuration document

---
Sign up for Wercker: http://www.wercker.com
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove this


Expand Down
21 changes: 0 additions & 21 deletions azure-pipelines-1.yml

This file was deleted.

21 changes: 0 additions & 21 deletions azure-pipelines.yml

This file was deleted.

56 changes: 0 additions & 56 deletions devtron-ci.yaml

This file was deleted.

Binary file added gifs/.DS_Store
Binary file not shown.
Binary file added gifs/fetching_loadbalancer.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.