Jelastic Dashboard Guide

The following guide will provide you with the basic information on Jelastic dashboard usage and will help you to get acquainted with the possibilities it provides.

To start with, you can check out the quick overview presentation below to get insights on the main functionality, available through the Jelastic intuitive UI:

Hopefully you have already created an account at Jelastic Cloud (otherwise, do not waste the time and register a new one according to the simple steps within the linked page).

When ready, enter your account at the chosen Jelastic installation by means of the dedicated widget at our main site  (available in the top right corner) For the further detailed exploration, simply access your dashboard with the help of our Jelastic site or by using the direct link (http://app.{hoster_domain}/), sign in with your credentials and go on.

Now you can start the detailed Jelastic dashboard exploration - here is the list of its main sections:

Creating and Managing Environments

1. Click New environment in the upper left corner of the dashboard.

new environment button

2. The Topology Wizard will be opened, where you can fully customize your environment settings.

The full possibilities of this window are described in the Setting Up Environment article.

environment topology wizard

After finishing configurations, type your Environment Name and click the Create button.

3. All of your environments will be listed in the upper pane of the admin panel, along with the following information within columns:

running environment
  • Name column includes the name (or alias if specified) of the environment, its domain and region icon. Using the triangle mark before the environment’s name, you can expand the list of nodes it includes.

  • Status column shows the permanent state of your environment (Running, Sleeping, Stopped) or some temporary interim process it is currently undergoing (Creating, Launching, Stopping, Cloning, Exporting, Installing, Migrating, Deleting).

  • Tags column displays Environment Groups this environment belongs to, custom docker containers and dockerized templates tags and name of deployed project.

  • Usage column shows the amount of cloudlets and percentage of available disk space that environment currently consumes. You can also find the Billing history billing history icon button here, which leads to a separate tab with statistics on your spends (both overall and for every node separately), divided according to the specified time period.

Function Icons for Environments

Hover over a running environment to see a few more icons showing up:
environment functional icons

1. Hover over the region environment region icon icon to instantly display its label (name). Clicking on it will open the Migration section of the Settings frame below.

2. Click the Open in browser open in browser icon icon to open the environment in a new browser tab.

Note: This option could be absent in case your environment does not include application server and/or load balancer layers.
3. Click on Settings  settings icon to open a separate tab with a number of configuration sections. There are eleven options here: Custom Domains, Custom SSL, SSH Access, Endpoints, Firewall, Monitoring, Collaboration, Change Owner, Migration, Export and Info.
  • Select Custom Domains to access the following suboptions: Domain binding and Swap domains.

    custom domains settings
    More info:
  • Choose the Custom SSL option and upload the necessary files in order to apply your custom SSL Certificate.

    Note: This feature can be configured only for the certified application servers and load balancers with Public IP attached.

    custom ssl settings
    More info:
  • In the SSH Access section, you can see the Public Keys and SSH Connect tabs. The first one allows to manage your public SSH keys and the second one shows how the connection to your environment can be established (either via SSH Gate or Web SSH).

    ssh access settings
    More info:
  • Within the Endpoints section, you can manage mapping of your containers TCP/UDP ports for ensuring their collaboration with external resources via a direct connection.

    endpoints settings

    More info: Endpoints

  • The Firewall section allows setting Inbound and Outbound Rules to manage connections to your containers. This allows to explicitly define which connections should be accepted and which ones - blocked.

    firewall settings

    More info: Container Firewall

  • Select Monitoring in order to start tracking the amount of resources your environment consumes.

    monitoring settings

    Use Load Alerts for setting new triggers (or adjusting the default ones) to receive special email notifications in case the specified resource’s usage exceeds the stated limits.

    Within the Auto Horizontal Scaling suboption you can configure triggers for changing a number of containers for the layers (except the Maven build node) depending on the CPU, Memory, Network, Disk I/O or Disk IOPS consumption.

    The Events History section contains records about all the events that occurred due to the configurations, set using the two above-mentioned sections.

    More info:
  • In the Collaboration section, you can view and manage the list of accounts, which have access to the current environment.

    collaboration settings

    In case you need to grant access to another user, click Add and fill in the Email field. You can also tick Change topology / SSH access if you would like to give such permissions. Click Save.

    More info: Account Collaboration

  • Click Change Owner in order to transfer environment to another user account within the confines of a single platform.

    change owner settings

    More info: Environment Transferring

  • Choose Migration to move your environment to another set of hardware.

    migration settings
    Note: Availability of this option, as well as its allowance for each particular environment region, depends on your hosting provider’s settings.
    More info:
  • Select Export in order to pack all your environment’s settings and data into a single downloadable file, that can be subsequently restored at another hosting provider’s platform for the creation of the identical and ready-to-use environment.

    export settings
    Note: Currently Windows nodes, StorageElastic VPSMaven and Docker containers are exported without any data inside, so you’ll need to transfer the required files and configurations manually.
    More info:
  • Switch to the Info section to see additional information on environment domain, its creator/owner (as they can differ due to the account collaboration feature), hardware region it belongs to and the date/time of creation.

    info settings

4. To Clone the environment, click on the appropriate clone environment icon button. In the opened frame, specify the name for a new environment and click Clone.

More info:

5. In order to Change the environment topology, select the needed option change environment topology icon. Perform the required changes in the appeared Topology Wizard dialog box and click Apply to submit them.

6. To Delete an environment, click on the red cross icon delete environment icon and confirm that you really want to do this by entering your password.

7. To change the status of an environment, use the Start start environment icon and Stop stop environment icon buttons (located in the Status environment column).

Note: When an environment is stopped, only the SettingsClone environmentDelete environment and Start buttons are available for it.

Also, the opened Settings tab for such environment will contain only four active options: CollaborationChange OwnerMigration and Info.

stopped environment settings

Function Icons for Each Instance

Click on the arrow key before environment name within dashboard to reveal the list of node groups it is comprised of (e.g. load balancers, application servers, databases, etc). You can also expand these layers to view the separate containers and deployed contexts within. Furthermore, each node is supplemented with a list of attached IP addresses (internal and external IPv4 / IPv6 ones).

Hover over a particular instance or container to see the pop-up icons with different functions.

instances functional icons
Use these icons to perform the following actions:
  • Click the Open in browser option to open the application server, database, balancer, VPS node, Docker container or application context in a new browser tab.
  • In order to Restart node(s), select the same-named option for a particular container or whole layer and confirm your decision.
  • Select the Config option to open the Configuration Manager tab, where you can change the node’s settings by means of uploading and modifying files.
  • Choose the Log option to view the log files for a separate node or for the set of the same-type ones. Log files list can differ depending on the selected instance.
  • Select the Statistics option to track the data on CPU, RAM, Network, Disk space and IOPS consumption for a separate node or a set of nodes in a real time.
  • Click the Web SSH option to connect to your container over SSH protocol directly in browser.
  • Some nodes can have additional options, such as Add-ons (for installing available pluggable modules) or Redeploy container(s) (custom dockers and dockerized templates only).
    Note: In particular, Windows-based nodes are supplied with a number of specific options, that are grouped under the Remote desktop remote desktop icon list, namely:
    • Open in browser provides access to the node’s admin interface via Guacamole RDP tool (not to be confused with the already described same-named option for the whole environment)
    • Reset RDP password allows to restore password for your remote desktop connection
    • Info reveals a short tip on establishing RDP connection to your IIS node
    • the last, direct link string, can be used for connecting to the server’s remote desktop via local client

    windows-based environment
    In addition, the IIS application server has a unique Publish info windows publish info icon list, which contains Info on direct apps deployment from Visual Studio IDE and the corresponding link.
  • The Additionally button allows you to configure Docker container settings (Variables, Links, Volumes and CMD / Entry Point). Also, depending on the node, it can contain other options (e.g. Reset Password, Info, etc).

When hovering over a separate node, you’ll see one more Set Alias set alias icon icon. It allows you to set an alternative name for your container instead of the default Node ID label (e.g. to define master and slave servers in a DB cluster). The same thing can be done with the layers and whole environment name (the domain name will remain unchanged).

node aliases

Import

Next to the Create environment option, you can find the Import button. It allows to upload .json, .jps, .cs, .yml or .yaml file in order to create a new environment (or modify the already existing one with an add-on) according to the settings, declared in it.

import button
Tip: In particular, this function can be used to import environment copy, that was previously exported from another Jelastic installation, and create the similar one at the current platform.

Within the opened Import frame, you’ll see three tabs and Examples link to the Jelastic JPS Collection with a number of ready-to-go solutions:

  • Local File - select the locally stored file (via the Browse button), that should be uploaded and executed on a Platform

    import local file
  • URL - type in or paste a direct link to the required manifest file

    import url
  • JSON - the in-built JSON editor can be used to insert and edit your code before the deployment, or even to declare your package from the scratch manually

    import jps

Marketplace

Upon clicking on the last Marketplace option at the top dashboard panel, you’ll access a separate frame with the Aps, Add-ons and Docker Containers sections inside.

marketplace button
  • The first Apps tab provides access to the list of preconfigured packaged applications.

    applications marketplace window

    Locate the desired package (using the categorized list or search box) and click Install in order to automatically create an appropriate environment and deploy the chosen application to it.

  • Within the Add-ons section, you can find a number of modules, which can be installed on top of the existing environment to modify it and get the advanced functionality.

    add-ons marketplace window
  • Choosing the Docker Containers suboption will open the panel, where you can find and subsequently deploy the desired Docker image through one of the available tabs:
    • Quick Start contains a set of the most popular templates (however, this tab is optional, so its availability depends on your hosting provider’s settings)
    • Search allows to find the required template within the official Docker Registry Hub
    • Custom section provides the ability to add your own template from a custom registry
    • Favorites tab lists solutions you’ve previously marked as favorite (with the gold star in the top right plank corner) to quickly access them

    docker containers marketplace window
The detailed information on the use of these sections can be found in the corresponding Marketplace article.

Deployment Manager

The Deployment Manager is located at the bottom of dashboard and is used to store applications to automate their subsequent deployment into your environments. There are two subsections within the tab:
  • Archive - stores the application package itself, which can be Upload from your local machine (Local file) or any external link (URL)
  • Git / SVN - saves the access credentials to your projects at the remote Git / SVN repositories; click the Add Repo button and specify the appropriate details

Depending on the selected deployment type, the process is following:

Tip: Read the Deployment Guide to find a number of links to the instructions on different programming languages deployment specifics.

Deployment from Archive

1. Click Upload and within the appeared dialog box provide the appropriate file either as Local file or URL:

archive deployment
Note: The maximum available size of the uploaded local file is 150 MB. If your application size exceeds this limit, please use the URL option for uploading.
Fill in the Comment field (if required) and Upload.

2. Hover over the file you want to deploy and click the appeared Deploy to button.

archive deploy to
3. In the opened Deploy frame, you need to obligatory select the target Environment. Next, you can just confirm the deployment (the default ROOT context will be used) or, optionally, specify such additional data as:
  • Context - sets the desired custom context; herewith, the available options may be limited due to the used programming language specifics (e.g. Python and Node.js have a single predefined deployment path only)
  • Hooks - applies the provided scripts either before or after deployment process
  • Deploy Strategy (for deployment into scaled servers) - allows to choose between Simultaneous deployment and Sequential deployment with delay options
  • Enable zero-downtime deployment (for PHP servers only) - adjusts (if option is ticked) the deployment flow to avoid application downtime

archive deploy dialog
Click Deploy to initiate the process itself.

Git / SVN Deployment

1. Click the Add Repo button and within the Add Repository window specify your application Name, choose repo type (Git or SVN), provide URL and authentication credentials (if required):

git svn deployment

You can just Add this project into Deployment Manager or Add + Deploy to immediately initiate deployment of this application.

2. After project is added, you can hover over to Deploy to, Edit or Delete it. Choose the first option to proceed with deployment.

git svn deploy to
3. In the opened Deploy frame, you need to obligatory select the target Environment. Next, you can just confirm the deployment (the default ROOT context will be used) or, optionally, specify such additional data as:
  • Branch - defines the used repository branch (master by default)
  • Context - sets the desired custom context; herewith, the available options may be limited due to the used programming language specifics (e.g. Python and Node.js have a single predefined deployment path only)
  • Build (for Java application deployments) - allows to choose the existing Maven build node (or add one into the target environment) and, if required, to select repository subdirectory
  • Hooks - applies the provided scripts either before or after deployment process
  • Deploy Strategy (for deployment into scaled servers) - allows to choose between Simultaneous deployment and Sequential deployment with delay options
  • Check and auto-deploy updates - enables periodical check ups for code changes in repository and, if any, project automatic deployment into your environment
  • Auto-resolve conflicts - prevents the occurrence of merge conflicts by updating the contradictory files to the repository version (i.e. locally made changes are discarded)
  • Enable zero-downtime deployment (for PHP servers only) - adjusts the deployment flow to avoid application downtime

git svn deploy dialog

Click Build and Deploy to initiate the process.

Tasks Panel

The Tasks panel is placed at the very bottom of the dashboard and contains live and historical data on the tasks that Jelastic engine is doing or has already done.

task manager on-going process
This panel includes the Date, Name and Status columns, which give you the detailed information on each task:
  • when the action has taken place
  • what has been performed
  • result of this action (i.e. Success if everything is OK or an error description if some problem occurred)

task manager: working with files

Task panel tracks all global processes (like Creating environment, Adding node(s) or Deploying context), as well as the subsequent changes and actions performed in the File manager (Creating file, Renaming file, Uploading file etc).

Account Settings

Click the Settings button at the top-right corner of the dashboard in order to access Account settings configurations.

account settings button
Here, you can find two major sections available: SSH Keys and Collaboration.

account settings tab
  • SSH Keys - allows to manage your account public and private SSH keys and, within the SSH Connect tab, provides the required steps to connect to your account via SSH Gate / allows to access particular node directly in browser using Web SSH

    The Public Keys subsection allows binding of a public SSH key to your account, required for getting the ability to securely access and manage your containers via this protocol.

    More info:

    The Private Keys one gives you the possibility to add the pre-generated private SSH keys to your Jelastic account. Subsequently, they can be used for authentication at your private GIT/SVN repositories, allowing to work with the remote secured projects directly from the Jelastic dashboard.

    More info: GIT/SVN Authentication via SSH

  • The Collaboration option includes two items - Shared by Me and Shared with Me. Here, the first one allows you to view accounts, which have access to some of your environments, manage their permissions and invite new users. The second one shows the collaborations, your account is included into.

    More info: Account Collaboration

Upgrade Trial Account & Balance

Depending on your account type (trial or billing) you’ll see either the Upgrade Account or Balance button at the top of the dashboard panel.

1. If you are a trial user, you can see the Upgrade Account button. Click it to open a drop-down menu with the following options: Learn about trial limitations, Learn about pricing and See statistics on recent resource usage.

upgrade trial account
  • Click the Upgrade Account option to get a fully functional account with no limitations.

    More info: Account Types

  • The Learn about trial limitations button will open the information about your account limits, provided software stacks and tariffs.

    More info: Quotas System

  • Click on Learn about pricing to be redirected to the hoster's page with information about pricing.

    More info: Pricing Model Overview

  • Select the See statistics on recent resource usage option to open your Billing history.
    More info: Monitoring Consumed Resources

2. If you are a billing user, you can click the Balance button to see such options as: your Balance, Refresh balance, Refill balance, Configure auto-refill, Payment methods, Quotas & Pricing, Billing history, View invoices.

account balance
  • Balance shows your current balance total and its components: cash and bonus. By clicking on this option you can open the Refill balance tab.
  • Refresh balance option allows you to see the changes of your balance while working in the dashboard.
  • Click on Refill balance to submit the payment.
  • Using the Configure auto-refill item you can set Auto refill of the balance by choosing one of the options: Weekly, Monthly or when Balance is less than specified sum.
  • Payment methods option gives you an opportunity to choose your default payment method or add a new one.
  • Click on the Quotas & Pricing item to see the information frame with a set of tabs about Jelastic pricing and account limitations. In addition, depending on your hosting provider’s settings, you may also see the additional tab with details on the available environment regions here.
  • Billing history shows your spends for the specified period, which can be arranged by such intervals as hour, day, week, month and year. The shown data is grouped by environments and by separate nodes (node groups) within. Here, the following information is provided: Name, resources consumption (Reserved / Dynamic Cloudlets, Paid Storage / Traffic) and total usage Cost.
  • Click on the View invoices option to see the invoices which should be paid.  

Help and Account Options

There are several additional options in the upper right corner of the dashboard:
  • Help
  • Account (email address)

The Help drop-down menu gives you access to the Contact support, Go to communityDocs, API, CLI, Video, Tutorial and Search Box options.
account help button
  • Contact support is a hyperlink to your hoster's Support page (sometimes available for billing users only)
  • The Go to community option links to the Jelastic online community at Stackoverflow
  • The Docs option is a hyperlink to the Jelastic Devs Documentation
  • The API option is a hyperlink to the Jelastic API Documentation
  • The CLI option is a hyperlink to the Jelastic CLI Overview
  • The Video option is a hyperlink to the Jelastic Youtube Channel
  • The Tutorial button calls a short overview of the main Platform benefits and guides through the step-by-step instruction for beginners, showing how to get started with Jelastic
  • The How do I..? search box redirects to the list of documents relevant to your request

The last option is your Account (email address). Click on it to open the drop-down list with the following options: Change password, Language and Signout.
general account actions
  • click Change password to open the same-named dialog box. Fill in the required fields (Current password, New password and Confirm password) and confirm your entries with the Change password button
  • use the Language option to change localization of the dashboard interface (if available)
  • click Sign out to leave the dashboard

Now you know all of the basic dashboard possibilities and hopefully won’t have any problems in using it. If you still have additional questions, please contact the Support team of your hosting provider or refer to our technical experts at Stackoverflow.