Mirage's Notebook 📖

    Civo

    🧰 Civo: Cloud Kubernetes & Instance Management

    [!info]+
    Homepage: Civo.com
    Docs: Civo Documentation
    Terraform Provider: Civo on Terraform Registry

    🚀 Civo CLI

    Civo CLI is a powerful command-line tool to manage your Civo resources directly from the terminal. It is built with Go and distributed as cross-platform binaries via GitHub Releases.

    🔐 Authentication

    To use the CLI, you’ll need to authenticate via an API key.

    [!tip] Get your API key
    Visit https://www.civo.com/api to find or regenerate your API key.

    🛠️ Create an Instance

    You can quickly create instances using the civo instance create command.

    civo instance create --hostname=<your-hostname> \
  --sshkey=<your-ssh-key-name> \
  --initialuser=xcad \
  --size=g3.xsmall \
  --diskimage=921fcb64-8abf-4a51-8823-027d9d75c1d4

    [!example] Quick Setup
    Replace <your-hostname> and <your-ssh-key-name> with your values. You can customize the size, disk image, and user.

    ⚙️ CLI Parameters Table

    ShortLongDescription
    -t--diskimageDisk image to use (civo diskimage ls)
    -l--firewallFirewall (name or ID)
    -s--hostnameInstance hostname
    -u--initialuserInitial user for the instance
    -r--networkNetwork (name or ID)
    -p--publicipEither "none" or "create" (default)
    -i--sizeSize (civo instance size)
    -k--sshkeySSH key (name or ID)
    -g--tagsTags to attach to the instance
    -w--waitWait for the instance to be ready

    📏 Available Instance Sizes

    [!note] Type Definitions
    Instance types are for general compute. Kubernetes types are optimized for K3s clusters.

    IDLabelTypeCPURAM (MB)SSD (GB)
    g3.xsmallExtraSmallInstance1102425
    g3.smallSmallInstance1204825
    g3.mediumMediumInstance2409650
    g3.largeLargeInstance48192100
    g3.xlargeExtraLargeInstance616384150
    g3.2xlarge2XLargeInstance832768200
    g3.k3s.xsmallExtraSmallKubernetes1102415
    g3.k3s.smallSmallKubernetes1204815
    g3.k3s.mediumMediumKubernetes2409615
    g3.k3s.largeLargeKubernetes4819215
    g3.k3s.xlargeExtraLargeKubernetes61638415
    g3.k3s.2xlarge2XLargeKubernetes83276815

    💽 Available Disk Images

    Use civo diskimage ls to list available disk images, or refer to these popular options:

    IDName
    9ffb043e-37d8-4b71-80ed-81227564944fcentos-7
    e1a83a29-d35b-433b-b1cb-4baade48c81adebian-10
    67a75d21-3726-4152-8fc9-dcdb51b6e39edebian-9
    880d37ca-372e-4d33-91bd-3122cf56614bubuntu-bionic
    921fcb64-8abf-4a51-8823-027d9d75c1d4ubuntu-focal

    🧳 Explore More 🌍

    🏷️ Tags 📚

    #civo
    #kubernetes
    #cloud
    #infrastructure
    #cli
    #terraform
    #devops
    #instance-management

    ← Cloud Computing
    Databases →