Skip to main content

How to Create VM Instances | VM Provisioning Guide

This guide walks you through provisioning a new virtual machine instance on your configured cloud provider.

Prerequisites​

Before provisioning a VM, ensure you have:

  • Cloud Accounts Configured: At least one cloud provider account (AWS, GCP, or Azure) added to Nife with valid credentials
  • Active Organization: An organization created in your Nife account
  • Access to Virtual Machines: Permission to access the Virtual Machines section

Step 1: Access VM Provisioning​

  1. Navigate to Virtual Machines in the left sidebar
  2. Click on the Manage Instances tab
  3. Click the Provision VM button in the top-right corner
  4. The VM provisioning form will open

VM Management Dashboard VM Management page - Manage Instances tab with Provision VM button

Step 2: Select Cloud Account​

At the top of the provisioning form, select which cloud account to use for provisioning.

Cloud Account Selection:

  • Click the cloud account dropdown
  • Select from your configured accounts
  • Shows provider (AWS, GCP, Azure) and account name
  • Example: "AWS - test-aws-account"
  • Default region is displayed below the selection

Example Display:

AWS  test-aws-account
Default region: ap-south-1

Step 3: Node Configuration​

After selecting your cloud account, fill in the Node Configuration details that determine your VM's specifications and deployment mode.

Node Configuration Form Node Configuration form showing all VM specification fields

Node Name​

Enter a unique name for your VM instance.

Requirements:

  • Lowercase letters, numbers, and hyphens only
  • No uppercase letters or special characters
  • No spaces allowed
  • Example: my-node-01, app-server-prod, web-01

Validation Message: "Lowercase, numbers, hyphens only"

Region​

Select the region/zone where your VM will be deployed.

How to Use:

  1. Click the Region dropdown
  2. Select from available regions/zones for your cloud provider
  3. Must be a valid region in your selected cloud account

AWS Regions (Examples):

  • ap-south-1 (Mumbai)
  • us-east-1 (Virginia)
  • eu-west-1 (Ireland)
  • ap-southeast-1 (Singapore)

GCP Zones (Examples):

  • us-central1-a
  • europe-west1-b
  • asia-southeast1-c

Azure Regions (Examples):

  • East US
  • West Europe
  • Southeast Asia

Instance Type​

Select the VM instance size/type based on your workload requirements.

Common Instance Types:

AWS:

  • t3.micro - 1 vCPU, 1 GB RAM (free tier eligible)
  • t3.small - 2 vCPU, 2 GB RAM
  • t3.medium - 2 vCPU, 4 GB RAM
  • m5.large - 2 vCPU, 8 GB RAM
  • m5.xlarge - 4 vCPU, 16 GB RAM

GCP:

  • e2-micro - 0.25-2 vCPU, 1 GB RAM (free tier)
  • e2-small - 0.5-2 vCPU, 2 GB RAM
  • e2-medium - 1-2 vCPU, 4 GB RAM
  • n1-standard-2 - 2 vCPU, 7.5 GB RAM
  • n1-standard-4 - 4 vCPU, 15 GB RAM

Azure:

  • Standard_B1s - 1 vCPU, 1 GB RAM
  • Standard_B2s - 2 vCPU, 4 GB RAM
  • Standard_D2s_v3 - 2 vCPU, 8 GB RAM
  • Standard_D4s_v3 - 4 vCPU, 16 GB RAM

Selection Tips:

  • Start with smaller instance types for testing
  • Scale up based on workload requirements
  • Consider CPU, memory, and network needs
  • Check pricing for your region

Disk Size​

Select the storage capacity for your VM's primary disk.

Common Disk Sizes:

  • 20 GB - Small applications, testing
  • 30 GB - Standard web applications
  • 50 GB - Database servers, media storage
  • 100 GB - High-volume data, development
  • 200 GB+ - Large datasets, enterprise workloads

How to Select:

  1. Click the Disk Size dropdown
  2. Choose appropriate size
  3. Consider growth and scaling needs
  4. Check cloud provider storage pricing
info

Disk can often be expanded after provisioning, but starting with adequate size is recommended.

Operating System​

Select the OS for your VM instance.

Available Operating Systems:

  • Ubuntu 22.04 LTS (Recommended - Default)

    • Latest stable Ubuntu long-term support
    • Wide software compatibility
    • Nife agent pre-installed support

  • Ubuntu 20.04 LTS

    • Previous LTS version
    • Stable and widely used

  • Amazon Linux 2

    • AWS-optimized Linux
    • Good for AWS workloads

  • CentOS 7

    • Enterprise Linux
    • Red Hat compatible

  • Debian 11

    • Lightweight, stable
    • Large package repository

Recommendation:

  • Use Ubuntu 22.04 LTS for best compatibility with Nife
  • Default selection is suitable for most use cases

Step 4: Select Node Mode​

After Node Configuration, you'll select the deployment mode for your VM.

Node Mode Selection Node Mode selection showing Standalone, Cluster Worker, Monolith, and Bare VM options

Node Mode Options​

Best for: Kubernetes deployments, single-node clusters, applications

  • K3s server (lightweight Kubernetes) deployed automatically
  • VM agent installed for monitoring
  • Full Kubernetes capabilities
  • Deploy containerized applications
  • Single command control plane

Installation: K3s + VM agent (~3-8 minutes)

Cluster Worker​

Best for: Scaling existing Kubernetes clusters

  • K3s worker deployed to join existing cluster
  • Extends cluster capacity
  • Works with Standalone node as control plane
  • Automatic cluster registration

Installation: K3s worker node

Monolith​

Best for: Docker-based workloads without Kubernetes

  • Docker runtime deployed
  • Monolith agent for container management
  • Simpler than Kubernetes
  • Direct Docker container deployment
  • No Kubernetes overhead

Installation: Docker + Monolith agent (~3-8 minutes)

Bare VM​

Best for: Custom applications, SSH-only access

  • SSH access only
  • No agents installed
  • Full OS control
  • Maximum flexibility
  • Raw compute power

Installation: None (OS only)

Step 5: Review and Provision​

Before creating your VM, review all settings:

Verification Checklist:

  • ✅ Cloud Account selected
  • ✅ Node Name is valid (lowercase, numbers, hyphens)
  • ✅ Region is appropriate for your use case
  • ✅ Instance Type has adequate resources
  • ✅ Disk Size is sufficient
  • ✅ Operating System selected
  • ✅ Node Mode matches your needs

Provision the VM:

  1. Click the Provision VM button
  2. Confirmation message appears
  3. Provisioning process begins
  4. Status page opens showing provisioning progress

Step 6: VM Provisioning Status​

After clicking Provision VM, you'll see a status page monitoring the creation process. The workflow shown depends on which Node Mode you selected.

General Provisioning Stages​

All Node Modes follow these general stages:

Stage 1: Provisioning VM (1-2 minutes)​

Initial creation phase where the VM is being created on your cloud provider.

VM Provisioning Stage VM being created on cloud provider

What's Happening:

  • VM is being launched on your cloud provider
  • SSH key is being injected
  • Cloud resources are being allocated
  • Page auto-refreshes every 6 seconds

Information Shown:

  • Instance Name
  • Cloud Provider & Region
  • Node Mode
  • Status: Provisioning

Stage 2: Bootstrapping Agent (3-8 minutes)​

Agent and runtime installation phase.

Bootstrapping Agent Stage Agent and services being installed

What's Happening:

  • VM is running on cloud provider
  • Cloud-init executing on instance
  • Agent installation in progress
  • K3s or Docker being configured

Information Shown:

  • Instance Name
  • Cloud Provider & Region
  • Node Mode
  • Status: Bootstrapping (orange)
  • Public IP address
  • Private IP address

Stage 3: Ready (Operational)​

Provisioning complete and all services operational.

Ready Stage VM fully provisioned and ready

What's Completed:

  • VM fully created and running
  • All agents installed and connected
  • Services operational
  • Ready for workload deployment

Information Shown:

  • Instance Name
  • Cloud Provider & Region
  • Node Mode
  • Status: Ready (green checkmark)
  • Public IP address
  • Private IP address

Monolith Mode - Detailed Provisioning Workflow​

When you select Monolith mode, the provisioning includes Docker runtime and Monolith agent installation for container workloads.

Monolith Stage 1: Provisioning VM​

Monolith Provisioning Stage Monolith mode - VM creation in progress

Status: Provisioning

  • VM is being created on your cloud provider
  • SSH key is being injected
  • Cloud resources allocation starting
  • Instance type and disk being configured
  • Page auto-refreshes every 6 seconds

Information Shown:

  • Instance Name (e.g., mono)
  • Cloud Provider & Region (e.g., AWS - ap-south-1 - t3.small)
  • Node Mode: Monolith
  • Status: Provisioning

Monolith Stage 2: Bootstrapping Agent​

Monolith Bootstrapping Stage Monolith mode - Docker and agent installation

Status: Bootstrapping (orange indicator)

What's Installing:

  • Docker runtime environment
  • Monolith agent for container management
  • Container networking and storage
  • Total time: 3-8 minutes

Information Shown:

  • Instance Name (e.g., mono)
  • Cloud Provider & Region (e.g., AWS - ap-south-1 - t3.small)
  • Node Mode: Monolith
  • Status: Bootstrapping
  • Public IP Address (e.g., 13.234.35.127)
  • Private IP Address (e.g., 172.31.42.111)

Monolith Stage 3: Ready - Container Server Setup​

Monolith Ready Stage Monolith mode - Ready with container setup instructions

Status: Ready (green checkmark)

What's Completed:

  • VM fully created and running
  • Docker runtime installed and operational
  • Monolith agent installed, running, connected to Nife
  • Container networking configured
  • Server ready for Docker container deployment

Information Shown:

  • Instance Name (e.g., mono)
  • Cloud Provider & Region (e.g., AWS - ap-south-1 - t3.small)
  • Node Mode: Monolith
  • Status: Ready (green)
  • Public IP Address (e.g., 13.234.35.127)
  • Private IP Address (e.g., 172.31.42.111)

On-Screen Instructions (visible on Ready page):

  • "Monolith is running - next steps"
  • Copy server's public IP
  • Configure security group/firewall for port 5004
  • Add containerbase server button
  • SSH access commands for the server

Monolith Next Steps - Container Setup​

When your Monolith server reaches Ready status:

Step 1: Configure Security Group / Firewall​

Open port 5050 to allow container communication:

For AWS:

  1. Go to AWS EC2 Dashboard
  2. Find your instance
  3. Click on its Security Group
  4. Add inbound rule:
    • Protocol: TCP
    • Port: 5050
    • Source: Your IP or 0.0.0.0/0 (for open access)
  5. Save the rule

For GCP / Azure:

  • Add firewall rule allowing port 5050
  • Ensure traffic can reach the instance from your network

Step 2: Add Containerbase Server​

  1. On the Ready provisioning page, click "Add containerbase server" button
  2. Server is registered in Nife as a container deployment target
  3. Monolith agent establishes connection on port 5050
  4. Server appears in Nife for container workload assignment

Step 3: SSH Access and Verification​

Connect to your Monolith server:

ssh -i <your-ssh-key> ubuntu@<public-ip>

Example:

ssh -i nife-key.pem [email protected]

Verify Docker is Running:

# Check running containers
docker ps

# Check all containers (including stopped)
docker ps -a

# Verify Docker status
docker info

# Check Docker version
docker version

Step 4: Deploy Your First Container​

Once connected, you can deploy Docker containers:

# Pull an image
docker pull nginx:latest

# Run a container
docker run -d -p 80:80 nginx:latest

# View running containers
docker ps

# View container logs
docker logs <container-id>

# Stop a container
docker stop <container-id>

Monolith Server Ready For​

  • ✅ Docker container deployment
  • ✅ Full Docker CLI management
  • ✅ Direct SSH administration
  • ✅ Port 5050 connection to Nife for workload management
  • ✅ Container networking and port mapping
  • ✅ Persistent storage for container data

Standalone Mode - Next Steps​

When Standalone reaches Ready:

K3s Cluster Setup:

  1. SSH into the server: ssh -i <key> ubuntu@<public-ip>
  2. Get kubeconfig: sudo cat /etc/rancher/k3s/k3s.yaml
  3. Update server IP in kubeconfig to use public IP
  4. Save locally and use with kubectl
  5. Cluster is ready for Kubernetes workload deployment

Bare VM Mode - Next Steps​

When Bare VM reaches Ready:

SSH Access:

  1. SSH command provided: ssh -i <key> ubuntu@<public-ip>
  2. Full root access to instance
  3. Install any software needed
  4. Configure operating system as required
  5. No Nife agents running - complete freedom

Instance Appears in Dashboard​

Once provisioning completes, your instance appears in the VM Management dashboard:

  1. Go to Virtual Machines → VM Instances tab
  2. New instance appears in the table
  3. Shows: Name, Type, Cloud, Region, IP, Status (Ready)
  4. Available for management and monitoring

Common Provisioning Times​

Total Time: 4-10 minutes

PhaseDurationWhat Happens
Provisioning1-2 minVM created on cloud provider
Bootstrapping3-8 minAgents/runtime installed and configured
ReadyImmediateFully operational, ready for use

Factors Affecting Time:

  • Cloud provider response time
  • Instance size (larger instances may take slightly longer)
  • Region bandwidth and network latency
  • Nife system load
  • Operating system being installed

Troubleshooting​

Provisioning Takes Too Long​

  • Normal: Can take up to 15 minutes in some regions
  • Check: Refresh page to see latest status
  • Verify: Check cloud provider console for instance status
  • Still Waiting: Cloud-init may be installing large packages

Stuck in Provisioning​

  • Refresh the page
  • Wait another 5 minutes (network delays common)
  • Check cloud provider console for actual instance status
  • Delete and reprovision if stuck >20 minutes

Stuck in Bootstrapping​

  • Refresh the page
  • Normal: Can take up to 8 minutes
  • Check cloud provider instance logs
  • Agent: May still be installing dependencies

Cannot SSH After Ready​

  • Verify SSH key filename and path correct
  • Check public IP address displayed is accurate
  • Ensure SSH port (22) is open in security group
  • Wait 1-2 minutes after Ready status appears

Instance Not Appearing in Dashboard​

  • Refresh the VM Management dashboard
  • Check you're logged into correct organization
  • Wait 30 seconds and refresh again
  • Verify instance status in cloud provider console

Port 5004 Not Accessible (Monolith)​

  • Verify security group / firewall rule created
  • Check port 5004 is in inbound rules
  • Ensure rule allows traffic from your IP
  • Try opening port to 0.0.0.0/0 temporarily for testing

Best Practices​

  1. Node Naming: Use descriptive, lowercase names (e.g., app-server-01, db-primary)
  2. Right-Sizing: Start with medium size, scale based on actual needs
  3. Region Selection: Choose region closest to users
  4. OS Selection: Use Ubuntu 22.04 LTS for best compatibility
  5. Monitoring: Check performance metrics after provisioning completes
  6. Backups: Create snapshots after initial setup
  7. Cost Management: Monitor usage and delete unused instances
  8. Security: Update security groups to restrict access to needed ports

Next Steps​