From 8de906e5258236b74e9dd7625d76b16c04ed563c Mon Sep 17 00:00:00 2001 From: Justin Brooks Date: Mon, 14 Oct 2024 21:53:17 -0400 Subject: [PATCH] Add overview page & video --- apps/docs/pages/core-concepts/_meta.ts | 1 + apps/docs/pages/core-concepts/overview.mdx | 30 ++++++++++++++++++++++ 2 files changed, 31 insertions(+) create mode 100644 apps/docs/pages/core-concepts/overview.mdx diff --git a/apps/docs/pages/core-concepts/_meta.ts b/apps/docs/pages/core-concepts/_meta.ts index deb62a16a..f58b899b0 100644 --- a/apps/docs/pages/core-concepts/_meta.ts +++ b/apps/docs/pages/core-concepts/_meta.ts @@ -1,4 +1,5 @@ export default { + overview: "Overview", systems: "Systems", targets: "Targets", environments: "Environments", diff --git a/apps/docs/pages/core-concepts/overview.mdx b/apps/docs/pages/core-concepts/overview.mdx new file mode 100644 index 000000000..3f321320b --- /dev/null +++ b/apps/docs/pages/core-concepts/overview.mdx @@ -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"; + +
+ +
+ +**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.