Running jobs on Arm machines

In addition to x86/x64, Shippable also supports Arm builds. It is the only hosted CI/CD platform to offer native CI/CD for Arm developers.

Even better news? Building on Arm machines is absolutely free for open source projects! Thanks to our partners Arm and Packet, we have been able to forge an alliance to support the open source community.

This document explains how to enable Arm builds for your Organization/Team and configure your jobs. Before you start, please be aware of the following:

  • Your free Arm builds will be executed on a shared pool of machines that are available to all open source Arm-based projects.
  • We run each build inside a container, which is destroyed when the build ends. So your build information and artifacts will be cleaned up before the machine is repurposed for another build.
  • runCI and runSh jobs are both supported for Arm.

If you're interested in building commercial projects on Arm, you will need to use our BYON functionality

Instructions

Follow instructions below to start running builds on 32-bit/64-bit Arm machines.

1. Get a new shared license

You can get a shared license to run 32-bit/64-bit builds by requesting a license from the Subscription Billing page.

Subscription Billing Page, contact us for Arm builds

Click on the Contact Us link and let us know if you want to run builds on 32-bit or 64-bit Arm machines, and whether your repositories are public or private. Accordingly, a Shippable Admin will add the requested license for your subscription.

Subscription Billing Page, contact form for Arm builds

2. Configure your YAML

Next, you need to configure your shippable.yml to run on this shared pool of Arm machines.

CI jobs

If you are running CI jobs, the shippable.yml configuration is explained on the YAML config page, and our support for CI in general is explained in CI overview.

  • Enable your CI project.
  • Add a shippable.yml to the root of your repository and configure your workflow. Read the configuration reference for help with config.
  • The important thing here is to configure your builds to run builds on the shared node pool. The runtime section of the YAML will help achieve this. Set it to shippable_shared_aarch64 as shown below:
runtime:
  nodePool: shippable_shared_aarch64
  • That's it! Commit your config file and your project will start building on the shared pool!

show deleted objects

runSh jobs

If you want to configure a multi-stage workflow with event driven triggers (what we call Assembly Lines, you should use the runSh job type, which can also be defined in shippable.yml. You should know the following before you use runSh:

To run your runSh job on the shared Arm node pool, add the following to your job. Set the nodePool tag to shippable_shared_aarch64, and container to true as shown below:

jobs:
  - name: myArmJob
    type: runSh
    runtime:
      nodePool: shippable_shared_aarch64
      container: true
    # rest of runSh config

Add your Assembly Line config to Shippable and start building your runSh job!

FAQ's

  • What are shared node pools and how are these different from other node pool types?

Shared node pools are admin-managed node pools that are available to all the subscriptions. To give an example, Arm nodes are part of shared node pools. This means Shippable admins will take care of managing the nodes in that node pool, while the customers can just use the node pool name in their build yml to run the job on Arm nodes. Subscription node pools, on the other hand, are specific to a particular subscription and need to be managed by subscription owners. Refer to the linked documentation for more details on Subscription node pools.

  • Can I use shared node pools along with subscription node pools?

Yes, you can! You can verify if the shared node pools have been enabled or not by navigating to the node pools page. If you see a section at the bottom of the page that looks like following, shared node pools are available for use.

shared node pools

Now all you need to do is configure the yml to specify the node pool. You could also use multiple node node pools using instructions provided here

  • How do I use Docker commands on shared node pools ?

Yes, all Docker commands are supported for builds running on shared node pools. Shared node pools use Docker in docker to keep a clear separation between build containers of different users. This means each build will get access to a dedicated docker-in-docker container. Any Docker commands that are executed in the build will be executed inside that dedicated container and when the build finishes, that container, along with the build container, are destroyed.