Add README for k8s multi cluster

Signed-off-by: Yoshiki Fujikane <[email protected]>

Author: ffjlabo

cmd/pipedv1/README.md

@@ -0,0 +1,65 @@
+# Kubernetes Multicluster Plugin
+
+## Specification
+
+The current specification is described in the [RFC](../../../../../docs/rfcs/0014-multi-cluster-deployment-for-k8s.md).  
+The configuration format is unstable and may change in the future.
+
+## Try k8s multicluster plugin locally
+
+**Prepare the PipeCD Control Plane**
+
+Please refer to [pipe-cd/pipecd/cmd/pipecd/README.md](../../../../../cmd/pipecd/README.md) to set up the Control Plane in your local environment.
+
+- Prepare two k8s clusters
+
+    ```
+        kind create cluster --name cluster1
+        kind export kubeconfig --name cluster1 --kubeconfig /path/to/kubeconfig/for/cluster1
+
+        kind create cluster --name cluster2
+        kind export kubeconfig --name cluster2 --kubeconfig /path/to/kubeconfig/for/cluster2
+    ```
+
+**Start pipedv1 locally**
+
+Please refer to [pipe-cd/pipecd/cmd/pipedv1/README.md](../../../../../cmd/pipedv1/README.md) to set up the Control Plane in your local environment.  
+At this time, please modify the `spec.plugins` section of the piped config as shown below.
+
+    ```yaml
+    ...
+      plugins:
+      - name: kubernetes_multicluster
+        port: 7002
+        url: file:///path/to/.piped/plugins/kubernetes_multicluster # It's OK using any value for now because it's a dummy. We will implement it later.
+        deployTargets: 
+          - name: cluster1
+            config:
+              masterURL: https://127.0.0.1:61337   # shown by kubectl cluster-info
+              kubeConfigPath: /path/to/kubeconfig/for/cluster1
+          - name: cluster2
+            config:
+              masterURL: https://127.0.0.1:62082   # shown by kubectl cluster-info
+              kubeConfigPath: /path/to/kubeconfig/for/cluster2
+    ```
+
+**Prepare the manifest**
+
+- Please create a new repository for the manifest.  
+If there is an app.pipecd.yaml in the format before supporting the plugin mechanism, an error will occur.
+
+- Copy the app you want to run from the Examples and commit it.
+
+**Register the application**
+
+![adding-application](./docs/static/adding-application.png)
+
+At this time, please select multiple DeployTargets.
+
+## Examples
+There are examples under `./example`.
+
+| Name | Description |
+|------|-------------|
+| [simple](./example/simple/) | Deploy the same resources to the multiple clusters. |
+| [multi-sources-template-none](./example/multi-sources-template-none/) | Deploy the different resources to the multiple clusters. |

pkg/app/pipedv1/plugin/kubernetes_multicluster/README.md

@@ -0,0 +1,21 @@
+apiVersion: pipecd.dev/v1beta1
+kind: Application
+spec:
+  name: multi-sources-template-none
+  labels:
+    env: example
+  plugins:
+    kubernetes_multicluster:
+      quickSync:
+        prune: true
+      input:
+        multiTargets:
+          - target:
+              name: cluster1
+            manifests:
+              - ./cluster1/deployment.yaml
+          - target:
+              name: cluster2
+            manifests:
+              - ./cluster2/deployment.yaml
+        kubectlVersion: 1.32.2

pkg/app/pipedv1/plugin/kubernetes_multicluster/docs/static/adding-application.png

@@ -0,0 +1,27 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: cluster1
+  labels:
+    app: cluster1
+spec:
+  replicas: 2
+  selector:
+    matchLabels:
+      app: cluster1
+      pipecd.dev/variant: primary
+  template:
+    metadata:
+      labels:
+        app: cluster1
+        pipecd.dev/variant: primary
+      annotations:
+        sidecar.istio.io/inject: "false"
+    spec:
+      containers:
+      - name: helloworld
+        image: ghcr.io/pipe-cd/helloworld:v0.32.0
+        args:
+          - server
+        ports:
+        - containerPort: 9085

pkg/app/pipedv1/plugin/kubernetes_multicluster/example/multi-sources-template-none/app.pipecd.yaml

@@ -0,0 +1,27 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: cluster2
+  labels:
+    app: cluster2
+spec:
+  replicas: 2
+  selector:
+    matchLabels:
+      app: cluster2
+      pipecd.dev/variant: primary
+  template:
+    metadata:
+      labels:
+        app: cluster2
+        pipecd.dev/variant: primary
+      annotations:
+        sidecar.istio.io/inject: "false"
+    spec:
+      containers:
+      - name: helloworld
+        image: ghcr.io/pipe-cd/helloworld:v0.32.0
+        args:
+          - server
+        ports:
+        - containerPort: 9085

pkg/app/pipedv1/plugin/kubernetes_multicluster/example/multi-sources-template-none/cluster1/deployment.yaml

@@ -0,0 +1,13 @@
+apiVersion: pipecd.dev/v1beta1
+kind: Application
+spec:
+  name: simple
+  labels:
+    env: example
+  plugins:
+    kubernetes_multicluster:
+      input:
+        manifests:
+          - deployment.yaml
+          - service.yaml
+        kubectlVersion: 1.32.2

pkg/app/pipedv1/plugin/kubernetes_multicluster/example/multi-sources-template-none/cluster2/deployment.yaml

@@ -0,0 +1,27 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: simple
+  labels:
+    app: simple
+spec:
+  replicas: 2
+  selector:
+    matchLabels:
+      app: simple
+      pipecd.dev/variant: primary
+  template:
+    metadata:
+      labels:
+        app: simple
+        pipecd.dev/variant: primary
+      annotations:
+        sidecar.istio.io/inject: "false"
+    spec:
+      containers:
+      - name: helloworld
+        image: ghcr.io/pipe-cd/helloworld:v0.32.0
+        args:
+          - server
+        ports:
+        - containerPort: 9085

pkg/app/pipedv1/plugin/kubernetes_multicluster/example/simple/app.pipecd.yaml

@@ -0,0 +1,11 @@
+apiVersion: v1
+kind: Service
+metadata:
+  name: simple
+spec:
+  selector:
+    app: simple
+  ports:
+    - protocol: TCP
+      port: 9085
+      targetPort: 9085