Skip to content

Commit 770fc1b

Browse files
authored
Docs V1: Update FAQs (#6344)
* UPDATE faqs for v1 Signed-off-by: Eeshaan Sawant <eeshaans1@gmail.com> * UPDATE faqs Signed-off-by: Eeshaan Sawant <eeshaans1@gmail.com> --------- Signed-off-by: Eeshaan Sawant <eeshaans1@gmail.com>
1 parent f2784f4 commit 770fc1b

File tree

1 file changed

+30
-20
lines changed

1 file changed

+30
-20
lines changed

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

Lines changed: 30 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -6,61 +6,71 @@ description: >
66
List of frequently asked questions.
77
---
88

9-
If you have any other questions, please feel free to create the issue in the [pipe-cd/pipecd](https://github.com/pipe-cd/pipecd/issues/new/choose) repository or contact us on [Cloud Native Slack](https://slack.cncf.io) (channel [#pipecd](https://app.slack.com/client/T08PSQ7BQ/C01B27F9T0X)).
9+
We have answered some of the most frequently asked questions below. If you have any other questions, please feel free to create the issue in the [pipe-cd/pipecd](https://github.com/pipe-cd/pipecd/issues/new/choose) repository or contact us on [Cloud Native Slack](https://slack.cncf.io) (channel [#pipecd](https://app.slack.com/client/T08PSQ7BQ/C01B27F9T0X)).
1010

11-
### 1. What kind of application (platform provider) will be supported?
11+
### 1. What is PipeCD V1? How is it different from the PipeCD Versions so far?
1212

13-
Currently, PipeCD can be used to deploy `Kubernetes`, `ECS`, `Terraform`, `CloudRun`, `Lambda` applications.
13+
PipeCD V1 introduces a plugin-based architecture where each application deployment is managed by a 'plugin', created specifically for that application. This replaces the concept of Platform Providers from earlier versions of PipeCD. This change makes PipeCD versatile, allowing users to create custom plugins to deploy the application of their choice.
1414

15-
In the near future we also want to support `Crossplane`...
15+
### 2. What kind of applications will be supported in PipeCD V1?
1616

17-
### 2. What kind of templating methods for Kubernetes application will be supported?
17+
Since PipeCD V1 introduces a plugin architecture, you can now deploy any application using plugins.
18+
19+
Check out the latest releases on GitHub for the list of available plugins. Additionally, we also have a Community Plugins Repository for plugins made by the PipeCD community. As of now, the official plugins maintained by the PipeCD Maintainers are Kubernetes, Terraform, Analysis, ScriptRun, Wait, and WaitApproval.
20+
21+
The broader plan in the future releases is to add plugins for Amazon ECS and GCP Cloud Run, which will be maintained by PipeCD, while plugins for other applications will go in the Community Plugins Repository.
22+
23+
### 3. What kind of templating methods for Kubernetes application will be supported?
1824

1925
Currently, PipeCD is supporting `Helm` and `Kustomize` as templating method for Kubernetes applications.
2026

21-
### 3. Istio is supported now?
27+
### 4. Is Istio is supported now?
2228

2329
Yes, you can use PipeCD for both mesh (Istio, SMI) applications and non-mesh applications.
2430

25-
### 4. What are the differences between PipeCD and FluxCD?
31+
### 5. What are the differences between PipeCD and FluxCD?
32+
33+
- Apart from Kubernetes applications, PipeCD also provides a unified interface for other cloud services (GCP Cloud Run, AWS ECS, AWS Lambda and more). Starting PipeCD V1, users can use PipeCD with even more applications by creating custom plugins for their deployments.
34+
Here are some standout features of PipeCD when compared to Flux:
2635

27-
- Not just Kubernetes applications, PipeCD also provides a unified interface for other cloud services (CloudRun, AWS Lamda...) and Terraform
2836
- One tool for both GitOps sync and progressive deployment
2937
- Supports multiple Git repositories
3038
- Has web UI for better visibility
31-
- Log viewer for each deployment
32-
- Visualization of application component/state in realtime
33-
- Show configuration drift in realtime
39+
- Log viewer for each deployment
40+
- Visualization of application component/state in realtime
41+
- Show configuration drift in realtime
3442
- Also supports Canary and BlueGreen for non-mesh applications
3543
- Has built-in secrets management
36-
- Shows the delivery performance insights
44+
- Shows the delivery performance insights
45+
46+
### 6. What are the differences between PipeCD and ArgoCD?
3747

38-
### 5. What are the differences between PipeCD and ArgoCD?
48+
- Apart from Kubernetes applications, PipeCD also provides a unified interface for other cloud services (GCP Cloud Run, AWS ECS, AWS Lambda and more). Starting PipeCD V1, users can use PipeCD with even more applications by creating custom plugins for their deployments.
49+
Here are some standout features of PipeCD when compared to ArgoCD:
3950

40-
- Not just Kubernetes applications, PipeCD also provides a unified interface for other cloud services (GCP CloudRun, AWS Lamda...) and Terraform
4151
- One tool for both GitOps sync and progressive deployment
4252
- Don't need another CRD or changing the existing manifests for doing Canary/BlueGreen. PipeCD just uses the standard Kubernetes deployment object
4353
- Easier and safer to operate multi-tenancy, multi-cluster for multiple teams (even some teams are running in a private/restricted network)
4454
- Has built-in secrets management
4555
- Shows the delivery performance insights
4656

47-
### 6. What should I do if I lost my Piped key?
57+
### 7. What should I do if I lose my Piped key?
4858

4959
You can create a new Piped key. Go to the `Piped` tab at `Settings` page, and click the vertical ellipsis of the Piped that you would like to create the new Piped key. Don't forget deleting the old Key, too.
5060

51-
### 7. What is the strong point if PipeCD is used only for Kubernetes?
61+
### 8. What is the strong point if PipeCD is used only for Kubernetes?
5262

5363
- Simple interface, easy to understand no extra CRD required
5464
- Easy to install, upgrade, and manage (both the ControlPlane and the agent Piped)
5565
- Not strict depend on any Kubernetes API, not being part of issues for your Kubernetes cluster versioning upgrade
5666
- Easy to interact with any CI; Plan preview feature gives you an early look at what will be changed in your cluster even before manifests update
5767
- Insights show metrics like lead time, deployment frequency, MTTR, and change failure rate to measure delivery performance
5868

59-
### 8. Is it open source?
69+
### 9. Is PipeCD open source?
6070

61-
Yes, PipeCD is fully open source project with APACHE LICENSE, VERSION 2.0!!
71+
Yes, PipeCD is fully open source project with APACHE LICENSE, VERSION 2.0
6272

63-
### 9. How should I investigate high CPU usage or memory usage in piped, or when OOM occurs?
73+
### 10. How should I investigate high CPU usage or memory usage in piped, or when OOM occurs?
6474

6575
If you're noticing high CPU usage, memory usage, or facing OOM issues in Piped, you can use the built-in support for `pprof`, a tool for visualization and analysis of profiling data.
66-
`pprof` can help you identify the parts of your application that are consuming the most resources. For more detailed information and examples of how to use `pprof` in Piped, please refer to our [Using Pprof in Piped guide](../managing-piped/using-pprof-in-piped).
76+
`pprof` can help you identify the parts of your application that are consuming the most resources. For more detailed information and examples of how to use `pprof` in Piped, please see [Using Pprof in Piped](../managing-piped/using-pprof-in-piped).

0 commit comments

Comments
 (0)