Skip to main content
Version: 0.2

Install & Asset Discovery

Summary​

After reviewing the required prerequisites, refer to the details below to install Colony.

Step 1 - Installing Colony​

The following installation instructions apply to Colony version v0.2.

git clone https://github.com/konstructio/colony.git
cd colony
go build .

Step 2 - Create Your API Key​

  1. Navigate to https://colony.konstruct.io/
  2. Log in with any of the options listed, this step creates your data center (and unique ID for the data center)
  3. Go to API Keys and select Create New API Key.

Save this information in a safe place, it only displays once.

Step 3 - Run the Colony init​

./colony init \
--api-key $YOUR_COLONY_API_KEY \
--load-balancer-interface <asset-managment-interface> \
--load-balancer-ip <ip-address>
export KUBECONFIG=~/.colony/config

Items to Note​

  • <interface> refers to the interface connected to network boot.
  • The IP address should be in the same subnet as the assets being discovered.
  • This is the address of the next-server (tftp server). Refer to the following to generate API keys

Step 4 - Asset Discovery​

To discover an asset run:

./colony add-ipmi \
--ip <asset-managment-address> \
--username <username> \
--password <ipmi-password> \
--auto-discover

The new asset will appear under the assets tab in the Colony UI.

Step 5 - Adding a Cluster​

After your Assets are discovered and listed as available you can use them to provision a cluster. You must have a minimum of two Assets to create a cluster (one for the Control plane and one for the Worker node).

Create Cluster with Civo

  1. Select Create Cluster to start this process.
  2. Complete Cluster details, Control plane details, and Worker node information as desired.
  3. Select Create CivoStack** to complete this process.

Provisioning Clusters