Skip to content

Commit 5df1ef3

Browse files
khanhtc1202khanhtc1202
authored
Release v0.56.0 (#6759)
Signed-off-by: khanhtc1202 <khanhtc1202@gmail.com>
1 parent e37df69 commit 5df1ef3

86 files changed

Lines changed: 8117 additions & 2 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎RELEASE‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Generated by `make release` command.
22
# DO NOT EDIT.
3-
tag: v0.55.0
3+
tag: v0.56.0
44

55
releaseNoteGenerator:
66
showCommitter: false

‎docs/config.toml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -169,6 +169,10 @@ no = 'Sorry to hear that. Please <a href="https://github.com/pipe-cd/pipecd/issu
169169
version = "v1.0.x"
170170
url = "/docs-v1.0.x/"
171171

172+
[[params.versions]]
173+
version = "v0.56.x"
174+
url = "/docs-v0.56.x/"
175+
172176
[[params.versions]]
173177
version = "v0.55.x"
174178
url = "/docs-v0.55.x/"

‎docs/content/en/docs-v0.56.x/_index.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
title: "Welcome to PipeCD"
3+
linkTitle: "Documentation [v0.56.x]"
4+
type: docs
5+
---

‎docs/content/en/docs-v0.56.x/concepts/_index.md‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
---
2+
title: "Concepts"
3+
linkTitle: "Concepts"
4+
weight: 2
5+
description: >
6+
This page describes several core concepts in PipeCD.
7+
---
8+
9+
![](/images/architecture-overview.png)
10+
<p style="text-align: center;">
11+
Component Architecture
12+
</p>
13+
14+
### Piped
15+
16+
`piped` is a single binary component you run as an agent in your cluster, your local network to handle the deployment tasks.
17+
It can be run inside a Kubernetes cluster by simply starting a Pod or a Deployment.
18+
This component is designed to be stateless, so it can also be run in a single VM or even your local machine.
19+
20+
### Control Plane
21+
22+
A centralized component managing deployment data and provides gRPC API for connecting `piped`s as well as all web-functionalities of PipeCD such as
23+
authentication, showing deployment list/details, application list/details, delivery insights...
24+
25+
### Project
26+
27+
A project is a logical group of applications to be managed by a group of users.
28+
Each project can have multiple `piped` instances from different clouds or environments.
29+
30+
There are three types of project roles:
31+
32+
- **Viewer** has only permissions of viewing to deployment and application in the project.
33+
- **Editor** has all viewer permissions, plus permissions for actions that modify state such as manually trigger/cancel the deployment.
34+
- **Admin** has all editor permissions, plus permissions for managing project data, managing project `piped`.
35+
36+
### Application
37+
38+
A collection of resources (containers, services, infrastructure components...) and configurations that are managed together.
39+
PipeCD supports multiple kinds of applications such as `KUBERNETES`, `TERRAFORM`, `ECS`, `CLOUDRUN`, `LAMBDA`...
40+
41+
### Application Configuration
42+
43+
A YAML file that contains information to define and configure application.
44+
Each application requires one file at application directory stored in the Git repository.
45+
The default file name is `app.pipecd.yaml`.
46+
47+
### Application Directory
48+
49+
A directory in Git repository containing application configuration file and application manifests.
50+
Each application must have one application directory.
51+
52+
### Deployment
53+
54+
A deployment is a process that does transition from the current state (running state) to the desired state (specified state in Git) of a specific application.
55+
When the deployment is success, it means the running state is being synced with the desired state specified in the target commit.
56+
57+
### Sync Strategy
58+
59+
There are 3 strategies that PipeCD supports while syncing your application state with its configuration stored in Git. Which are:
60+
- Quick Sync: a fast way to make the running application state as same as its Git stored configuration. The generated pipeline contains only one predefined `SYNC` stage.
61+
- Pipeline Sync: sync the running application state with its Git stored configuration through a pipeline defined in its application configuration.
62+
- Sync: depends on your defined application configuration, `piped` will decide the best way to sync your application state with its Git stored configuration.
63+
64+
### Platform Provider
65+
66+
Note: The previous name of this concept was Cloud Provider.
67+
68+
PipeCD supports multiple platforms and multiple kinds of applications.
69+
Platform Provider defines which platform, cloud and where application should be deployed to.
70+
71+
Currently, PipeCD is supporting these five platform providers: `KUBERNETES`, `ECS`, `TERRAFORM`, `CLOUDRUN`, `LAMBDA`.
72+
73+
### Analysis Provider
74+
An external product that provides metrics/logs to evaluate deployments, such as `Prometheus`, `Datadog`, `Stackdriver`, `CloudWatch` and so on.
75+
It is mainly used in the [Automated deployment analysis](../user-guide/managing-application/customizing-deployment/automated-deployment-analysis/) context.

‎docs/content/en/docs-v0.56.x/contribution-guidelines/_index.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: "Contribute"
3+
linkTitle: "Contribute"
4+
weight: 6
5+
description: >
6+
This guide is for anyone who wants to contribute to the PipeCD project. We are so excited to have you!
7+
---

‎docs/content/en/docs-v0.56.x/contribution-guidelines/architectural-overview.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
title: "Architectural overview"
3+
linkTitle: "Architectural overview"
4+
weight: 3
5+
description: >
6+
This page describes the architecture of PipeCD.
7+
---
8+
9+
![](/images/architecture-overview.png)
10+
<p style="text-align: center;">
11+
Component Architecture
12+
</p>
13+
14+
### Piped
15+
16+
A single binary component runs in your cluster, your local network to handle the deployment tasks.
17+
It can be run inside a Kubernetes cluster by simply starting a Pod or a Deployment.
18+
This component is designed to be stateless, so it can also be run in a single VM or even your local machine.
19+
20+
### Control Plane
21+
22+
A centralized component manages deployment data and provides gRPC API for connecting `piped`s as well as all web-functionalities of PipeCD such as
23+
authentication, showing deployment list/details, application list/details, delivery insights...
24+
25+
Control Plane contains the following components:
26+
- `server`: a service to provide api for piped, web and serve static assets for web.
27+
- `ops`: a service to provide administrative features for Control Plane owner like adding/managing projects.
28+
- `cache`: a redis cache service for caching internal data.
29+
- `datastore`: data storage for storing deployment, application data
30+
- this can be a fully-managed service such as `Firestore`, `Cloud SQL`...
31+
- or a self-managed such as `MySQL`
32+
- `filestore`: file storage for storing logs, application states
33+
- this can a fully-managed service such as `GCS`, `S3`...
34+
- or a self-managed service such as `Minio`
35+
36+
For more information, see [Architecture overview of Control Plane](../../user-guide/managing-controlplane/architecture-overview/).

‎docs/content/en/docs-v0.56.x/contribution-guidelines/contributing-blogs.md‎

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
---
2+
title: "Contribute to PipeCD Blogs"
3+
linkTitle: "Contribute to PipeCD Blogs"
4+
weight: 3
5+
description: >
6+
This page describes how to contribute blog posts to PipeCD.
7+
---
8+
9+
We welcome blog contributions from the community! Blog posts are a great way to share your experiences, tutorials, and insights about PipeCD with other users.
10+
11+
## What makes a good blog post?
12+
13+
Blog posts can cover a variety of topics, including:
14+
15+
- **Announcements**: New features, releases, or project updates
16+
- **Tutorials**: Step-by-step guides on using PipeCD features
17+
- **Use cases**: How you or your organization uses PipeCD
18+
- **Best practices**: Tips and tricks for getting the most out of PipeCD
19+
- **Integrations**: How to integrate PipeCD with other tools
20+
21+
## Where blog posts live
22+
23+
Blog posts are located in the `/docs/content/en/blog/` directory within the [pipe-cd/pipecd repository](https://github.com/pipe-cd/pipecd).
24+
25+
## Blog post format
26+
27+
Each blog post is a Markdown file with YAML front matter. Here's the structure:
28+
29+
```yaml
30+
---
31+
date: 2025-01-03
32+
title: "Your Blog Post Title"
33+
linkTitle: "Short Title for Navigation"
34+
weight: 980
35+
description: "A brief description of your post"
36+
author: Your Name ([@your-github-handle](https://github.com/your-github-handle))
37+
categories: ["Announcement"]
38+
tags: ["Tag1", "Tag2"]
39+
---
40+
41+
Your content here...
42+
```
43+
44+
### Front matter fields
45+
46+
| Field | Required | Description |
47+
|-------|----------|-------------|
48+
| `date` | Yes | Publication date in `YYYY-MM-DD` format |
49+
| `title` | Yes | Full title of your blog post |
50+
| `linkTitle` | Yes | Shorter title used in navigation menus |
51+
| `weight` | Yes | Controls ordering (lower = newer, typically use ~980-990) |
52+
| `description` | No | Brief summary for SEO and previews |
53+
| `author` | Yes | Your name with GitHub profile link |
54+
| `categories` | Yes | One of: `Announcement`, `Tutorial`, `Release` |
55+
| `tags` | No | Relevant keywords for your post |
56+
57+
### Content guidelines
58+
59+
- Use clear, concise language
60+
- Include code examples where appropriate (use fenced code blocks with language identifiers)
61+
- Add images to `/docs/static/images/` and reference them as `![alt text](/images/your-image.png)`
62+
- Structure your post with headings (`##`, `###`) for readability
63+
- Include a conclusion or summary section
64+
65+
## How to submit your blog post
66+
67+
1. **Fork and clone** the [pipecd repository](https://github.com/pipe-cd/pipecd)
68+
69+
2. **Create a branch** for your blog post:
70+
```bash
71+
git checkout -b blog/your-post-title
72+
```
73+
74+
3. **Create your blog post** file in `/docs/content/en/blog/`:
75+
```bash
76+
touch docs/content/en/blog/your-post-title.md
77+
```
78+
79+
4. **Add any images** to `/docs/static/images/`
80+
81+
5. **Preview locally** by running:
82+
```bash
83+
make run/site
84+
```
85+
Then visit `http://localhost:1313/blog/` to see your post.
86+
87+
6. **Commit and push** your changes:
88+
```bash
89+
git add .
90+
git commit -s -m "blog: add post about your-topic"
91+
git push origin blog/your-post-title
92+
```
93+
94+
7. **Open a Pull Request** against the `master` branch
95+
96+
## Review process
97+
98+
A maintainer will review your blog post for:
99+
100+
- Technical accuracy
101+
- Clarity and readability
102+
- Adherence to the format guidelines
103+
- Appropriate use of images and code examples
104+
105+
Feel free to reach out on the [#pipecd Slack channel](https://cloud-native.slack.com/) if you have questions or want feedback on your draft before submitting.
106+
107+
Thank you for contributing to the PipeCD blog!

‎docs/content/en/docs-v0.56.x/contribution-guidelines/contributing-documentation.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
title: "Contribute to PipeCD Documentation"
3+
linkTitle: "Contribute to PipeCD Documentation"
4+
description: >
5+
This page describes how to contribute to the PipeCD Documentation.
6+
---
7+
8+
Welcome! We are so happy you're interested in helping improve our documentation. Your contributions make the project better for everyone.
9+
10+
This guide explains how you can contribute to the PipeCD Documentation, which resides on our official website, https://pipecd.dev.
11+
12+
## Where to find the docs
13+
14+
Our documentation is located in the `/docs` folder within the [pipe-cd/pipecd repository](https://github.com/pipe-cd/pipecd).
15+
16+
The content files are written in Markdown and live inside `/docs/content/en/`. You'll notice two types of documentation folders:
17+
18+
* `/docs-dev/`: This is for documentation related to unreleased, in-development features.
19+
* `/docs-v0.x.x/` (and `/docs-v1.0.x/`): These folders contain the documentation for specific released versions of PipeCD.
20+
21+
## How to build the docs locally
22+
23+
To preview your changes as you work, you must run the documentation website on your local machine.
24+
25+
1. **Install Prerequisite:** You must have the **extended** version of [Hugo (v0.92.1 or higher)](https://gohugo.io/getting-started/installing/) installed.
26+
2. **Run the Server:** From the root of the `pipecd` repository, run the following command:
27+
```bash
28+
make run/site
29+
```
30+
3. **Preview:** Open your browser and go to `http://localhost:1313` to see the live-reloading site.
31+
32+
## How to submit your changes (The PR Process)
33+
34+
1. **Create a Branch:** Create a new branch for your changes (e.g., `git checkout -b my-docs-fix`).
35+
2. **Make Your Changes:** Edit the necessary documentation files. If you are fixing an issue in the current documentation, remember to edit the file in both the `/docs-dev/` and the latest `/docs-vx.y.z/` folders.
36+
3. **Commit and Push:** Commit your changes with a clear message and push your branch to your fork.
37+
4. **Open a Pull Request:** Go to the PipeCD repository and open a Pull Request. In the description, please link to the issue you are fixing (e.g., `Addresses #6124`).
38+
5. **Review:** A maintainer will review your PR, provide feedback, and merge it.
39+
40+
Thank you for contributing!

0 commit comments

Comments
 (0)