Skip to content

getting-started.md

Latest commit

 

History

History
102 lines (67 loc) · 3.36 KB

getting-started.md

File metadata and controls

102 lines (67 loc) · 3.36 KB
Raw

Getting Started

This guide walks you through running a single-instance containerized Multikube control plane and installing the multikubectl cli to manage it.

Prerequisites

  • A container runtime, Docker is used in this guide
  • Internet connection

Running the Control Plane

  1. Running multikube with Docker

    First thing you need to do is to run the control plane. The control plane exposes the management API and the router in a single binary. You'll then use multikubectl to manage the state of the control plane. Below command will run multikube with default configuration. Pass --help to see a list of available flags.

    docker run -d \
  --name multikube \
  -p 5743:5743 \
  -p 6443:6443 \
  -p 8443:8443 \
  -v multikube-data:/.local/state/multikube  \
  ghcr.io/amimof/multikube:latest

  2. Access the web console at https://localhost:6443/console

Downloading and Installing the CLI

  1. Download multikubectl

    Next install the multikubectl cli binary. Easiest way of doing so is to download from GitHub Releases. Download the latest binary from the release page for your target platform with cURL. Below is for Linux.

    I'm working on publishing it on popular repositories

    curl -LOs https://github.com/amimof/multikube/releases/latest/download/multikubectl-linux-amd64

  2. Install multikubectl

    Place the downloaded binary in your $PATH. Either use the install command or move the binary manually

    sudo install multikubectl-darwin-amd64 /usr/local/bin/multikubectl

    or

    sudo mv multikubectl-darwin-amd64 /usr/local/bin/multikubectl

  3. Verify installation

    Following command

    multikubectl version

    Should give you something like this:

    Version: v1.0.0-beta.1-19-gaeb75b2-dirty
Commit: aeb75b2c896a209bf58cf87f00ee66e6354fdbb9

Login to the control plane

Multikubectl reads it's configuration from a yaml file located at ~/.config/multikubectl.yaml. That file contains connection details and credentials to one or more multikube control planes. We simply use the login command to authenticate and connect to the multikube instance you ran earlier with Docker.

  1. Logging In

    multikubectl login my-cluster --address localhost:5743 --tls --insecure

    Default username and password is admin/admin

  2. List backends

Verify that multikubectl can communicate with the control plane by listing backends. You should see an empy list because we haven't created any backends yet.

multikubectl get backends

🎉 You have successfully setup multikube! The next step is to add some backends and routes. Continue reading the docs to learn how.

Next Steps

Read the User Guide to learn how to use Multikube in a real world scenario. To learn more read the Documentation