Skip to content

fix: Add Architecture Flexibility to Dockerfile #48

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
celanthe wants to merge 1 commit into from
Closed

fix: Add Architecture Flexibility to Dockerfile #48

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,22 @@ WORKDIR /workspace

ARG ORKA_VERSION=3.1.0

ARG TARGETARCH=amd64

# Make it runnable on a distroless image/without libc
ENV CGO_ENABLED=0

COPY go.mod go.sum ./

RUN go mod download

# Download Orka CLI for the specified architecture
# For Intel-based Orka nodes: use amd64 (default)
# For Apple Silicon-based Orka nodes: use arm64

RUN set -eux \
&& curl --location --fail --remote-name \
https://cli-builds-public.s3.eu-west-1.amazonaws.com/official/${ORKA_VERSION}/orka3/linux/amd64/orka3.tar.gz \
https://cli-builds-public.s3.eu-west-1.amazonaws.com/official/${ORKA_VERSION}/orka3/linux/${TARGETARCH}/orka3.tar.gz \
&& tar -xzf orka3.tar.gz -C /usr/local/bin

COPY . .
Expand Down
60 changes: 57 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,17 @@ Before using the Orka GitHub Runner, ensure that the following prerequisites are

* GitHub App: Having a GitHub App is a prerequisite for using the Orka GitHub Runner. You can find instructions on creating a GitHub App in the [Creating a GitHub app](docs/github-app-setup-steps.md) file.
* Connectivity to Orka 3.0+ cluster: Ensure that the machine where the Orka Github Runner is started has connectivity to the Orka cluster. Additionally, ensure that the SSH ports are open to enable the runner to establish SSH connections with Orka VMs.
* The Orka GitHub runner has been tested with GitHub.com hosted environments.
* The Orka GitHub runner has been tested with GitHub.com hosted environments.

### GitHub Enterprise Server
### GitHub Enterprise Server

The Orka GitHub Runner now supports GitHub Enterprise Server (GHES) environments. To use the runner with GHES, you'll need to provide the following additional environment variables:

* `GITHUB_API_URL`: The URL of your GitHub Enterprise Server API endpoint (e.g., `https://github.enterprise.com/api/v3`)
* `GITHUB_TOKEN`: A GitHub token with appropriate permissions to avoid rate limiting

When using GHES, make sure to:

1. Configure the `GITHUB_URL` to point to your enterprise instance (e.g., `https://github.enterprise.com`)
2. Set the `GITHUB_API_URL` to your enterprise API endpoint
3. Provide a valid `GITHUB_TOKEN` with appropriate permissions for pulling the runner from github.com
Expand All @@ -41,14 +42,66 @@ The runner will automatically detect if you're using GHES based on the provided

You can get the Orka GitHub runner by downloading it from [this link](https://github.com/macstadium/orka-github-actions-integration/pkgs/container/orka-github-runner). You will be able to execute the runner (via `docker run`) from any machine that has connectivity to the Orka cluster. If running within MacStadium, you can request 2 vCPU of Private Cloud x86 compute with 15GB of storage to run the container, with the corresponding compute billed as a part of your Virtual Private Cloud (VPC) services.

### Architecture Support

The Orka GitHub Runner supports both Intel-based (AMD64) and Apple Silicon-based (ARM64) Orka clusters. When building from source or selecting a pre-built image, ensure the architecture matches your Orka infrastructure.

#### Supported Architectures

* **AMD64** (Intel-based Orka nodes) - Default
* **ARM64** (Apple Silicon-based Orka nodes)

#### Using Pre-built Images

Pre-built images are available from the GitHub Container Registry for both architectures:

```bash
# Docker will automatically pull the appropriate architecture for your host machine
docker pull ghcr.io/macstadium/orka-github-runner:<version>
```

To verify the architecture of a pulled image:

```bash
docker inspect ghcr.io/macstadium/orka-github-runner:<version> | grep Architecture
```

#### Building from Source

If you need to build the Docker image yourself, specify the architecture using the `TARGETARCH` build argument:

**For Intel-based Orka clusters (AMD64) - Default:**

```bash
docker build -t ghcr.io/macstadium/orka-github-runner:latest .
```

**For Apple Silicon-based Orka clusters (ARM64):**

```bash
docker build --build-arg TARGETARCH=arm64 \
-t ghcr.io/macstadium/orka-github-runner:arm64 .
```

#### Architecture Selection Guide

| Orka Node Type | Architecture | Build Argument |
|---------------|--------------|----------------|
| Intel-based Mac | AMD64 | Default or `--build-arg TARGETARCH=amd64` |
| Apple Silicon Mac (M1/M2/M3/M4) | ARM64 | `--build-arg TARGETARCH=arm64` |

> **NOTE**: If you encounter an "exec format error" when running the container, the container architecture doesn't match your Orka cluster. Rebuild or pull the image with the correct architecture.
For more information about Orka's architecture support, see the [Orka Apple Silicon documentation](https://support.macstadium.com/hc/en-us/articles/28340672222363-Apple-Silicon-Based-Support).

### Environment variables

The Orka GitHub runner requires the following environment variabales to be configured:

* `GITHUB_APP_ID`: The unique identifier for the GitHub App. Detailed instructions on setting up a GitHub app can be found [here](./docs/github-app-setup-steps.md).
* `GITHUB_APP_INSTALLATION_ID`: The installation identifier for the GitHub App.
* `GITHUB_APP_PRIVATE_KEY_PATH` or `GITHUB_APP_PRIVATE_KEY`: The private key associated with the GitHub App. You can either provide the file path to the private key using `GITHUB_APP_PRIVATE_KEY_PATH` or directly provide the private key string using `GITHUB_APP_PRIVATE_KEY`. At least one of these environment variables must be set.
* `GITHUB_URL`: The URL of the GitHub repository or organization.
* `GITHUB_API_URL`: (Optional) The URL of the GitHub API endpoint. If not provided, it will default to github.com api endpoint if Github URL starts with "https://github.com" otherwise defaults to "<GITHUB_URL>/api/v3"
* `GITHUB_API_URL`: (Optional) The URL of the GitHub API endpoint. If not provided, it will default to github.com api endpoint if Github URL starts with "<https://github.com>" otherwise defaults to "<GITHUB_URL>/api/v3"
* `GITHUB_TOKEN`: (Optional) A GitHub token to avoid rate limiting. Required for GitHub Enterprise Server.
* `ORKA_URL`: The URL of the Orka server.
* `ORKA_TOKEN`: The authentication token for accessing the Orka API. A token can be generated by an admin user with the command `orka3 sa token <service-account-name>`.
Expand Down Expand Up @@ -96,6 +149,7 @@ Currently, our setup supports only one runner scale set. However, if you need to
## How to upgrade?

Upgrading the Orka GitHub plugin to the latest version ensures you have the latest features and bug fixes. Follow these steps to upgrade the plugin:

1. <b>Check for updates</b>: Visit [the Orka GitHub packages page](https://github.com/macstadium/orka-github-actions-integration/pkgs/container/orka-github-runner) to find the latest version of the plugin.
1. <b>Download latest release</b>: Use the command `docker pull ghcr.io/macstadium/orka-github-runner:<version>` to download the latest release of the Orka GitHub plugin.
1. <b>Check for running GitHub CI jobs</b>: Before proceeding, verify that there are no active CI jobs that are currently running.
Expand Down
Loading