Skip to content

Threeport SDK Introduction

The Threeport SDK is a command line tool to enable platform engineers to rapidly develop extensions to Threeport.

How It Works

A platform engineer uses the Threeport SDK to build software that provides custom abstractions and functionality for their development teams to use.

Once the requirements are well understood, the process to build a custom Threeport extension is as follows:

  1. Initialize a Threeport extension project. The platform engineer starts a new project with its own git repo and uses the threeport-sdk CLI tool to initialize the repository which scaffolds all the directories and code needed to compile their software.
  2. Create one or more new API objects. The platform engineer designs a data model based on extension requirements and uses threeport-sdk to generate its source code scaffolding. Then the engineer updates this code with fields that define the object's attributes to meet the project's requirements.
  3. The generated scaffolding includes functions to add logic for reconcilers that will manage the state of the new custom object. This reconciliation logic will be compiled into one or more custom controllers that will be added to the Threeport control plane.
  4. The platform engineer then compiles the controller and extended Threeport API server into binaries and builds container images using built-in utilities provided by the SDK.
  5. The platform engineer deploys the custom Threeport control plane using built-in utilities and makes it available for testing and feedback.

Organizations that support open source and community engagement can make their extensions publicly available in case they may be applicable to other use cases.

Coming Soon

Detailed guides on how to build Threeport extensions for different use cases will be coming soon.