Skip to content

Commit

Permalink
Add overview page & video
Browse files Browse the repository at this point in the history
  • Loading branch information
jsbroks committed Oct 15, 2024
1 parent 9cc03ba commit 8de906e
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 0 deletions.
1 change: 1 addition & 0 deletions apps/docs/pages/core-concepts/_meta.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
export default {
overview: "Overview",
systems: "Systems",
targets: "Targets",
environments: "Environments",
Expand Down
30 changes: 30 additions & 0 deletions apps/docs/pages/core-concepts/overview.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Overview

Ctrlplane is a centralized, scalable deployment management system designed to
simplify and automate software deployments. At the core of Ctrlplane are several
key components that work together to ensure smooth operations.

import Youtube from "react-youtube";

<div className="flex justify-center pt-4">
<Youtube videoId="72_6ZtDzmZo" />
</div>

**Targets** are entities such as Kubernetes clusters, virtual machines, or other
logical resources, that the system interacts with. These targets can be added
manually or through **Target Providers**, which automate the process by
continuously monitoring infrastructure, updating target statuses, and providing
real-time visibility. Targets are organized into **Environments**, which
dynamically update based on target filters, ensuring the right infrastructure is
always in place for deployments.

Once targets and environments are established, **Deployments** come into play. A
deployment is the process of releasing a specific version of a system into an
environment. Each deployment is governed by **Environment Policies**, which
manage how software transitions between environments. When a release is created,
it generates a **Job**, which is executed by **Job Agents** that handle tasks
like running CI/CD pipelines. In addition, Ctrlplane supports **Runbooks**,
predefined jobs that automate routine tasks like troubleshooting or maintenance,
providing further automation and reliability. Together, these components form an
integrated system for managing software releases and operational tasks in a
streamlined, efficient way.

0 comments on commit 8de906e

Please sign in to comment.