Custom Sync

CUSTOM_SYNC is one stage in the pipeline and you can define scripts to deploy run in this stage.

How to configure Custom Sync

Add a CUSTOM_SYNC to your pipeline and write commands to deploy your infrastructure. The commands run in the directory where this application configuration file exists.

apiVersion: pipecd.dev/v1beta1
kind: LambdaApp
spec:
  name: sam-simple
  labels:
    env: example
    team: abc
  planner:
    # Must add this configuration to force use CUSTOM_SYNC stage.
    alwaysUsePipeline: true
  pipeline:
    stages:
      - name: CUSTOM_SYNC
        with:
          envs:
            AWS_PROFILE: "sample"
          run: |
            cd sam-app
            sam build
            echo y | sam deploy --profile $AWS_PROFILE            

Note:

1. You can use CUSTOM_SYNC with any current supporting application kind, but keep alwaysUsePipeline true to not run the application kind’s default QUICK_SYNC.
2. Only one CUSTOM_SYNC stage should be used in an application pipeline.
3. The commands run with the enviroment variable PATH that refers ~/.piped/tools at first.

Auto Rollback

When autoRollback is enabled, the deployment will be rolled back in the same way as Rolling Back.

When the rolling back process is triggered in the pipeline including CUSTOM_SYNC, CUSTOM_SYNC_ROLLBACK stage will be added to the deployment pipeline. CUSTOM_SYNC_ROLLBACK is different from ROLLBACK that applications set defaultly, it runs the same commands as CUSTOM_SYNC in the runnning commit to reverts all the applied changes.

External Tool Management

You can manage external tools CUSTOM_SYNC stages use other than PipeCD supports. Internally, Piped uses asdf to manage external tools, please see official documents.

You can use specified version of external tools globally according to your piped configuration file with the following configuration in your Piped config.

apiVersion: pipecd.dev/v1beta1
kind: Piped
spec:
  ...
  externalTools:
    - package: "aws-sam-cli"
      version: 1.77.0

You can also set specified version locally to your application folder where your application configuration file exists with the following configuration in your application config.

apiVersion: pipecd.dev/v1beta1
kind: LambdaApp
spec:
...
  pipeline:
    stages:
      - name: CUSTOM_SYNC
        with:
          run: |
            cd sam-app
            sam --version            
          externalTools:
            - package: "aws-sam-cli"
              version: 1.77.0