Initial Setup

Below you will find the step by step guide for the initial setup as well as the typical operational flow.
Typical flow

Step 1: Login

  • Go to your preferred browser and access the Kubeark Platform at
  • Enter your credentials received from the organzation administrator (or directly from Kubeark)
  • If the authentication is successful, you will be taken to the Kubeark's platform dashboard where you will see all possible menus and actions according to your role

Step 2: Cluster configuration

According to the operational flow, the first logical step to take in developing your specific deployment is to define the cluster configuration.
  • On the left-hand side of the main platform interface, go to the Cluster Management menu.
  • Select Clusters and here you will find a list with all predefined clusters according to your license and organizational settings
  • Look for your preferred cluster in the list and make sure the Status is set to Active
  • Here you will also find the Add existing cluster option - this menu will open a configuration page where you will be able to add all the attributes for your new cluster. Detailed information about creating a cluster is available here Clusters

Step 3: Template Management

Once you have selected your clusters, you will need to setup your deployment templates, which can be organized in template groups. Kubeark uses Groups as a fundamental aspect of the deployment management system. This acts as a top layer which allows you to track and manage multiple connected apps and deployments in a single, manageable unit.
  • Go to the Template Management menu on the left-hand side of your platform interface. Here you will find the Groups and the Deployments menus.
  • First, let’s create a new Template Group. Select Groups > Create template group
Detailed information for creating a new template group as well as the mandatory and optional attributes, can be found here Products
Once you have added all the attributes, click on Save. Your newly created template group will appear on the list.
  • Now, let’s start adding templates to the newly created Group.
    • Select your new group from the list and here you will see the Templates list.
    • Select the Create template option
  • Templates can be added to your group in multiple ways. Kubeark platform will display the following options:
    • Create template - this is the option for creating a template from scratch, using text fields and attributes. Detailed information for creating a new template, as well as an explanation of the mandatory and optional attributes, can be found here Templates
    • Upload template - this option allows you to create a new template by uploading a configuration file. Click or drag a file to the highlighted area and select Upload.
    • Raw edit - this option opens an on-screen code editor for manually adding your configuration attributes. Once you have added your configuration, click on Validate template and then Save.
For uploading a template from a configuration file, the only accepted format is .json. For manually configuring the templates using the Raw edit option, the accepted configuration formats are .yaml and .json
Great! We have created a new template group and we have now added our preferred templates to the group. All of our templates will show on the list under the Groups menu. Next, let’s learn how to deploy the templates we have just created. Let’s deploy our new template:
  1. 1.
    Select your preferred Group. The Groups option on the main Template Management menu displays a list of all your template groups.
  1. 2.
    Select your preferred Template from the list. Once you have selected a Group, a list of all your templates will display.
  1. 3.
    Select the Deploy Template option. This is the template details page which shows relevant status information about each deployment.

Step 4: Manage your Deployments

  • From the Templates Management main menu, select Deployments
  • Here you will see a list of all your Deployments as well as relevant information such as status, resource utilization and others.
  • Select your newly created deployment and validate all your deployment details for consistency. The available menu displays information about the Resources, Details, Update, Revision and Metrics.
This category displays information about the deployment status, name, API version, Type and offers a set of Actions for editing.
This menu shows relevant information about your deployment, including Deployment ID, Template ID, Status and Output.
This category allows you to update the settings and configurations of your deployment
This category displays information about the revision history of your deployment
This category displays various metrics related to your deployment, such as:
  • Usage: Total cost, Total CPU Cost, Total efficiency, Total active hours
  • CPU: Average running CPU Cores, CPU Core Request Avg., Cumulative CPU core-hours allocated
  • RAM: Avg. RAM allocated, RAM Request Avg., RAM Usage avg., RAM Efficiency, Cumulative RAM byte-hours allocated