Sets the resource for a provider.

Successfully updated the deployment resources

x-api-key

Ctrlplane

Ctrlplane simplifies infrastructure scaling through powerful deployment orchestration.


Overview

Ctrlplane is an open-source deployment orchestration tool that simplifies complex infrastructure management and scaling.


Introduction to Ctrlplane

Upcoming features and enhancements planned for Ctrlplane

Roadmap

Systems are the highest level organizational units in Ctrlplane that group related deployments and environments together for consistent management.


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 are system-level resource groupings that represent distinct deployment stages (like dev, staging, production) and control how software progresses through your infrastructure.


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

Control how multiple releases are handled in your deployment pipeline to prevent conflicts and ensure orderly execution.


Release Management Policies

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

GitHub

Tailscale

Terraform Cloud

ClickHouse

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

Create and destroy isolated testing environments automatically based on pull requests or other triggers to optimize your development workflow.

Ephemeral Environments

Docker

Kubernetes

Configure PostgreSQL database connection settings for your Ctrlplane instance

PostgreSQL

Complete reference for the Ctrlplane REST API


API Introduction

Community

Documentation

Integrations

Examples

Self-Hosted

API Reference

Dashboard

Support

Follow this step-by-step guide to create your first Ctrlplane deployment - a simple "hello world" example that demonstrates the core workflow.


Your 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 create flexible, reusable deployment configurations with Ctrlplane variables


Define and Use Variables

How Ctrlplane compares with other deployment orchestration and infrastructure management tools.


Comparison vs. Other Solutions

Compare how Ctrlplane and alternative solutions handle specific deployment scenarios and challenges.


Use Case Comparisons

Create an environment

Get an environment

Delete an environment

Get a workspace

Get a workspace by slug

Create a system

Get a system

Update a system

Delete a system

Create or update multiple resources

Get a resource

Get a resource by identifier

Update a resource

Delete a resource

Delete a resource by identifier

Create a relationship between two resources

Create a relationship between a job and a resource

Upserts a release

Updates a release

Create a release channel

Delete a release channel

Get a Job

Update a job

Acknowledge a job

Acknowledge a job for an agent

Get the next jobs

Get a agents running jobs

Upserts the agent

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

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


GitHub Bot

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.

API Documentation

API Reference

Sets the resource for a provider.

Path Parameters

Body

Response