--- title: Initial Setup slug: initial-setup description: Learn how to set up and navigate the Kubeark Platform with this comprehensive step-by-step guide. From logging in and configuring clusters to managing template groups and deployments, this document covers it all. It even includes helpful images that visua docTags: createdAt: 2023-07-19T12:45:55.996Z --- Below you will find the step by step guide for the initial setup as well as the typical operational flow. ![](https://api.archbee.com/api/optimize/-uoBIPXCIMlUMvNPPrDxd/KZ6HQCeM_AZ2SgiskmHkT_initial-setup1.png) :::hint{type="success"} Please make sure to follow the [Installation guide](docId\:f_B2Z9Q2btzrPc8NttW7h) here before the initial setup. ::: ### Step 1: Login - Go to your preferred browser and access the Kubeark Platform at`https://yourdomain.kubeark.com` - 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](docId\:ICQ1CxzQv6obeZzz_YNVe) ### 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. ::Image[]{src="https://api.archbee.com/api/optimize/-uoBIPXCIMlUMvNPPrDxd/WULILq5FGTx14ZoJMBT5j_initial-setup-2.jpeg" size="58" width="512" height="348" position="center" showCaption="false"} - **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 [Template Groups](docId\:K_kBPnulstc8byJkKHTtX) Once you have added all the attributes, click on `Save`. Your newly created template group will appear on the list. ![](https://api.archbee.com/api/optimize/-uoBIPXCIMlUMvNPPrDxd/u-5D7dt-OGWpdTjz4nbEx_create-templ-grp.jpeg) - 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 ![](https://api.archbee.com/api/optimize/-uoBIPXCIMlUMvNPPrDxd/XVyirVfXHSCJIxu3KCdNL_add-tmpl-to-grp.jpeg) - Templates can be added to your group in multiple ways. Kubeark platform will display the following options: ![](https://api.archbee.com/api/optimize/-uoBIPXCIMlUMvNPPrDxd/dMi3K2ToirUinv4DX6zwt_add-tmpl-to-grp-2.png) - `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 (Kubernetes)](docId\:Eud4OZB9ivS8-u3wW7-fA) - `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`. :::hint{type="info"} 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: ::::VerticalSplit{layout="left"} :::VerticalSplitItem **Step 1 - Select your preferred Group. **The Groups option on the main Template Management menu displays a list of all your template groups. **Step 2 - Select your preferred Template from the list. **Once you have selected a Group, a list of all your templates will display. **Step 3 - Select the Deploy Template option. **This is the template details page which shows relevant status information about each deployment. ::: :::VerticalSplitItem ![](https://api.archbee.com/api/optimize/-uoBIPXCIMlUMvNPPrDxd/mXOC1oSYGGuPllNt2H1ao_select-prf-grp.png) ![](https://api.archbee.com/api/optimize/-uoBIPXCIMlUMvNPPrDxd/BPkp_Ux2XgH16aEC2w_Ij_select-prf-tmpl.png) ![](https://api.archbee.com/api/optimize/-uoBIPXCIMlUMvNPPrDxd/0KDRf9CGd5Ln1g9OwGGLg_select-depl-tmpl-large.jpeg) ::: :::: ### Step 4: Manage your Deployments - From the `Templates Management` main menu, select `Deployments` ::Image[]{src="https://api.archbee.com/api/optimize/-uoBIPXCIMlUMvNPPrDxd/F92wnb6VGeOu9NUQI1LjN_mg-depl.png" size="60" width="518" height="334" position="center" showCaption="false"} - Here you will see a list of all your Deployments as well as relevant information such as status, resource utilization and others. ![](https://api.archbee.com/api/optimize/-uoBIPXCIMlUMvNPPrDxd/Y90K9XvfC-7zH3-zypey6_mg-depl-2.png) - 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`. | `Resources` | This category displays information about the deployment status, name, API version, Type and offers a set of Actions for editing. | | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `Details` | This menu shows relevant information about your deployment, including Deployment ID, Template ID, Status and Output. | | `Update` | This category allows you to update the settings and configurations of your deployment | | `Revision` | This category displays information about the revision history of your deployment | | `Metrics` | 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 |