Cluster & Platform Parameters

Below you can find descriptions for basic and advanced cluster and platform parameters along with recommendations on how to combine these parameters to create specific configurations.

Basic Parameters

Basic parameters are specified in corresponding sections:

  • General (top one)
  • Master Configuration
  • Instance Group (for each group separately)

Region

Applicable for:
ProviderAWS, Azure
TypeCluster, Platform
SectionGeneral

Kublr can host cluster resources in one of multiple geographic areas referred to as regions by the provider (AWS, Azure). Please select a region to create your cluster. You can find more details

Kubernetes Version

Applicable for:
ProviderAWS, Azure, GCP, VMware vSphere, On-Premises
TypeCluster, Platform
SectionGeneral

The Kubernetes Version parameter defines Kublr agent and therefore Kubernetes version for your cluster. By default, the latest version is suggested. If you need one of the previous versions, select it from the list.

The list of available Kublr agent / Kubernetes versions is managed in the Settings screen.

Note If you do not find the right version in the list, please contact Kublr support for assistance.

Instance Type and Quantity

Applicable for:
ProviderAWS, Azure, GCP, VMware vSphere, On-Premises
TypeCluster, Platform
SectionMaster, Instance Group

The Instance Type parameter along with the Masters (for master node section) or Nodes (for work node groups) distinguishes between the type and number of nodes that are supposed to work as master or work in your cluster (separately for each group).

Before setting, see Kublr minimum hardware recommendations.

For AWS

Recommended configurations:

  • 1 / t2.medium for development / staging environment clusters
  • 3 / t2.medium for staging / low traffic production environments
  • 3 / m4.large for robust large production environments

See details here.

For Azure

Recommended configurations:

  • 1 / Standard_D2_v2 for development / staging environment clusters
  • 3 / Standard_A2_v2 for staging / low traffic production environments
  • 3 / Standard_D3_v2 for robust large production environments

See details here.

For GCP

Recommended configurations:

  • 1 / n1-standard-2 for development / staging environment clusters
  • 3 / n1-standard-2 for staging / low traffic production environments
  • 3 / n1-standard-2 for robust large production environments

See details here.

For VMware vSphere

For VMware vSphere, intead of the Instance Type parameter, the following parameters are used for VM (node) initialization:

  • VM Template Kublr Supports different initialization schemes provided by vSphere. If you don’t have template, please create one as specified here.
  • VM Initialization Type that can use to VM customization

Operating System

Applicable for:
ProviderAWS, Azure, GCP
TypeCluster, Platform
SectionMaster, Instance Group

The Operating System parameter can be defined separately for master nodes and each work node group.

Public SSH Key

Applicable for:
ProviderAWS, Azure
TypeCluster, Platform
SectionMaster, Instance Group

To login to your cluster master or work nodes via SSH, create a key pair within your provider console and select the name of the key pair in this field. You can login to your master or work nodes once the cluster is created.

The Public SSH Key is:

  • Optional:
    • For AWS. More details can be found here.
    • For GCP. More details can be found here.
  • Required for Azure.

Installation Type

Applicable for:
ProviderOn-Premises
TypeCluster
SectionMaster, Instance Group

Two installation types are available:

  • Automated using SSH If you want to use automated installation using SSH, please provide User Name to login on hosts and corresponding SSH Key Name. For work nodes, provide additionally the Node Addresses.
  • Manual

VMware General

Applicable for:
ProviderVMware vSphere
TypeCluster
SectionGeneral

Once connected to VMware vSphere by setting the Credentials, you can select from the provided list:

  • Datacenter
  • Resource Pool (belongs to selected Datacenter)
  • Datastore Type and Datastore (belongs to selected Datacenter). Kublr supports all Datastore types provided by vSphere, including Datastore Clusters.
    • Use “Regular” - for local/shared VMFS, NFS and vSAN datastores.
    • Use “Cluster” - for SRDS enabled Datastore Clusters

See also: VM Override.

Search for related information in VMware vSphere Documentation.

Network Configuration

Applicable for:
ProviderVMware vSphere
TypeCluster
SectionNetwork Configuration

As soon as you select the Datacenter, you can configure the VMware network.

You can select the Network from the list and specify Network CIDR for it.

Additionally, you can:

  • In the Network Gateway type in the gateway IP address for selected Network (for example, 192.168.1.1). If omitted - it will be selected automatically, based on provided CIDR block.
  • Type in the Network Bitmask for selected Network (for example, 24). If omitted - it will be selected automatically, based on provided CIDR block.
  • Form the list of DNS Servers available in selected Network. If omitted - Google Public DNS servers (8.8.8.8 and 8.8.4.4) will be used.

Master 1: IP

Applicable for:
ProviderVMware vSphere
TypeCluster
SectionMaster, Instance Group

IP or DNS of master node. It is required for each master to be connected with other master nodes using this IP address or DNS name. If more than 1 master node is expected, you should use the requirements for Master 2: IP, Master 3: IP and so on.

CPUs

Applicable for:
ProviderVMware vSphere
TypeCluster
SectionMaster, Instance Group

Speaking of the number of CPU cores per VM, make sure you use at least 2 CPU cores per VM. Please refer to minimum hardware recommendations.

RAM in GB

Applicable for:
ProviderVMware vSphere
TypeCluster
SectionMaster, Instance Group

Speaking of amount of RAM per VM, make sure you have at least 4 GB per VM.Please refer to minimum hardware recommendations.

Advanced Parameters

All advanced parameters are hidden by default. If you need an expanded list please click on Advanced Options control in the corresponding section.

Enable Termination Protection

Applicable for:
ProviderAWS
TypeCluster, Platform
SectionGeneral

Once selected, the created cluster is impossible to delete via the Kublr For deletion you must use AWS console user interface.

VPC

Applicable for:
ProviderAWS
TypeCluster, Platform
SectionGeneral

In VPC ID, type in the ID of existing VPC. All resources are provided in this VPC. For more information, see the documentation.

In the VPC IP CIDR block, type in the CIDR block option for the VPC.

AWS IAM

Applicable for:
ProviderAWS
TypeCluster, Platform
SectionGeneral

You can use separate settings for master and working nodes, the path associated with the existing role (type in Role Path Name) and AWS EC2 instance profile (type in Instance Profile). For more information, see the documentation.

Availability Zones

Applicable for:
ProviderAWS
TypeCluster, Platform
SectionMaster

Check Automatic to let Kublr select availability zones for each master node (Auto mode). In auto mode Kublr will try to spread masters over different availability zones.

Or: un-check Automatic and select availability zone for each master node from the Master 1, Master 2, etc. list.

Enable Detailed Monitoring

Applicable for:
ProviderAWS
TypeCluster, Platform
SectionMaster, Intance Group

Select the option to enable CloudWatch detailed Monitoring. See more details here.

Enable Spotinst Elastigroup

Applicable for:
ProviderAWS
TypeCluster, Platform
SectionMaster, Intance Group

Select the option to use Spotinst Elastigroups instead of regular AWS Auto Scaling Groups.

VM Override

Applicable for:
ProviderVMware vSphere
TypeCluster
SectionMaster, Instance Group

The Resource Pool and Datastore Type/Datastore defined in general VMware vSphere cluster settings can be overridden by specific settings for each particular group of master of work nodes. Use the following parameters for that:

  • Resource Pool (Override)
  • Datastore (Override)

Kubernetes API Server Port

Applicable for:
ProviderOn-Premises
TypeCluster
SectionMaster

Kubernetes API server port.

etcd Data Directory Path

Applicable for:
ProviderOn-Premises
TypeCluster
SectionMaster

Specify this parameter, if you want to override the default etcd data directory path.

Local Path Provisioner Data Directory Path

Applicable for:
ProviderOn-Premises
TypeCluster
SectionMaster

Optionally, specify the path to Provisioner Directory. For example:

/var/lib/kublr/pvc