Skip to content

Latest commit

 

History

History
283 lines (211 loc) · 13 KB

README.md

File metadata and controls

283 lines (211 loc) · 13 KB
Raw

Run macOS builds with Tekton and Orka by MacStadium

IMPORTANT: These Tasks require Tekton Pipelines v0.16.0 or later and an Orka environment running on Orka 1.4.1 or later.

With this set of Tasks, you can use your Orka environment to run macOS builds and macOS-related testing from your Tekton pipelines.

Prerequisites

  • You need a Kubernetes cluster with Tekton Pipelines v0.16.0 or later configured.
  • You need an Orka environment with the following components:
    • Orka 1.4.1 or later.
    • An Orka service endpoint (IP or custom domain). Usually, http://10.221.188.20, http://10.221.188.100 or https://<custom-domain>.
    • A dedicated Orka user with valid credentials (email & password). Create a new user or request one from your Orka administrator.
    • An SSH-enabled base image and the respective SSH credentials (email & password OR SSH key). Use an existing base image or create your own.
  • You need an active VPN connection between your Kubernetes cluster and Orka. Use a VPN client for temporary access or create a site-to-site VPN tunnel for permanent access.

See also: Using Orka, At a Glance

See also: GCP-MacStadium Site-to-Site VPN

NOTE: Beginning with Orka 2.1.0, net new Orka clusters are configured with the Orka service endpoint as http://10.221.188.20. Existing clusters will continue to use the service endpoint as initially configured, typically http://10.221.188.100.

Installation

Before you can use these Tasks in Tekton pipelines, you need to install them and the Orka configuration in your Kubernetes cluster.

Default namespace installation

To install in the default namespace of your Kubernetes cluster, run the following command against your actual Orka API endpoint.

ORKA_API=http://10.221.188.20 ./install.sh --apply

To uninstall from the default namespace, run the script with the -d or --delete flag:

./install.sh --delete

Custom namespace installation

To install in a custom namespace, run the following command against your preferred namespace and your actual Orka API endpoint:

NAMESPACE=tekton-orka ORKA_API=http://10.221.188.20 ./install.sh --apply

To uninstall from a selected namespace, run the script with the -d or --delete flag against the namespace:

NAMESPACE=tekton-orka ./install.sh --delete

Usage

You can use these Tasks one of two ways: to spin up and clean up a single macOS build agent OR multiple macOS build agents (in series or in parallel).

Single macOS build agent

To spin up, run a build on, and then clean up a single macOS build agent, you can create a pipeline based around the orka-full task.

The sample build-calcupad-pipeline shows you how to use the orka-full task in a pipeline that performs the following operations:

  1. Clones a git repository.
  2. Passes it to the Orka build agent.
  3. Stores build artifacts on a persistent volume.
  4. Cleans up the Orka environment.

Multiple macOS build agents

To spin up, run a build on, and then clean up multiple macOS build agents, you can create pipelines that use the three modular Tasks: orka-init, orka-deploy, and orka-teardown (in that order).

  1. orka-init sets up an Orka job runner.
  2. orka deploy deploys one or more VMs (either in parallel or consecutively).
  3. orka-teardown cleans up your Orka environment. This task should be used only in the finally clause of the Pipeline.

IMPORTANT: To use the modular approach, you need to configure a Kubernetes service account to run the Pipeline. See here.

The parallel-deploy sample shows you how to use the three modular tasks in a pipeline that performs the following operations:

  1. Sets up an Orka job runner.
  2. Deploys 2 VMs and executes a different script on each VM.
  3. Cleans up the environment.

Kubernetes service account setup

To use the orka-init and orka-teardown tasks, you need to configure a Kubernetes service account, a cluster role, and a cluster role binding.

Script setup

To create the service account in your default namespace, run the following command:

./add-service-account.sh --apply

To remove the service account from the default namespace, run:

./add-service-account.sh --delete

To create the service account in a custom namespace, run the following command against the namespace:

NAMESPACE=tekton-orka ./add-service-account.sh --apply

To remove the service account from the custom namespace, run the following command against the namespace:

NAMESPACE=tekton-orka ./add-service-account.sh --delete

Manual setup

If you want to set up the service account manually, you can use this sample configuration:

---
apiVersion: v1
kind: ServiceAccount
metadata:
  name: orka-svc
---
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
  name: orka-runner
rules:
  - apiGroups: [""]
    resources:
      - configmaps
      - secrets
    verbs:
      - create
      - delete
---
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRoleBinding
metadata:
  name: orka-runner
subjects:
- kind: ServiceAccount
  name: orka-svc
  namespace: default
roleRef:
  kind: ClusterRole
  name: orka-runner
  apiGroup: rbac.authorization.k8s.io

Storing your credentials

The provided Tasks look for two Kubernetes secrets that store your credentials: orka-creds for the Orka user and orka-ssh-creds for the SSH credentials.

  • orka-creds has the following keys: email and password
  • orka-ssh-creds has the following keys: username and password

These defaults exist for convenience and you can change them using the available Task parameters.

Script setup

You need to create Kubernetes secrets to store the Orka user credentials and the base image's SSH credentials.

To create a Kubernetes secret in the default namespace of your cluster, run the following commands:

EMAIL=<email> PASSWORD=<password> ./add-orka-creds.sh --apply
SSH_USERNAME=<username> SSH_PASSWORD=<password> ./add-ssh-creds.sh --apply

To remove the secrets from the default namespace, run:

./add-orka-creds.sh --delete
./add-ssh-creds.sh --delete

To create a Kubernetes secret in a custom namespace, run the following commands against your preferred namespace:

NAMESPACE=tekton-orka EMAIL=<email> PASSWORD=<password> ./add-orka-creds.sh --apply
NAMESPACE=tekton-orka SSH_USERNAME=<username> SSH_PASSWORD=<password> ./add-ssh-creds.sh --apply

To remove the secrets from the custom specify, run the following commands against the namespace:

NAMESPACE=tekton-orka ./add-orka-creds.sh --delete
NAMESPACE=tekton-orka ./add-ssh-creds.sh --delete

Manual setup

If you want to create the Kubernetes secrets manually, you can use the following example configuration. Make sure to provide the correct credentials for your Orka environment and the base image.

---
apiVersion: v1
kind: Secret
metadata:
  name: orka-creds
type: Opaque
stringData:
  email: tekton-svc@macstadium.com
  password: p@ssw0rd
---
apiVersion: v1
kind: Secret
metadata:
  name: orka-ssh-creds
type: Opaque
stringData:
  username: admin
  password: admin

Using an SSH key

If using an SSH key to connect to the VM instead of an SSH username and password, complete the following:

  1. Copy the public key to the VM and commit the base image.
  2. Store the username and private key in a Kubernetes secret:
kubectl create secret generic orka-ssh-key --from-file=id_rsa=/path/to/id_rsa --from-literal=username=<username>

See also: use-ssh-key example

Task Parameter Reference

Use the following parameters to customize the Tasks.

Common Parameters

Parameter Description Default
base-image The Orka base image to use for the VM config. ---
cpu-count The number of CPU cores to dedicate for the VM. Must be 3, 4, 6, 8, 12, or 24. 3
vcpu-count The number of vCPUs for the VM. Must equal the number of CPUs, when CPU is less than or equal to 3. Otherwise, must equal half of or exactly the number of CPUs specified. 3
vnc-console Enables or disables VNC for the VM. false
vm-metadata Inject custom metadata to the VM (on Intel nodes only). You need to provide the metadata in format:[{ key: firstKey, value: firstValue }, { key: secondKey, value: secondValue }]. Refer to inject-vm-metadata example. ---
system-serial Assign an owned macOS system serial number to the VM (on Intel nodes only). Refer to inject-system-serial example. ---
gpu-passthrough Enables or disables GPU passthrough for the VM (on Intel nodes only). Refer to gpu-passthrough example. false
tag When specified, the VM is preferred to be deployed to a node marked with this tag. ---
tag-required VM is required to be deployed to a node marked with tag specified above. false
scheduler When set to 'most-allocated', the deployed VM will be scheduled to nodes having most of their resources allocated. default
script The script to run inside of the VM. The script will be prepended with #!/bin/sh and set -ex if no shebang is present. You can set your shebang instead (e.g., to run a script with your preferred shell or a scripting language like Python or Ruby). ---
copy-build Specifies whether to copy build artifacts from the Orka VM back to the workspace. Disable when there is no need to copy build artifacts (e.g., when running tests or linting code). true
verbose Enables verbose logging for all connection activity to the VM. false
ssh-key Specifies whether the SSH credentials secret contains an SSH key, as opposed to a password. false
delete-vm Applicable only to the orka-deploy task. Specifies whether to delete the VM after use when run in a pipeline. You can discard build agents that are no longer needed to free up resources. Set to false if you intend to clean up VMs after use manually. true

Configuring secrets and config maps

Parameter Description Default
orka-creds-secret The name of the secret holding your Orka credentials. orka-creds
orka-creds-email-key The name of the key in the Orka user credentials secret for the email address associated with the Orka user. email
orka-creds-password-key The name of the key in the Orka credentials secret for the password associated with the Orka user. password
ssh-secret The name of the secret holding your VM SSH credentials. orka-ssh-creds
ssh-username-key The name of the key in the VM SSH credentials secret for the username associated with the macOS VM. username
ssh-password-key The name of the key in the VM SSH credentials secret for the password associated with the macOS VM. If ssh-key is true, this parameter should specify the name of the key in the VM SSH credentials secret that holds the private SSH key. password
orka-token-secret The name of the secret holding the authentication token used to access the Orka API. Applicable to orka-init / orka-deploy / orka-teardown. orka-token
orka-token-secret-key The name of the key in the Orka token secret, which holds the authentication token. Applicable to orka-init / orka-deploy / orka-teardown. token
orka-vm-name-config The name of the config map, which stores the name of the generated VM configuration. Applicable to orka-init / orka-deploy / orka-teardown. orka-vm-name
orka-vm-name-config-key The name of the key in the VM name config map, which stores the name of the generated VM configuration. Applicable to orka-init / orka-deploy / orka-teardown. vm-name