Installation

Install Pulzen Gateway in your environment

To install Pulzen Gateway in your environment, follow these steps:

Requeriments

  • Docker
  • Mongo DB

Docker specifications

  • Operating System: Linux
  • Memory: 2 GB
  • Cpu: 2

Step 1: Docker Run

Run the following command

docker run -d -p 8080:8080 --name pulzen-gateway-api pulzen/gateway:latest

Install on Azure as Azure Web App

To install Pulzen Gateway in your Azure environment, follow these steps:

Requeriments

  • Azure Account
  • Azure Web App
  • MongoDB Atlas Database instance

Web App specifications:

  • Operating System: Linux
  • Region: East US
  • SKU: Premium V2
  • Size: Small
  • ACU: 210 total ACU
  • Memory: 3.5 GB memory

Step 1: Create a new Web App

  1. Go to the Azure Portal.
  2. Click on the "Create a resource" button.
  3. Search for "Web App" and click on "Create".
  4. Fill in the required information and click on "Create".

Step 2: Configure the Web App

  1. Go to the "Configuration" section of the Web App.

Step 3: Deploy the Pulzen Gateway

  1. Go to the "Deployment Center" section of the Web App.
  2. Select the "Docker hub" option.
  3. Fill image with pulzen/gateway.

Step 4: Configure the environment variables

You need to add the following environment variables to the Web App. LICENSE_API_APP_KEY is need to get one contact us at cleveritgroup

  1. Go to the "Configuration" section of the Web App.
  2. Add the following environment variables:
    • AUTH_BASIC_USERNAME: admin
    • AUTH_BASIC_PASSWORD: admin
    • MONGODB: mongodb+srv://username:password@cluster/database
    • PROFILES_DEFAULT: bitbucket
    • LICENSE_API_APP_KEY: LICENSE_API_APP_KEY
    • LICENSE_API_URL: https://performance-license.ndrz.io/
  3. Add the variables depending on your VCS system (GitHub, Bitbucket, GitLab, Azure DevOps). Quick start

Mongo DB

Clever Perfromance uses MongoDB as a database. To create your MongoDB Atlas instance, follow these steps:

Create a new MongoDB Atlas instance

  1. Go to the MongoDB Atlas website.
  2. Click on the "Create a new cluster" button.
  3. Fill in the required information and click on "Create".
  4. We recomend to use the free tier cluster and then scale it as needed.

Create a Azure Cosmos for MongoDB API

  1. Go to the Azure Portal.
  2. Click on the "Create a resource" button.
  3. Search for "Azure Cosmos DB" and click on "Create".
  4. Fill in the required information and click on "Create".

Azure & Costs

The aplication can be deployed in Azure, using the Azure Web App service or Azure Kubernetes Service (AKS).

Azure Web App

This is the easiest way to deploy the application, but it has some limitations. The costs are based on the plan you choose, we recommend the Premium V3 plan.

Commits by Hours and Day of Week
  • The application connect to vcs via API and webhooks to get the data, all the data will be stored in the MongoDB database.
  • To deploy this application you can use our deploy on Azure Button.

Deploy to Azure

Persistence

The application uses MongoDB as a database. You can use the Azure Cosmos for MongoDB API service or a MongoDB Atlas instance, either way, you will have to pay for the service.

  • Azure Cosmos for MongoDB API: Use RU (Request Units) to pay for the service.

OpenAPI Specifications

API specifications can be viewed at the url: [URL]/swagger-ui/index.html