From 26699e145cb8c098d9c3b006cae782d477f60eda Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juraj=20=C5=BDitt=C5=88ansk=C3=BD?= Date: Tue, 4 Jun 2024 11:12:36 +0200 Subject: [PATCH 1/3] fix installing-controlplane-on-k8s.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Juraj Žittňanský --- .../installing-controlplane-on-k8s.md | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/docs/content/en/docs-v0.46.x/installation/install-control-plane/installing-controlplane-on-k8s.md b/docs/content/en/docs-v0.46.x/installation/install-control-plane/installing-controlplane-on-k8s.md index b41a8c71bd..f5252b488c 100644 --- a/docs/content/en/docs-v0.46.x/installation/install-control-plane/installing-controlplane-on-k8s.md +++ b/docs/content/en/docs-v0.46.x/installation/install-control-plane/installing-controlplane-on-k8s.md @@ -37,6 +37,8 @@ The Control Plane of PipeCD is constructed by several components, as shown in th PipeCD requires a GCS bucket and service account files to access Firestore and GCS service. Here is an example of configuration file: +Currently, besides `Firestore` PipeCD supports other databases as its datastore such as `MySQL`. Also as for filestore, PipeCD supports `AWS S3` and `MINIO` either. + ``` yaml apiVersion: "pipecd.dev/v1beta1" kind: ControlPlane @@ -72,7 +74,7 @@ helm upgrade -i pipecd oci://ghcr.io/pipe-cd/chart/pipecd --version {{< blocks/l --set-file secret.gcsServiceAccount.data=path-to-service-account-file ``` -Currently, besides `Firestore` PipeCD supports other databases as its datastore such as `MySQL`. Also as for filestore, PipeCD supports `AWS S3` and `MINIO` either. +#### Using MySQL and MINIO For example, in case of using `MySQL` as datastore and `MINIO` as filestore, the ControlPlane configuration will be as follow: @@ -84,7 +86,7 @@ spec: datastore: type: MYSQL config: - url: {YOUR_MYSQL_ADDRESS} + url: {YOUR_MYSQL_ADDRESS} # format: :@tcp(:) database: {YOUR_DATABASE_NAME} filestore: type: MINIO @@ -95,11 +97,20 @@ spec: secretKeyFile: /etc/pipecd-secret/minio-secret-key autoCreateBucket: true ``` - -You can find required configurations to use other datastores and filestores from [ConfigurationReference](../../../user-guide/managing-controlplane/configuration-reference/). +See [ConfigurationReference](../../../user-guide/managing-controlplane/configuration-reference/) for the full configuration. __Caution__: In case of using `MySQL` as Control Plane's datastore, please note that the implementation of PipeCD requires some features that only available on [MySQL v8](https://dev.mysql.com/doc/refman/8.0/en/), make sure your MySQL service is satisfied the requirement. +After all, install the Control Plane as bellow: + +``` console +helm upgrade -i pipecd oci://ghcr.io/pipe-cd/chart/pipecd --version {{< blocks/latest_version >}} --namespace={NAMESPACE} \ + --set-file config.data=path-to-control-plane-configuration-file \ + --set-file secret.encryptionKey.data=path-to-encryption-key-file \ + --set-file secret.minioAccessKey.data=path-to-minio-access-key-file \ + --set-file secret.minioSecretKey.data=ppath-to-minio-secret-key-file +``` + ### 3. Accessing the PipeCD web If your installation was including an [ingress](https://github.com/pipe-cd/pipecd/blob/master/manifests/pipecd/values.yaml#L7), the PipeCD web can be accessed by the ingress's IP address or domain. From 43380530b06cf94a630f2e646627706cd12f34ac Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juraj=20=C5=BDitt=C5=88ansk=C3=BD?= Date: Thu, 6 Jun 2024 07:05:38 +0200 Subject: [PATCH 2/3] fix installing-controlplane-on-k8s.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Juraj Žittňanský --- .../installing-controlplane-on-k8s.md | 42 +++++++++---------- 1 file changed, 20 insertions(+), 22 deletions(-) diff --git a/docs/content/en/docs-v0.46.x/installation/install-control-plane/installing-controlplane-on-k8s.md b/docs/content/en/docs-v0.46.x/installation/install-control-plane/installing-controlplane-on-k8s.md index f5252b488c..1c8e605980 100644 --- a/docs/content/en/docs-v0.46.x/installation/install-control-plane/installing-controlplane-on-k8s.md +++ b/docs/content/en/docs-v0.46.x/installation/install-control-plane/installing-controlplane-on-k8s.md @@ -33,12 +33,10 @@ Control Plane Architecture The Control Plane of PipeCD is constructed by several components, as shown in the above graph (for more in detail please read [Control Plane architecture overview docs](../../../user-guide/managing-controlplane/architecture-overview/)). As mentioned in the graph, the PipeCD's data can be stored in one of the provided fully-managed or self-managed services. So you have to decide which kind of [data store](../../../user-guide/managing-controlplane/architecture-overview/#data-store) and [file store](../../../user-guide/managing-controlplane/architecture-overview/#file-store) you want to use and prepare a Control Plane configuration file suitable for that choice. -#### Using Firestore and GCS - -PipeCD requires a GCS bucket and service account files to access Firestore and GCS service. Here is an example of configuration file: - Currently, besides `Firestore` PipeCD supports other databases as its datastore such as `MySQL`. Also as for filestore, PipeCD supports `AWS S3` and `MINIO` either. +#### Using Firestore and GCS + ``` yaml apiVersion: "pipecd.dev/v1beta1" kind: ControlPlane @@ -62,21 +60,9 @@ spec: credentialsFile: /etc/pipecd-secret/gcs-service-account ``` -See [ConfigurationReference](../../../user-guide/managing-controlplane/configuration-reference/) for the full configuration. - -After all, install the Control Plane as bellow: - -``` console -helm upgrade -i pipecd oci://ghcr.io/pipe-cd/chart/pipecd --version {{< blocks/latest_version >}} --namespace={NAMESPACE} \ - --set-file config.data=path-to-control-plane-configuration-file \ - --set-file secret.encryptionKey.data=path-to-encryption-key-file \ - --set-file secret.firestoreServiceAccount.data=path-to-service-account-file \ - --set-file secret.gcsServiceAccount.data=path-to-service-account-file -``` - #### Using MySQL and MINIO -For example, in case of using `MySQL` as datastore and `MINIO` as filestore, the ControlPlane configuration will be as follow: +__Caution__: In case of using `MySQL` as Control Plane's datastore, please note that the implementation of PipeCD requires some features that only available on [MySQL v8](https://dev.mysql.com/doc/refman/8.0/en/), make sure your MySQL service is satisfied the requirement. ```yaml apiVersion: "pipecd.dev/v1beta1" @@ -97,19 +83,31 @@ spec: secretKeyFile: /etc/pipecd-secret/minio-secret-key autoCreateBucket: true ``` -See [ConfigurationReference](../../../user-guide/managing-controlplane/configuration-reference/) for the full configuration. -__Caution__: In case of using `MySQL` as Control Plane's datastore, please note that the implementation of PipeCD requires some features that only available on [MySQL v8](https://dev.mysql.com/doc/refman/8.0/en/), make sure your MySQL service is satisfied the requirement. +- Installing Control Plane by using [Helm](https://helm.sh/docs/intro/install/) (3.8.0 or later) -After all, install the Control Plane as bellow: + {{< tabpane >}} + {{< tab lang="bash" header="Firestore and GCS" >}} + +# PipeCD requires a GCS bucket and service +# account files to access Firestore and GCS service. +# Here is an example of configuration file: + +helm upgrade -i pipecd oci://ghcr.io/pipe-cd/chart/pipecd --version {{< blocks/latest_version >}} --namespace={NAMESPACE} \ + --set-file config.data=path-to-control-plane-configuration-file \ + --set-file secret.encryptionKey.data=path-to-encryption-key-file \ + --set-file secret.firestoreServiceAccount.data=path-to-service-account-file \ + --set-file secret.gcsServiceAccount.data=path-to-service-account-file + {{< /tab >}} + {{< tab lang="bash" header="MySQL and MINIO" >}} -``` console helm upgrade -i pipecd oci://ghcr.io/pipe-cd/chart/pipecd --version {{< blocks/latest_version >}} --namespace={NAMESPACE} \ --set-file config.data=path-to-control-plane-configuration-file \ --set-file secret.encryptionKey.data=path-to-encryption-key-file \ --set-file secret.minioAccessKey.data=path-to-minio-access-key-file \ --set-file secret.minioSecretKey.data=ppath-to-minio-secret-key-file -``` + {{< /tab >}} + {{< /tabpane >}} ### 3. Accessing the PipeCD web From a3bcd58c0891e7a67146b8e8bee1c593b5e6102a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juraj=20=C5=BDitt=C5=88ansk=C3=BD?= Date: Thu, 6 Jun 2024 07:12:59 +0200 Subject: [PATCH 3/3] fix installing-controlplane-on-k8s.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Juraj Žittňanský --- .../install-control-plane/installing-controlplane-on-k8s.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/content/en/docs-v0.46.x/installation/install-control-plane/installing-controlplane-on-k8s.md b/docs/content/en/docs-v0.46.x/installation/install-control-plane/installing-controlplane-on-k8s.md index 1c8e605980..8c41b3b582 100644 --- a/docs/content/en/docs-v0.46.x/installation/install-control-plane/installing-controlplane-on-k8s.md +++ b/docs/content/en/docs-v0.46.x/installation/install-control-plane/installing-controlplane-on-k8s.md @@ -37,6 +37,8 @@ Currently, besides `Firestore` PipeCD supports other databases as its datastore #### Using Firestore and GCS +Here is an example of configuration file: + ``` yaml apiVersion: "pipecd.dev/v1beta1" kind: ControlPlane @@ -62,6 +64,8 @@ spec: #### Using MySQL and MINIO +Here is an example of configuration file: + __Caution__: In case of using `MySQL` as Control Plane's datastore, please note that the implementation of PipeCD requires some features that only available on [MySQL v8](https://dev.mysql.com/doc/refman/8.0/en/), make sure your MySQL service is satisfied the requirement. ```yaml @@ -91,7 +95,6 @@ spec: # PipeCD requires a GCS bucket and service # account files to access Firestore and GCS service. -# Here is an example of configuration file: helm upgrade -i pipecd oci://ghcr.io/pipe-cd/chart/pipecd --version {{< blocks/latest_version >}} --namespace={NAMESPACE} \ --set-file config.data=path-to-control-plane-configuration-file \