Quick Setup

Prerequisites

Installation

# dowload latest craft binary from releases and extract 
curl -L https://github.com/salesforce/craft/releases/download/0.1.7/craft.tar.gz | tar -xz -C /tmp/

# move to a path that you can use for long term
sudo mv /tmp/craft /usr/local/craft
export PATH=$PATH:/usr/local/craft/bin

Instead of having to add to PATH everytime you open a new terminal, we can add our path to PATH permanently.

$ sudo vim /etc/paths

Add the line "/usr/local/craft/bin" at the end of the file and save the file.

Create a CRAFT Application

From the command line, cd into a directory where you'd like to store your CRAFT application and run this command:

craft init

This will initiate a CRAFT application in your current directory and create the following skeleton files:

  • controller.json: This file holds Custom Resource Definition (CRD) information like group, domain, operator image, and reconciliation frequency.
  • resource.json: This file contains the schema information for validating inputs while creating the CRD.

Next Steps

Follow the Wordpress operator tutorial to understand how to use CRAFT to create and deploy an operator into a cluster. This deep-dive tutorial demonstrates the entire scope and scale of a CRAFT application.