IBM Code Engine Workload GitHub Action

Github Action to create or update a Code Engine workload (App, Job, Function) in IBM Cloud.

Author

Author: Ryan Tiffany

Description

This GitHub Action enables you to create or update IBM Cloud Code Engine applications, batch jobs, and serverless functions. The action allows you to target different Code Engine workload types and can be configured with the following inputs:

Inputs

Name	Required	Default Value	Description
`ibmcloud_api_key`	✅	-	IBM Cloud API Key. Please store your IBM Cloud API key securely in your GitHub repository Secrets.
`resource_group`	✅	`Default`	The IBM Cloud Resource Group to use for the Code Engine project and resources.
`code_engine_region`	✅	-	The IBM Cloud region where the Code Engine project and resources will be deployed.
`code_engine_project`	✅	-	A Code Engine Project, grouping your Apps, Functions, and Jobs.
`workload_type`	✅	-	The type of workload to create or update (App, Function, Job).
`workload_name`	✅	-	The name of the workload to create or update.
`function_runtime`	❌	-	The runtime used for the Function. Currently supported `nodejs-18` and `python-3.11` see IBM Code Engine Function Runtimes for more information.
`build_source`	❌	`.`	Path to the directory containing the source code.
`workload_cpu`	❌	`1`	CPU configuration for your workload. If not specified the Code Engine default `1` is used.
`workload_memory`	❌	`2G`	Memory configuration for your workload. If not specified the Code Engine default `4G` is used.
`workload_port`	❌	`8080`	Port configuration for your app workloads
`workload_arg`	❌	-	Custom arguments to pass to the workload
`registry_namespace`	❌	-	Name of the ICR namespace to use for workload container images
`registry_image`	❌	-	Name of the Container image to use for workload

Usage

To use this action add it to your GitHub Actions workflow YAML file. Here are some examples of how to use the action with the different workload types:

App Workload

name: Create or update Code Engine app

on:
  push:
    branches:
      - main

env:
  CODE_ENGINE_REGION: "us-south"
  CODE_ENGINE_PROJECT: "Code Engine Project Name"
  WORKLOAD_NAME: "my-cool-app"
  RESOURCE_GROUP: "my-resource-group"

jobs:

  code-engine-app:
    runs-on: ubuntu-latest
    steps:
    - name: Check out code
      uses: actions/checkout@v3

    - name: Deploy Application to Code Engine
      uses: cloud-design-dev/ibmcloud-code-engine-github-action@v20
      with:
        ibmcloud_api_key: ${{ secrets.IBMCLOUD_API_KEY }}
        resource_group: ${{ env.RESOURCE_GROUP }}
        code_engine_region: ${{ env.CODE_ENGINE_REGION }}
        code_engine_project: ${{ env.CODE_ENGINE_PROJECT }}
        workload_type: 'app'
        workload_name: ${{ env.WORKLOAD_NAME }}
        workload_port: 8080
        build_source: './app-code'
        registry_namespace: "my-icr-namespace"
        registry_image: "${{ env.WORKLOAD_NAME }}-image"

Job Workload

name: Create or update Code Engine job

on:
  push:
    branches:
      - main

env:
  CODE_ENGINE_REGION: "us-south"
  CODE_ENGINE_PROJECT: "Code Engine Project Name"
  WORKLOAD_NAME: "etl-job"
  RESOURCE_GROUP: "my-resource-group"

jobs:
  code-engine-job:
    runs-on: ubuntu-latest
    steps:
    - name: Check out code
      uses: actions/checkout@v3

    - name: Deploy Job to Code Engine
      uses: cloud-design-dev/ibmcloud-code-engine-github-action@v20
      with:
        ibmcloud_api_key: ${{ secrets.IBMCLOUD_API_KEY }}
        resource_group: ${{ env.RESOURCE_GROUP }}
        code_engine_region: ${{ env.CODE_ENGINE_REGION }}
        code_engine_project: ${{ env.CODE_ENGINE_PROJECT }}
        workload_type: 'job'
        workload_name: ${{ env.WORKLOAD_NAME }}
        build_source: './job-code'
        workload_arg: 'pull-all-env-vars'

Function Workload

Code Engine currently supports nodejs (nodejs-18) and python (python-3.11) for serverless functions. This is set with the function_runtime input.

name: Create or update Code Engine serverless function

on:
  push:
    branches:
      - main
env:
  CODE_ENGINE_REGION: "us-south"
  CODE_ENGINE_PROJECT: "Code Engine Project Name"
  WORKLOAD_NAME: "webhook-fn"
  RESOURCE_GROUP: "my-resource-group"

jobs:
  code-engine-fn-js:
    runs-on: ubuntu-latest
    steps:
    - name: Check out code
      uses: actions/checkout@v3

    - name: Deploy nodejs based function to Code Engine
      uses: cloud-design-dev/ibmcloud-code-engine-github-action@v20
      with:
        ibmcloud_api_key: ${{ secrets.IBMCLOUD_API_KEY }}
        resource_group: ${{ env.RESOURCE_GROUP }}
        code_engine_region: ${{ env.CODE_ENGINE_REGION }}
        code_engine_project: ${{ env.CODE_ENGINE_PROJECT }}
        workload_type: 'fn'
        function_runtime: 'nodejs-18'
        workload_name: ${{ env.WORKLOAD_NAME }}
        build_source: './fn-js-code'

  code-engine-fn-py:
    runs-on: ubuntu-latest
    steps:
    - name: Check out code
      uses: actions/checkout@v3

    - name: Deploy python based function to Code Engine
      uses: cloud-design-dev/ibmcloud-code-engine-github-action@v20
      with:
        ibmcloud_api_key: ${{ secrets.IBMCLOUD_API_KEY }}
        resource_group: ${{ env.RESOURCE_GROUP }}
        code_engine_region: ${{ env.CODE_ENGINE_REGION }}
        code_engine_project: ${{ env.CODE_ENGINE_PROJECT }}
        workload_type: 'fn'
        function_runtime: 'python-3.11'
        workload_name: ${{ env.WORKLOAD_NAME }}
        build_source: './fn-python-code'
        workload_cpu: 1
        workload_memory: 4G

This action is not officially endorsed by IBM Cloud but can be used as a community-contributed GitHub Action.