pipecd-plugin-prototypes

[DO NOT USE IN PROD] Prototypes of PipeCD plugin for demonstration.

Tests, error handlings, logging, configs,... are poor yet.

See Overview of the Plan for "Pluginnable" PipeCD to understand what's PipeCD plugin.

Temporary Usage

Preparation

1. Run pipedv0
2. Register any one app with pipedv0 on UI and deploy it
   1. Because pipedv1 cannot register an app yet...
   2. Note: Do not specify plugin config in app.pipecd.yaml yet.
3. Create config of pipedv1

Example configuration (v0 and v1 compatible):

apiVersion: pipecd.dev/v1beta1
kind: Piped
spec:
  # v0 config for registering an app
  platformProviders:
    - name: terraform-dev
      type: TERRAFORM # Any type will be OK because this will be ignored in v1.

  # v1 config for plugins
  plugins:
    - name: ECSPRESSO
      port: 7003 # Any unused port
      url: file:///<HOME>/.piped/plugins/ecspresso # Replace <HOME> to your home dir
      deployTargets: # This is requried if this plugin requires `config`.
        - name: dt1
          config:
            version: 2.4.5

To use remote binary, you can use url: <URL>. I want to release prototype plugin binaries in this repo soon...

Run pipedv1 with plugins

Note: Set PipelineStage.Visible: true for stages to show in the v0-UI.

1. Build plugins

make build/plugin

2. Run pipedv1

(Optionnal) If you don't have pipecd source code, clone like this:

git clone https://github.com/pipe-cd/pipecd.git
cd pipecd

# 'EXPERIMENTAL=true' is required for pipedv1.
# Add `INSECURE=true` when using your local Control Plane etc.
make run/piped CONFIG_FILE=<YOUR_PIPED_V1_CONFIG_FILE> EXPERIMENTAL=true

3. Override the app config

Example of new app config:

apiVersion: pipecd.dev/v1beta1
kind: Application # In the new config, this can be 'Application'.
spec:
  name: v1-try-ecspresso
  input: # Depends on plugin
    config: ecspresso.yml
  pipeline:
    stages: # Define your stages
      - name: ECSPRESSO_DIFF
      - name: ECSPRESSO_DEPLOY

4. Push the app config -> A new Deployment will be triggered!!