3. Install Piped

February 6, 2025 · View on GitHub

In this page, you will run a Piped agent on local as a single binary.

Installation

  1. Create a Piped ID on the console.

    1-1. Access the Piped settings page on the console: http://localhost:8080/settings/piped

    1-2. Click + ADD. ADD Piped

    1-3. Enter any Name and Description, and then click SAVE. Input piped

    1-4. You will see the Piped's ID and Key. You will use them in the following steps. Piped is registered

  2. Move on to the directory you cloned in 1. Setup Git Repository.

    cd <YOUR_CLONED_TUTORIAL_DIR>
cd src/install/piped/

  3. Replace <YOUR_PIPED_KEY> below to the Piped Key value you got in 1-4. and create a file of the key.1

    echo -n <YOUR_PIPED_KEY> > .pipedKey

  4. Edit your src/install/piped/piped.yaml as below.

    • spec.pipedID: Piped Id you got in 1-4.
    • spec.pipedKeyFile: <YOUR_CLONED_TUTORIAL_DIR>/src/install/piped/.pipedKey
    • spec.repositories[0].remote: The URL of your repository on GitHub you created in 1. Setup Git Repository.
    • spec.platformProviders: Uncomment one item. You will deploy to the environment.

  5. Get the official binary of Piped from pipecd/releases. Choose your OS and CPU architecture.

    # OS=darwin or linux
# CPU=arm64 or amd64
curl -Lo ./piped  https://github.com/pipe-cd/pipecd/releases/download/v0.50.1/piped_v0.50.1_${OS}_${CPU}

  6. Make the Piped executable.

    chmod +x ./piped

  7. Run the Piped.2

    ./piped piped --config-file=./piped.yaml --insecure
    Troubleshooting (Click to expand)

    • failed to create api client {"error": "context deadline exceeded"}

      • It means the piped failed to connect to the control plane.
      • Check apiAddress in piped.yaml
      • Check whether the control plane is serving on apiAddress.

    • rpc error: code = Unauthenticated desc = Unauthenticated

      • It means the piped connected to the control plane but failed to authenticate.
      • Check projectID, pipedID, pipedKeyFile in piped.yaml.
      • Check the value in the pipedKeyFile.

    • failed to clone from remote

      • It means the piped successfully connected to the control plane with authentication but failed to clone from GitHub.
      • Check spec.git.repositories>remote,branch.

Confirmation

  1. Access the Piped settings page on the console: http://localhost:8080/settings/piped

    If successful, you will see a green mark(Online) in the Name area. If not green, please wait for a few minutes. Piped Status

See Also

Next: Deploy >

< Previous: 2. Install Control Plane

Footnotes

  1. Do NOT push a Piped Key to remote because it is a credential. In actual use, you should store it and piped.yaml in a secret management tool. ↩

  2. --insecure option disables TLS of the communication from the Piped to the Control Plane. (cf. Piped's Runtime Options) ↩