Creating a Github App

Configure the Github information on your instance

Connect your GitHub organization to your workspace to enable powerful features 
like GitHub Job Agent, Release Scanner, and Deployment Configuration.


GitHub Bot

x-api-key

Ctrlplane

Ctrlplane is an open-source deployment orchestration tool that 
helps you scale your infrastructure.


Overview

Ctrlplane is an open-source deployment orchestration tool that helps you scale
your infrastructure.


Intro to Ctrlplane

Systems in Ctrlplane are the highest level of organizational units, designed to
group related deployments and environments together. They provide a structured
approach to managing complex deployment pipelines and enforcing consistency
across your infrastructure.


Systems

Resources in Ctrlplane represent any entity that pipelines can execute
against. This includes traditional infrastructure (e.g., EKS clusters) and
abstract concepts (e.g., Salesforce accounts).


Resources

Runbooks in Ctrlplane are a specialized type of deployment designed to automate
common tasks and workflows that are not necessarily tied to specific
environments. Think of runbooks as your automated playbooks for operational
procedures, incident response, maintenance tasks, and other recurring
activities.


Runbooks

Jobs in Ctrlplane represent external running processes, typically integrating
with your existing CI/CD tools such as GitHub Actions, GitLab CI/CD, Kubernetes
Jobs, Argo Workflows, and others. These jobs reflect the status of processes
running in external systems, providing a centralized view of your deployment
activities across various platforms.


Jobs

Job agents are crucial components in Ctrlplane that facilitate the integration
between Ctrlplane and external CI/CD systems. They act as intermediaries,
enabling Ctrlplane to interact with various CI/CD tools and platforms.


Job Agents

Deployments in Ctrlplane are the central organizing principle for managing and
orchestrating the release of your software or infrastructure across various
environments within a system. A deployment represents a complete, end-to-end
process for delivering changes to your system, encompassing everything from
the initial code commit to the final production release.


Deployments

A release in Ctrlplane represents a specific version or iteration of your
software or infrastructure configuration that is ready to be deployed. It is a
crucial component of the deployment process, serving as a snapshot of your
application or system at a particular point in time.


Releases

Environments in Ctrlplane are logical groupings of resources that represent
distinct stages in your software deployment pipeline. They are defined at the
system level and play a crucial role in organizing and managing the deployment
process across various infrastructure components.


Environments

Resource filters define criteria for selecting which resources to
deploy in an environment.


Resource Filtering

Policies for overseeing and approving deployments, ensuring compliance, 
quality, and governance.


Approval & Governance

Deployment control policies regulate execution within environments, managing
concurrency, release filtering, and operational constraints to ensure orderly
processes without resource overload or rule violations.


Deployment Control

Manages new and pending releases in the deployment pipeline, defining 
rules to cancel or await pending releases for controlled, 
conflict-free execution.


Release Management

Release channels allow you to specify which release of a given deployment can
be deployed to a particular environment.


Release Channels

Controls how and when deployments are rolled out to environments, including
incremental rollouts, scheduling deployments during specific windows, and
managing release timing to minimize risk and ensure stability during the
deployment process.


Rollout & Timing

Cloud Providers

Google

Azure

Kubernetes

GitHub

Tailscale

Terraform Cloud

Execute custom scripts as part of your deployment process

Script Executor Job Agent

At your company, developers can spin up EC2 instances as needed. As the platform team,
you want to ensure proper observability by automatically deploying OpenTelemetry collectors
to gather metrics and provide standardized monitoring endpoints.


OTEL Deployment

Ephemeral Environments are a way to create and destroy environments on demand.

Ephemeral Environments

Docker

Configure PostgreSQL database connection settings for your Ctrlplane instance

PostgreSQL

Introduction

Community

Documentation

Integrations

Examples

Self-Hosted

API Reference

Dashboard

Support

Learn how to make your first deployment with Ctrlplane by following this tutorial.
We'll create a simple hello world deployment that can run across multiple servers.


First Deployment

Learn how to add approval gates and manual checks to your deployment process
using Ctrlplane's manual intervention features.


Approvals with Manual Interventions

Learn how to define and use variables in Ctrlplane to create flexible and 
reusable deployment configurations across environments.


Define and Use Variables

Create an environment

Get an environment

Delete an environment

Upserts a release

Create a release channel

Create or update multiple resources

Get a resource by identifier

Delete a resource

Create a relationship between two resources

Sets the resource for a provider.

Create a system

Delete a system

Get a Job

Terraform module for installing Ctrlplane on Google Kubernetes Engine.

This guide will help you set up basic (email/password) authentication for your Ctrlplane application.


Basic Authentication

Set up Google authentication for your Ctrlplane application

Google Authentication

OIDC

Learn how to configure AWS integration for your Ctrlplane instance.

Learn how to configure Google integration for your Ctrlplane instance.

Learn how to configure Azure integration for your Ctrlplane instance.

Field	Value
Github App Name	`ctrlplane-{your-instance-name}`
Homepage URL	`<your-instance-url>`
Webhook URL	`<your-instance-url>/api/github/webhook`

Install

Configuration

​Creating a Github App

​Configure the Github information on your instance

Creating a Github App

Configure the Github information on your instance