GitHub Actions runners on Oracle Cloud with Cirun.

Understanding The Problem

As we all know GitHub Actions is a CI/CD platform used to automate the builds, test, and deployment process. GitHub Actions uses workflows to automate the whole process. We can run the builds and tests on every push and pull request, or even on merging the pull request with workflows. For all this GitHub Actions use its cloud machines but also they have some limitations.

1. GitHub Actions does not provide support for custom images, or customized configurations of hardware. Sometimes users need a custom image to complete their build and run tests on it according to their use case. Also, GitHub Actions provides a fixed configuration of the systems.

2. It does not provide users with GPU instances. When working on stuff like MLops that may requires GPU to build.

3. GitHub Actions provide you with limited execution time for each run in a workflow that is 6 hours. If a job takes more than this time to execute it will automatically terminate. GitHub provides you with 2000 minutes/month and 500 MB of free storage. To use beyond these limits we have to pay some amount. You can see the pricing here.

What if we can automate this whole process on our cloud and run workflows on desired machine?

Definitely, we can do this on our cloud using GitHub actions feature self-hosted runners and Cirun. Also, we have to pay what we are using.

About Cirun

Cirun provides self-hosted GitHub Actions Runners on your clouds.

From Flowchart

We can see whenever an event is triggered on the repository. GitHub sends a webhook to cirun. Cirun authenticates the cloud using credentials provided by you. It takes Machine configurations defined in .cirun.yml from your GitHub repository and sends a request to the cloud for creating instance. The cloud will create a instance using .cirun.yml file, and then all workflow files defined on the GitHub repo will run on the instance. Besides all of this, Cirun continuously checks whether the workflow is completed and the machine is idle or not? If condition is satisfied then cirun delete's the VM, and we have to pay what we used.

This blog explains GitHub Actions runners on Oracle Cloud with Cirun.. For reference, you can check cirun documentation.

The steps are almost the same for other cloud providers.

1. In Cirun, log in with GitHub
2. Install Cirun on your Repository
3. Toggle on the Repository to activate.
4. Pass your cloud credentials and connect Oracle with Cirun
5. Add workflow file and .cirun.yml file on your repository
6. Now push a trigger in your Repository

It's done! 🚀

Demo

In Cirun login with GitHub

Install Cirun on your Repository

1. Configure Cirun
2. Give access to repositories
3. To activate the repository toggle the button.

Adding Oracle cloud to Cirun

NOTE: Make sure you have permissions to create VMs/runners.

1. Navigate to profile.

• Click on API keys
  

• After clicking on Add api key, download private key and hit add button.
  

• After adding, you will have this kind of configuration file. Copy user, fingerprint, tenancy and paste them in text file.
  

• Then navigate to compartments and copy ocid, then paste this inside text file as compartment_id=.

• Paste your text saved in text file and downloaded private key in Cirun dashboard under cloud section.

Add Workflow file on your Repository

Create a oracle.yml file inside .github/workflows. In workflow you can put jobs you want. For example paste the yml file given below to print the hostname, system info, memory, architecture, OS version. For latest file you can visit GitHub repo.

name: GitHub Actions on Oracle Cloud

on: push
jobs:
  build:
    runs-on: [self-hosted, oracle-cloud]

    steps:
      - uses: actions/checkout@v3
      - name: Get Hostname
        run: |
          hostname
      - name: Get system Information
        run: |
          uname -a
      - name: Get Architecture
        run: |
          dpkg --print-architecture
      - name: Get system Disk space
        run: |
          df -h
      - name: Get OS version
        run: |
          cat /etc/*release
      - name: Run "lscpu"
        run: lscpu
      - name: hello world
        run: echo hello world
      - name: Todays Date
        run: date

Now add a .cirun.yml file in your Repository

In this yml, we define the configuration and flags we want on your clouds (AWS, GCP, Oracle, etc.), instance_type, and machine_image. To explore more you can visit cirun documentation.

In this blog, we are creating .cirun.yml file for the AWS cloud with the infinitely scalable runner.

runners:
  runners:
  - name: oracle-runner
    cloud: oracle
    instance_type: VM.Standard.E2.1.Micro
    machine_image: ocid1.image.oc1.uk-london-1.aaaaaaaavy5v3inu2ho2h57vwvvsclukdh4jvhg45um2nrejyxa7s46zcwoq
    region: uk-london-1
    workflow: .github/workflows/oracle.yml
    labels:
      - oracle-cloud

Pushing a trigger

• To trigger an event we must commit something in our repo.

• With a new commit, cirun sends a request to the cloud then the cloud makes a instance and runs the workflow

• Printed the hostname, system info, memory, architecture, OS version.

Conclusion

GitHub Actions provide us with self-hosted runners for your repository but setting up them is a tedious task. You can automate the set-up process using cirun. Cirun charges some amount for private repositories and you have to pay for what you use on your cloud. Cirun supports all major cloud providers at this time. (AWS, GCP, Digital Ocean, Azure, Openstack, Oracle).
For more information you can visit cirun.io.

References

• Cirun
• Cirun documentation
• Repository used for demo

If you have any questions and feedback about this blog, feel free to comment or reach out Cirun.io.