The following guide will provide you with the necessary information on the CirrusGrid dashboard usage and will help you to get acquainted with the offered possibilities.
To start with, you can check out the quick overview video below to get insights on the main functionality, available through the CirrusGrid intuitive UI:
Let’s start our detailed exploration of the CirrusGrid dashboard:
1. Click New Environment in the upper left corner of the dashboard.
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.
After finishing configurations, type your Environment Name, and click the Create button.
3. All of your environments will be listed in the central panel of the dashboard.
The following information within the columns:
- 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 current state of your environments (Running, Sleeping, Stopped, Creating, Launching, Stopping, Cloning, Redeploying, Exporting, Installing, Migrating, Deleting).
- Tags column displays Environment Groups this environment belongs to, versions (tags) of the containers, and the name of the deployed project.
- Usage column shows the current load (i.e. cloudlets and disk space usage). You can also find the Billing History button here, which leads to a separate tab with statistics on your spends on the current environment.
Hover over a running environment to see multiple icons for its management: Set Alias, Region, Open in Browser, Settings, Change Environment Topology, Clone Environment, Start/Stop, Delete Environment, Add/Edit Env Groups.
Use Set Alias icon to provide an alternative environment name (domain will remain unchanged).
You can hover over the environment to instantly display its region (if multiple ones are available). Click on the appropriate icon (can vary based on your particular platform) to jump to the Migration tab of the environment settings section.
Click the Open in Browser icon to open the environment in a new browser tab.
4. Click on Settings to open a separate tab with numerous configuration panels, check the detailed description in the linked section.
5. To Change Environment Topology, select the needed option. Perform the required changes in the appeared Topology Wizard dialog box and click Apply to submit them.
6. To Clone Environment, click on the appropriate button. In the opened frame, specify a name for the new environment and click Clone.
7. To change the status of the environment, use the Start and Stop buttons.
There are eleven options within the environment Settings tab: Custom Domains, Custom SSL, SSH Access, Endpoints, Firewall, Monitoring, Collaboration, Change Owner, Migration, Export, and Info.
1. Select Custom Domains to access the following suboptions: Domain Binding and Swap Domains.
2. Choose the Custom SSL option and upload the necessary files to apply your custom SSL certificate.
3. In the SSH Access section, you can see the Public Keys, SSH Connection, and SFTP / Direct SSH Access tabs. The first one allows managing your public SSH keys. The second one shows how to access your environment (either via SSH Gate or Web SSH). The third provides details on the connection over the SFTP/FISH protocols.
4. Within the Endpoints section, you can manage the mapping of your containers TCP/UDP ports for ensuring their collaboration with external resources via a direct connection.
More info: Endpoints
5. The Firewall section allows setting Inbound and Outbound Rules to manage access to your containers. These rules allow to explicitly define which connections should be accepted and which ones – blocked.
More info: Container Firewall
6. Select Monitoring to configure resource consumption tracking for the environment.
Use Load Alerts for setting new triggers (or adjusting the default ones) to receive the appropriate email notifications in case the specified resource’s usage exceeds the stated limits.
Within the Auto Horizontal Scaling suboption, you can configure triggers to control containers number within the layers (except the Maven build node). Scaling conditioning is defined based on the CPU, Memory, Network, Disk I/O, and Disk IOPS consumption.
The Events History section contains records about all the events that occurred due to the triggers configured in the subsections mentioned above.
7. In the Collaboration section, you can view and manage the list of accounts, which have access to the current environment.
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
8. Click Change Owner to transfer environment to another user account within the confines of a single platform.
More info: Environment Transferring
9. Choose Migration to move your environment to another set of hardware (region).
More info: Environment Migration between Regions
10. Select Export to pack all your environment’s settings and data into a single downloadable file. Subsequently, it can be restored at another hosting provider’s platform, creating an identical environment copy.
11. Switch to the Info section to see additional information on the environment Domain, its Owner and Creator (can differ due to the account collaboration feature), Region, the Creation Date.
That’s all of the environment settings.
Click on the arrow key before the environment name within the dashboard to reveal the list of node groups it is consists 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 layer or container to see the pop-up icons with different functions.
Use these icons to perform the following actions:
- Use Set Alias option to set an alternative name for your layer/nodes (e.g. to define master and slave servers in a DB cluster).
- Click Open in Browser to access a node of the layer in a new browser tab (can be hidden for some stacks, e.g. Shared Storage or Maven build node).
- Select the Restart Node(s) option to restart the appropriate service inside a particular container or within the whole layer.
- Select the Config option to open the configuration file manager tab, where you can adjust node settings by modifying/removing existing and creating/uploading new files.
- Choose the Log option to view the log files for the nodes of the layer. A list of log files varies based on the selected instance.
- Click 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 real-time.
- Select the Web SSH option to connect to your container over SSH protocol directly in the browser.
- Use the Redeploy Container(s) option to update nodes to the preferred tag (version).
- Some nodes can have additional options, such as Add-Ons (for installing available pluggable modules) or Remote Desktop (for managing Windows-based nodes).
- The Additionally list allows you to configure container settings (Variables, Links, Volumes, CMD / Entry Point) and view SFTP / Direct SSH Access details. Also, depending on the node, it can contain other options (e.g. Reset Password or Admin Panel Login).
Next to the New Environment option, you can find the Import button. It processes the uploaded .json, .jps, .cs, .yml, or .yaml file to create a new environment (or modify the already existing one with an add-on) according to the settings, declared inside.
Within the opened Import frame, you’ll see three tabs and Examples link to the Jelastic JPS Collection with numerous ready-to-go solutions:
- Local File – select the locally stored file (via the Browse button), which should be uploaded and executed on the platform
- URL – provide a direct link to the required manifest file
- JPS – the in-built JSON/YAML editor can be used to insert and edit your code before the deployment, or even to declare your package from scratch manually
For the detailed overview check the appropriate Environment Import document.
Upon clicking on the last Marketplace option at the top dashboard panel, you’ll access a separate frame with a list of the pre-packaged solutions for automatic installation.
These packages are divided into two groups: Applications to create new environments and Add-Ons to adjust existing ones. Herewith, you can search for the solution from both these groups using the appropriate field at the top-left corner.
Once you’ve located the desired package, click Install for it, and follow the steps in the appeared installation frame.
For the detailed overview check the appropriate Marketplace article.
CirrusGrid PaaS provides a possibility to create Environment Groups, which help to categorize your environments. For example, the administration of multiple projects becomes much simpler when each one is organized into a dedicated environment group. If needed, you can apply further division by creating subgroups, e.g. development/testing/production, servers/databases/storages, etc.
CirrusGrid PaaS provides a built-in search option for the dashboard. The core functionality is straightforward – access the Search form at the top-right corner (or use the Ctrl+F/Cmd+F shortcut), type a search term(s) and hit Enter. For example, you can locate a container by its IP/ID; search for the particular deployed project/environment; find and deploy applications from CirrusGrid Marketplace.
Herewith, the implemented search engine is highly customizable, which allows getting the most accurate results for the requests. Among the main options:
- special characters for search expression (e.g. “–” prefix to exclude a term or “*” wildcard)
- search source (either whole account or the current environment group)
- categories filter to search among the selected entities (e.g. exclude the Marketplace packages or look for IPs only)
Additional details can be found in the help hint for the search form (circled in the image above).
Deployment Manager is located at the bottom of the dashboard. It stores applications to automate their subsequent deployment into your environments. There are two subsections within the tab:
- Archive – stores the application package itself, Upload it from your local machine (Local File) or via 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 required details
Once your package is added to the Deployment Manager, it can be automatically deployed to the required environment by following the linked guide.
The Tasks panel is placed at the very bottom of the dashboard and contains live and historical data on the tasks that CirrusGrid PaaS is doing or has already done.
The following data is provided for each record:
- Status – shows a state of the operation: spinner (in progress), green (success) or red (error) dot
- Time – shows a starting time of the respective operation with the latest records displayed at the top of a tab (additionally, all tasks are grouped by days)
- Environment – displays the name of the environment where the action was performed (or dash “–” if there is no target environment)
- Task – provides an operation description and, in case of failure, error
- Duration – shows an execution time of a task
In case you need to view a complete list of actions performed on the account (i.e. not just the recent ones), switch to the Active Log tab (the magnifying glass icon). Here, you are provided with an advanced search and filter options to quickly locate the required tasks:
- search is performed by the parameters and server response (i.e. the data upon expanding an operation) not the action description
- you can set the date range as last 1/6/24 hour(s), current/previous week, current month, or provide your custom period
- tick Errors only to hide all the successfully executed operations
Using the Tasks panel, you can always track the activity on your account, as well as troubleshoot any issues.
Click the Settings button at the top-right corner of the dashboard to access User Settings configurations.
Here, you can find the following sections: Account, Access Tokens, SSH Keys, and Collaboration.
1. The Account section allows managing two-factor authentication for your account, as well as changing the password.
2. Within the Access Tokens tab, you can configure personal access tokens for your account.
3. The SSH Keys / SSH Access points open the same section with four sub-tabs:
- Public Keys – stores public keys added to the platform (required for remote access via local SSH client)
- Private Keys – lists private keys added to the platform (required for access to your private Git repository over SSH)
- SSH Connection – shows the required steps to connect to your account via SSH Gate and allows accessing particular nodes directly in the browser using Web SSH
- SFTP / Direct SSH Access – displays connection data for SFTP/FISH protocols
4. The Collaboration option includes two items – Shared by Me and Shared with Me. The first one allows managing users that you’ve shared environments with, while the second one shows the collaborations that include your account.
For a detailed overview of the Account Collaboration feature, refer to the linked guide.
Depending on the account type (trial or billing), either the Upgrade Account or Balance sections at the top of the dashboard panel are displayed.
1. The default type of all accounts is trial, which provides a free of charge hosting period (limited by time or bonus money) with the restriction on the amount of provided resources.
Expand the Upgrade Account drop-down menu to see the following options:
- Use the Upgrade Account button to get a fully functional account with no limitations.
- The Learn about Trial Limitations option opens the appropriate Account Limits tab within the Quotas & Pricing frame.
- Click on Learn about Pricing to be redirected to the documentation page with information about the pricing model.
- Select the See statistics on recent resource usage option to open account’s billing history.
2. Billing accounts are spared from any limitations but are charged according to the hosting provider’s pricing.
Click the Balance button to expand a list of the following options:
- Balance shows the current balance of the account (both Cash and Bonus). By clicking on the section, you can open the Refill Balance tab.
- Refresh Balance option updates balance data to the most actual value.
- Click on Refill Balance to submit the payment.
- Using the Configure auto-refill point the Auto Refill of the balance can be enabled (based on the following conditions: Weekly, Monthly or when Balance less than specified sum).
- Payment Methods option gives an opportunity to choose the default payment method for the account or add a new one.
- Click on the Quotas & Pricing item to see the information frame with a set of tabs about platform Regions (if multiple ones are available), Pricing, and Account Limits.
- Billing History shows account spends for the specified period.
- Click on the View Invoices option to go to the external billing system panel with the account invoices, orders, payments, etc.
The last two sections of the dashboard are Help and Account (email address).
1. The Help drop-down menu provides access to multiple useful links:
- Contact Support redirects to the platform customers support page (sometimes available for billing users only)
- Go to Community is a link to the Jelastic online community at Stackoverflow
- Documentation navigates to the CirrusGrid Devs Documentation
- Video points to the Jelastic YouTube Channel
- Tutorial starts a short, interactive guide, which explains the basics of working with the platform
- How do I..? shows a list of documents relevant to your request
2. Within the Account (email address) drop-down list, the following options are available:
- Settings redirects you to the User Settings section
- Change Password opens the same-named dialog box, where you need to fill in the required fields (Current Password, New Password, and Confirm Password)
- Language allows changing the localization of the dashboard interface (if available)
- Sign out to log out of the current account
Now, you know all of the basic dashboard possibilities and hopefully won’t have any problems working with it. If you still have additional questions, please contact the Support team of your hosting provider or refer to our technical experts at Stackoverflow.