Quick Setup Guide For PMK

This document provides a quick setup guide for Platform9 Managed Kubernetes (PMK). If you are new to PMK, we recommend starting with PMK Overview and PMK SaaS Managed Architecture first.

PMK supports creating Kubernetes clusters with on-premises infrastructure or public cloud providers. You can create and manage multiple Kubernetes clusters across any of these environments.

BareOS Clusters

Read What Is BareOS first for an understanding of BareOS.

Get Started

  • Step 1 - Get a VM or physical server running Ubuntu or CentOS. See Create Ubuntu VM on Mac using VirtualBox

    For a single node test cluster, you need a machine with:

    • At least 20 GB of free disk space.
    • Minimum of 5 GB of RAM
    • Minimum 2 cores / VCPUs
  • Step 2 - Install Platform9 CLI. (See CLI Overview here)
    bash <(curl -sL http://pf9.io/get_cli)
    

    This will download a script named cli_setup.sh and invoke the script.

    This process will ask for the following:

    • Your PMK deployment URL
    • Your PMK account username and password
  • Step 3 - Create Single-Node Cluster. (See pf9ctl bootstrap overview here)
    pf9ctl cluster bootstrap MyFirstCluster
    
  • Step 4 - Navigate to the PMK UI and see cluster creation in action

For Production

AWS Cluster Setup

PMK provides native integration with Amazon AWS to create Kubernetes clusters using AWS EC2 instances. In this model, PMK manages the lifecycle of the nodes on EC2, Route53, ELB, EBS to create a fully production-ready Kubernetes cluster that can auto-scale based on workload requirements.

Azure Cluster Setup

PMK also provides native integration with Microsoft Azure to create Kubernetes clusters using Azure VM instances. In this model, PMK manages the lifecycle of the Azure VMs, Traffic manager, Application gateway and Azure managed disks to create a fully production-ready Kubernetes cluster that can auto-scale based on workload requirements.

System Requirements

Test / PoC Clusters

To create a simple test Kubernetes cluster, each node that is to be part of the cluster should have:

  • At least 20 GB of free disk space.
  • Minimum of 5 GB of RAM
  • Minimum 2 cores / VCPUs

Production Clusters

To run a production grade Kubernetes cluster, each node that is to be part of the cluster should have:

  • At least 40 GB of free disk space.
    • (About 8 GB of disk space will be used by the Operating System and Kubernetes components. The remaining space will be available for docker to store cached container images on the node)
    • In the case of CentOS, be careful to leave some of that space unallocated by file systems. The /var/lib directory should exist on a file system with at least 30 GB of free disk space.
  • Minimum of 16 GB of RAM
  • 1 core per 4 GB of RAM.
  • At least one physical (or VLAN backed) NIC with an IP address.

This type of configuration should be used to create a production cluster that you will use either for CI/CD or to run production applications.

  • A production cluster should be created with at least 3 master nodes.
  • Best practice is to not run your workloads on the masters in a production cluster, but to have separate worker nodes in the cluster with sufficient capacity to run your workloads

Supported Operating Systems

Regardless of what infrastructure or cloud provider you are creating the PMK clusters on, PMK supports the following operating systems for the nodes of those Kubernetes clusters.

  • CentOS 7+ (64-bit)
  • RHEL 7+ (64-bit)
  • Ubuntu LTS 16.04 (64-bit)
  • Ubuntu LTS 18.04 (64-bit)

Troubleshooting