Documentation

PlatformerXE

Getting Started

Head over to the Platformer Console and sign up.

Sign up now

Create an Organization

To create a new organization, go to Administration -> Organizations and click New.

Create Organization - step 2Create Organization - step 2

Create and Invite Users to your Organization

To add a New User to your Organization, go to Administration -> Users and click New.

Create User - step 1

Add the new users email and select their Role in your Organization

Create User - step 2

The new User will be able to sign into the Platformer Console through the Invitation Link sent to their Email.

Create User - step 3

The number of users you can add will depend on your Plan

PlanNumber of Users per Organization
Freemium5
Pro100
UnlimitedUnlimited

Create a Project in your Organization

To create a new project, go to Administration -> Projects and click New.

Create Project - step 1

The maximum limits of projects per organization differ according to your Plan.

PlanNumber of Projects per OrganizationNumber of Users per Organization
Freemium35
Pro25100
UnlimitedUnlimitedunlimited

Deploying your first Application

First select the Organization and the Project you want your application to be deployed in.

Deploying your first app - Step 1

Then under Cloud in the side menu select Apps. To create a new application, click New (top right corner).

Deploying your first app - Step 2Deploying your first app - Step 3

Fill in the details and click save. Click on the newly created app on the list and click on the name to go to inside.

The Overview sections shows a summary of the current settings.

Deploying your first app - Step 5

Connect your Git Repository

The Repository section includes the three subsections: Repository, CI/CD Configuration and Docker Registry.

In Repository, you can add your own Github, Bitbucket and Gitlab (Gitlab Cloud or Gitlab Onpremise) repos.

Deploying your first app - Step 6

Define Build and Release Pipelines

With CI/CD Configuration, you can add your own configurations.

Deploying your first app - Step 7

Integrate your existing CI from Docker Registry (Optional)

With Docker Registry, you can push your builds to your own docker registry.

Deploying your first app - Step 8

Set up Monitoring and HealthChecks

Monitoring

The next section, Monitoring lets you create Health Check Policies ensure you have zero downtime with app deployments , create Utilization Alerts in case if it reaches a certain threshold amount and check CPU and memory usage of your application.

Deploying your first app - Step 9

Health Checks

Click Add Heath Check to create a Health Check to ensure you have zero downtime with app deployments.

Deploying your first app - Step 10

Utilization Alerts

Click Add Utilization Check to create a Utilization Check which send alerts if it reaches a certain threshold amount.

Deploying your first app - Step 11

Set up Runtime environment

Runtime section allows you to add runtime environment variables to your docker container.

Deploying your first app - Step 12

Set Environment Variables

To create an environment variable, click Add Runtime Variable.

Deploying your first app - Step 13

Add a Configuration File

Config files lets you mount configuration files to your docker container.

Deploying your first app - Step 14

To create a new configuration file click Add Config File.

Deploying your first app - Step 15

Builds

You can view your builds in the Builds section. The builds that you initiated in the CI/CD configurations under Repository section appear here.

Deploying your first app - Step 16

Click on Actions to either Deploy the build, View logs or Download logs.

Deploying your first app - Step 17

Advanced Configurations

Volumes

Volumes section lets you mount disks to your application.

Deploying your first app - Step 18

To mount a new volume click Add Volume Mount.

Deploying your first app - Step 19Deploying your first app - Step 20

Logs

The Logs section lets you view logs of your application. You can specify the Log Output, Severity, Date Range and Actions to perform.

Deploying your first app - Step 21

DNS

DNS sections lets you add your Domain/ Subdomain. To create a new DNS url, click New and enter the URL Domain.

Deploying your first app - Step 22