Skip to content

Commit 1443975

Browse files
authored
V1 merge Architectural overview into Concepts section (#6433)
* merge architectural-overview into concepts Signed-off-by: rahulshendre <rahulshendre789@gmail.com> * remove isolated line Signed-off-by: Rahul Shendre <144231863+rahulshendre@users.noreply.github.com> * concise control plane component descriptions Signed-off-by: Rahul Shendre <144231863+rahulshendre@users.noreply.github.com> * minor correction Signed-off-by: Rahul Shendre <144231863+rahulshendre@users.noreply.github.com> * remove components section Signed-off-by: Rahul Shendre <144231863+rahulshendre@users.noreply.github.com> * standardize piped instances Signed-off-by: Rahul Shendre <144231863+rahulshendre@users.noreply.github.com> --------- Signed-off-by: rahulshendre <rahulshendre789@gmail.com> Signed-off-by: Rahul Shendre <144231863+rahulshendre@users.noreply.github.com>
1 parent 08f6981 commit 1443975

File tree

2 files changed

+7
-43
lines changed

2 files changed

+7
-43
lines changed

docs/content/en/docs-v1.0.x/concepts/_index.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,15 @@ Component Architecture
1414

1515
### Control Plane
1616

17-
The Control Plane is the centralized management service of PipeCD. It coordinates all activities between users, projects, and piped instances.
17+
The Control Plane is the centralized management service of PipeCD. It coordinates all activities between users, projects, and `piped` instances.
1818

1919
The Control Plane remains the backbone of the system but is now fully plugin-aware. Instead of directly handling deployment logic for specific platforms, it interacts with `piped` agents that run plugin binaries, allowing the Control Plane to manage deployments across any platform supported by plugins.
2020

21-
### Piped
21+
For more detailed information about Control Plane architecture and components, see [Architecture overview of Control Plane](../user-guide/managing-controlplane/architecture-overview/).
2222

23-
'`piped`' is a binary, agent component responsible for executing deployments in PipeCD. `Piped` now adopts **plugin-based** **architecture**, transforming from a single-purpose executor into a lightweight runtime capable of runnning any deployment logic defined by plugins. The `piped` component is designed to be stateless.
23+
### piped
24+
25+
`piped` is a binary, agent component responsible for executing deployments in PipeCD. `piped` now adopts **plugin-based** **architecture**, transforming from a single-purpose executor into a lightweight runtime capable of running any deployment logic defined by plugins. The `piped` component is designed to be stateless.
2426

2527
### Plugins
2628

@@ -48,7 +50,7 @@ Projects use role-based access control (RBAC) to manage permissions:
4850

4951
- Viewer – can view applications and deployments within the project.
5052
- Editor – includes Viewer permissions and can perform actions that modify state, such as triggering or cancelling deployments.
51-
- Admin – includes Editor permissions and can manage project settings, members, and associated piped instances.
53+
- Admin – includes Editor permissions and can manage project settings, members, and associated `piped` instances.
5254

5355
### Application
5456

@@ -82,6 +84,4 @@ Depending on your deployment workflow, you can choose from one of the following
8284

8385
- Pipeline Sync: A customizable, step-by-step sync process that follows the pipeline you define in your application configuration file. Use Pipeline Sync when you need more control over how updates are rolled out.
8486

85-
- Auto Sync: When you trigger a sync without specifying a strategy, piped automatically selects the most appropriate method based on your application configuration.
86-
87-
Git stored configuration.
87+
- Auto Sync: When you trigger a sync without specifying a strategy, `piped` automatically selects the most appropriate method based on your application configuration.

docs/content/en/docs-v1.0.x/contribution-guidelines/architectural-overview.md

Lines changed: 0 additions & 36 deletions
This file was deleted.

0 commit comments

Comments
 (0)