Setting Up Environment

The first step of any application hosting is a creation of the environment with the required isolated containers. Apiqcloud PaaS provides a powerful and intuitive UI to create and configure environments up to your specific needs. This document will guide you through all the needed steps, giving an extended explanation of available specifics and features.

Log in to the Apiqcloud dashboard and click the New Environment button in the upper-left corner.
Within the opened topology wizard dialog, you can set up all the necessary customizations. We recommend performing adjustments in the following order:
- choose programming language or specialized deployment solution (Docker Engine or Kubernetes Cluster)
- set up topology by adding required software stacks
- configure nodes resources and specifics
- review estimations, name the environment and confirm the creation

Below, we’ll review each of these points in detail, providing explanations on all of the available possibilities. Herewith, after getting familiar with the process, you’ll be able to configure a new (or adjust existing) environment in under a minute.

Choosing Programming Language or Specific Deployment Option

As the first step of your environment creation, you need to select the deployment solution required for your project. Apiqcloud PaaS is an extremely versatile platform that supports multiple options for application development and hosting thus it suits even the most demanding clients.

The most common and recommended choice (unless you are pursuing a specific application/architecture) is certified containers. These stacks are specifically configured and managed by Apiqcloud (e.g. version updates, security patches). By default, they support all platform features (scaling, automated deployment, redeploy, SSL, etc.) for the most smooth and convenient hosting and development.
The other deployment options are available via the Docker tab. Herewith, all the variants listed below utilize the basic Apiqcloud system container (so-called OS container), which makes them compatible with the most (but not all) of the platform-distinguishing features (e.g. vertical and horizontal scaling).

Custom Docker Containers - any Docker image (based on the supported OS) deployed into the system container. Compared to the managed containers, this option provides access to a greater variety of solutions, search the entire Docker Hub registry or use your private repository. However, the software operability and compatibility with the platform cannot be guaranteed as the content is managed by respective image maintainers. It’s recommended to build custom Docker images based on Apiqcloud certified images using FROM instruction.
Docker Engine - a Docker Engine CE deployed into the system container. It provides access to all the Docker native functionality, including deployment, scaling, and management of multiple application containers inside.
Kubernetes Cluster - ready-to-go Kubernetes cluster with a preconfigured master and worker nodes created based on the system containers. The deployment, scaling, and orchestration of the microservices inside are handled by Kubernetes control units, while Apiqcloud scales and manages master and worker nodes.

3. Also, it is recommended to select the preferred region (if available) before proceeding further.

Configuring Topology

You can configure environment topology (layers structure) via the left part of the wizard. Сonsider it as a constructor that helps you to create your environment. Here, the following blocks are available:

Load Balancers - stacks that operate as an entry point for the environment to distribute incoming request and create even load on other nodes
Application Servers (compute nodes) - web servers that run your application
Databases (SQL & NoSQL) - database solutions to store and manage data
Cache Node - a Memcached object caching system for speeding up web applications through alleviating database load
Shared Storage - dedicated storage node with NFSv4 support, enlarged disk space and optimized performance
Elastic VPS - virtual private servers on top of the CentOS, Ubuntu, Debian, and Windows OS
Build Node - a build automation tool for Java projects
Extra (custom layers) - any of the stacks mentioned above

Apiqcloud PaaS offers a number of the most popular options for each of these sections. Enable the blocks needed for your environment and select a suitable stack for the role.

Tip: If you cannot find a required software solution, you can add it as a custom Docker container from Docker Hub or your private repository.
An SSL protection can be configured for your environment via the same-named section. Here, two options are available:
- Built-In SSL - enables an already trusted SSL certificate, avoiding any additional checks and saving your time on the certificate validation. However, it is applied to the default environment domain name only (i.e. with the hoster’s domain at the end) and does not work if public IP is attached to your servers.
- Custom SSL - shows the pre-conditions of using your custom SSL certificates for the environment. Click the Enable button to automatically fulfill the requirements (e.g. enable Public IP) and refer to the linked instruction for further guidance.

Configuring Nodes Resources and Specifics

Once you are done with the topology structure, you can adjust each particular layer via the wizard’s central part. Let’s review the available options from top to the bottom of the section.

You can toggle a layer on/off, as well as provide a custom alias for it.
Configure the automatic vertical scaling by setting the number of reserved and dynamic cloudlets (1 cloudlet = 128 MiB of RAM and 400 MHz of CPU) for the nodes within the layer.
Think of it as a minimum and maximum CPU & RAM capacities per server. It is worth mentioning that no matter how high the scaling limit is, only actually consumed resources are charged. This helps to overcome load spikes and, at the same time, not to overpay for unused memory or processor.
The Horizontal Scaling part allows defining a number of nodes within the layer and choosing a preferred scaling mode (stateful or stateless).

If needed, you can use the drop-down lists to change stack and engine type/versions. In case of adjusting an existing environment, these lists will redirect to the container redeploy dialog in order to apply changes.
Tip: Click on the gear icon (circled in the image below) for additional management options during scaling.
Next, you need to configure additional settings.

The list may vary depending on the particular stack and account permissions:

Auto-Clustering - automatic clusterization for some Apiqcloud certified templates. Additional fields can appear after activation, e.g. scheme selection (master-slave, master-master, or galera) for the database cluster.
Disk Limit - an amount of disk space reserved per node. The dedicated Shared Storage containers are usually provided with enlarged storage capacity.
Sequential restart delay - a delay between the restart operation completion on one node and start on the other. It is used to avoid downtime, ensuring that at least one server is active. You can set it to “-1” for the simultaneous restart of all nodes within the layer.
High-Availability - automated session replication for the Tomcat and TomEE application servers
Access via SLB - blocks access to the nodes of the layer via the platform Shared Load Balancer
Public IPv4/IPv6 - attach the specified number of external IP addresses to each node within the layer

5. At the bottom of the section, you can find buttons to the container configuration tools:

Variables - review and manage a list of the environment variables for the current layer
Links - interconnect layers inside the environment
Volumes - manage a list of the data volumes to ensure files integrity during container lifecycle
Ports - view information about containers' ports
CMD / Entry Point - configure containers' Entry Point and Run Command

Reviewing and Confirming Environment Creation

After all the configurations are done, you can review the amount of allocated resources and the estimated cost of the environment.

The main resource measuring units in Apiqcloud PaaS are cloudlets. Here, you can see the number of reserved ones and the scaling limit (dynamic) for the whole environment.

For better analysis, the values are divided into the color-marked groups:
- green - load balancers
- blue - application servers
- orange - databases and cache nodes
- gray - all other stacks
Next, you can view the Estimated Cost of your environment. The widget displays price using the same color-marking as above, and you can change the period - hourly, daily, or monthly.

The FROM tab shows the price that will be fully charged as it covers reserved resources. The TO tab shows the maximum possible price if all nodes in the environment are going to fully consume all resources up to the scaling limit during the whole period.

Tip: Hover over the pricing widget to view extended details on the estimated cost calculation:

If needed, you can click on the links under the widget for additional information on how pricing works and what is charged at Apiqcloud PaaS.
Lastly, provide a name for your environment and click the Create button to proceed.

That’s all! In a few minutes, your new environment will appear on the dashboard.