PDK Provider Setup
In Common Fate v0.15+, Providers built with the Provider Development Kit (PDK) are deployed separately to a Common Fate deployment.
Installing cf
To deploy a PDK Provider, start by installing cf.
cf is a command-line interface (CLI) tool for performing authenticated actions against a Common Fate deployment. It provides commands for creating and updating Target Groups, Handlers, Routes and also for operational tasks like viewing Handler logs.
To install cf, follow the instructions below based on your computer's operating system:
- Homebrew on MacOS
- MacOS manual install
- Linux
- Windows
Homebrew is an open source package manager for MacOS. We publish a Homebrew formula for cf. To install cf with Homebrew, run the commands below in your terminal.
brew tap common-fate/tap
brew install cf
Select the steps which match your system architecture. You can find your architecture by running uname -m from a terminal window.
- x86_64
- arm64
curl -OL releases.commonfate.io/cf/v0.1.0/cf_0.1.0_darwin_x86_64.tar.gz
sudo tar -zxvf ./cf_0.1.0_darwin_x86_64.tar.gz -C /usr/local/bin/
curl -OL releases.commonfate.io/cf/v0.1.0/cf_0.1.0_darwin_arm64.tar.gz
sudo tar -zxvf ./cf_0.1.0_darwin_arm64.tar.gz -C /usr/local/bin/
Select the steps which match your system architecture. You can find your architecture by running uname -m from a terminal window.
- x86_64
- arm64
- i386
curl -OL releases.commonfate.io/cf/v0.1.0/cf_0.1.0_linux_x86_64.tar.gz
sudo tar -zxvf ./cf_0.1.0_linux_x86_64.tar.gz -C /usr/local/bin/
curl -OL releases.commonfate.io/cf/v0.1.0/cf_0.1.0_linux_arm64.tar.gz
sudo tar -zxvf ./cf_0.1.0_linux_arm64.tar.gz -C /usr/local/bin/
curl -OL releases.commonfate.io/cf/v0.1.0/cf_0.1.0_linux_i386.tar.gz
sudo tar -zxvf ./cf_0.1.0_linux_i386.tar.gz -C /usr/local/bin/
First, download the zip archive of cf which matches your system's architecture. You can find your architecture by viewing your system properties in the Control Panel.
After downloading cf, unzip the package.
You'll need to move the binary to a folder which is accessible on your PATH. This StackOverflow link has instructions on how to do this.
Verify the installation
You can verify the integrity and authenticity of the cf binary you have downloaded by running through the verification process here. You will need to replace references to granted in URLs with cf.
Check that cf has been installed correctly by running the following command:
cf -v
You should see a version output similar to the below:
cf version 0.1.0