Working with servers


Servers, in Pipelines, are used for deployments and builds. A server is either a physical or a virtual machine instance running a single copy of an operating system, which we identify via a unique host name. These servers may, for example, be on your desktop, in a co-location facility or somewhere in the cloud.

Adding a new server

Adding servers to Pipelines, can be accomplished via several methods.

  • Installing the Pipelines Agent on the server.
  • Using the distelli.yml to automate the Pipelines Agent install.
  • Using the new server workflow.
  • Using Pipelines to provision EC2 servers.

This document documents using the new server workflow for adding servers to Pipelines. For more information on other methods see:

  • Pipelines agent is required on the server to communicate with Pipelines.
  • distelli.yml file for automating the agent install, credentials, and environment deployments.
  • Provisioning EC2 Servers for use with Pipelines.

New Server Workflow

To begin the new server workflow:

  1. Click the Servers link at the top of the Pipelines web UI.
  2. Click the Add Server button at the top right.

This will allow you to add your existing hardware, or launch a new AWS EC2 instances.

1. Add an existing server or launch a new one

  1. Click the Add Existing Server button.

2. Install the Pipelines Agent

Note: You must login to your server and install the agent.

  1. Login to the server and use the Pipelines Agent install command for your Operating System.
  2. MAC and Linux use the wget or curl. Windows, copy and paste the powershell snippet in a command (cmd) prompt.

  3. After installing the agent, in the Pipelines web UI click the Install Complete button.

3. Confirm server installation

  1. Click the Refresh Server List button to refresh the list.
  2. When you see the server that you installed the Pipelines agent on, click the server.

You can now add the server to application environments.

4. Add server to environment

  1. Select the environment(s) you wish the server to join.
  2. Click Add Environments.

Viewing a server

There are several places you can view your server.

  • View servers in the Pipelines web UI.
  • View server information with the Pipelines CLI.
  • View server information with the Pipelines agent.

View Servers in the Pipelines web UI

You can view your list of servers by simply clicking the Servers link at the top of the Pipelines web UI.

View a Server in the Pipelines web UI

To view a single server, click on the server name in the list of servers. Below is an example server page.

Single Server

Server History

View Server Information with the Pipelines agent

The following Pipelines agent commands will show server information.

distelli agent status

Show the status of the server and agent.

distelli agent dump

Show the Pipelines deployed applications currently on the server.

View a server’s ID

You may need to find a Server ID for use with the Pipelines API or the Pipelines CLI.

This value is not readily exposed in the Pipelines web UI.

Find Your Server ID

To find your server ID in Pipelines:

  1. At the top of the Pipelines web UI click the Servers link.
  2. Find the server that you wish to see the server ID for and click it.
  3. Look at the Web Browser URL.

In the above URL, the server ID is:


Using the API to Find Your Server ID.

Using the Pipelines API you can find server IDs with the following API Commands.

Deleting a server

You can completely remove a server from Pipelines via 2 methods.

  • Delete a Server with the agent(#delete-a-server-with-the-agent).
  • Delete a Server from the Pipelines web UI(#delete-a-server-from-the-web UI).

Delete a Server with the Agent

Executing a dagent uninstall will:

  • All Pipelines deployed applications will be removed from the server.
  • The server will be removed from all environments.
  • The server will be removed from its Pipelines account.
  • The agent supervise process will no longer start at boot.

Note: This requires root or administrator access.


dagent uninstall



The –yes option facilitates a quiet deletion and auto answers yes to the Continue? (yes/no) prompt.


# dagent uninstall
Are you sure you want to uninstall the Pipelines Agent? (to avoid this prompt, pass --yes flag)
  * All applications will be removed from this server
  * The server will be removed from all environments
  * The server will be removed from the web interface
  * The supervise process will be removed from 'upstart'
Continue? (yes/no)

Delete a Server from the web UI

A server can be deleted from Pipelines in the web UI only if the server is unavailable/down.

  1. Click the Servers link from the top of the Pipelines web UI.
  2. Find the server you want to delete, and click the red trash-can icon on the right.
  3. You are be prompted to confirm that you want to delete the server.
  4. Click Yes.

You have removed the server from Pipelines.

Provisioning GCE servers

Using Pipelines you can provision GCE instances (servers) and have them immediately available for deploys and builds.

Note: Provisioning and launching GCE instances may incur charges on your Google Cloud Account.

For more information on getting started with GCE, see the Google Cloud documentation.

Provision a GCE Instance

  1. Click the Servers link at the top of the Pipelines web UI.
  2. Click the Add Server button at the top right.
  3. This will begin the new server workflow.

  4. Click the New Google Compute Instance button.
  5. Enter your Google credentials, if necessary.
  6. Note: Ensure that your connected account has enabled the IAM, Cloud Resource Manager, and Compute Engine APIs before proceeding.

  7. If you just added your EC2 credentials, click Update Credentials.
  8. Select which Project you wish to create the instance in, then click Continue.
  9. Name your Instances, then click Continue.
  10. Names must start with a lowercase letter followed by up to 29 lowercase letters (max length is 30), numbers, or hyphens, and cannot end with a hyphen.

  11. Select Zone, then click Continue.
  12. Select Machine Type, then click Continue.
  13. Select Image Type. Note that you can select an operating system type from the top list, then select the image. When you are ready click Continue.
  14. Select Image
  15. Configure Boot Disk. Here you select the disk type and the disk size, in GB. Then click Continue.
  16. Configure Firewall. Select which protocols you wish to have opened up to this GCE Instance, then click Continue.
  17. Configure SSH Keys.
  18. Here you can enter one or more SSH keys to provide login (ssh) access to the instance. An SSH key is not required, but realize, you can't login to the instance without one.

    SSH Keys
  19. Configure Tags and Startup Script, then click Continue.
  20. Tags n Script
  21. Click Continue when you are ready.
  22. Add Environments. At this step, you can add Pipelines environments to your server. Realize that if the enviornment is configured to, which it is by default, it will automatically deploy the active release to the server when it comes up. For more information see Environment Settings.
    You do not need to select an environment.
  23. Click Continue when you are ready.
  24. Select Service Account for making Googla Cloud API calls. You may also be prompted to select any Access Scopes. When you are ready click Continue.
  25. Finally select the number of instances you wish to launch, and click Launch.
  26. Your instance(s) are being provisioned.

  27. Click Go to Servers button.

Note: GCE instances take a bit of time to completely provision (come up) and communicate on the Internet. Be patient.

Note: If you run into trouble, you can inspect and terminate the instances from the GCE cloud console.

Use your own build server

When building your application with Pipelines you can specify Pipelines to use your own build servers wherever they may exist.

Step 1. Install the Pipelines Agent

To correctly function as a build server in Pipelines you must first install the Pipelines agent on the build server.

Instructions for installing the Pipelines agent can be found here Installing the Agent.

Caution: For build server functionality, the server must be running Pipelines agent version 3.50 or greater. To see your Pipelines agent version see Pipelines the agent version command.

For more information on the Pipelines agent see Pipelines Agent reference guide.

Step 2. Install Repository Client

For your build server to be able to retrieve software code from a repository, the appropriate client software must be installed.

Note: Ensure you install the command line version. With Windows ensure you install the windows command prompt version.

Use git for BitBucket, GitHub, and GitHub Enterprise.

For more information on installing Git for Windows, please see Installing Git for Windows Build.

Use mercurial for BitBucket.

Step 3. Mark Server as Build Server

From the Pipelines web UI you mark the server as a build server.

Note: A server marked as a build server can still consume deployments from Pipelines.

  1. In the Pipelines web UI click the Servers link from the top.
  2. In the server list find the server you wish to make a build server and click the server name.
  3. On the server page click the Build Server link in the top right.
  4. In the resulting dialog box, click the Enable button.

You have enabled this server to build your applications. For more information see Setting Build Server Capabilities.

Step 4(VM). Enable Application to use Build Server

Note: This section is specific to using the build server with Pipelines for Applications. Please skip to the next section for using the build server with Pipelines for Containers.

For an application to use a build server it must be integrated with a repository. To integrate your application with a repository see:

Note: If your application is not integrated with a repository, this option will not be available.

To enable an application to use a build server:

  1. Navigate to the Application
  2. Ensure you are on the Overview tab.
  3. On the right click the Build Options gear.

    A dialog box will appear on the right.

  4. Click the Build on my own hardware option at the top right.
  5. Click the Save button.

You have enabled this application to build on your build servers. For more information see Setting Build Server Capabilities.

How helpful was this page?
Puppet sites use proprietary and third-party cookies. By using our sites, you agree to our cookie policy.