Skip to main content
How to use Jenkins with your Orka environment. The Orka by MacStadium plugin for Jenkins lets you provision permanent and ephemeral Jenkins agents in your Orka environment. The provisioning of permanent agents is useful when you need to have complete manual control over the process and the lifecycle of the agents. The provisioning of ephemeral agents is useful when you need to automatically create and delete agents based on the needs of your workflows.
IMPORTANT Orka 3.1.x and above requires version v2.0.0+ of the plugin.

​
Install the plugin

The Orka by MacStadium plugin is available in the Jenkins Plugin Manager. For more information about how to install publicly available Jenkins plugins, see Jenkins Documentation: Managing Plugins. If you need to manually build, package, and run the plugin yourself, visit the plugin repo for the latest information.

​
Provision agents with the plugin

IMPORTANT Make sure that your Jenkins master is connected to your Orka environment through VPN. You can use a VPN client to establish temporary connectivity, or you can create a site-to-site VPN tunnel to keep the connection alive at all times.
The Orka by MacStadium plugin wiki provides the latest information about how to use the plugin.
Apple ARM-based Nodes Support Make sure to increase Jenkins timeout to accommodate agents that are using Apple Silicon images and are deployed for the first time on an ARM-based node.

​
How to Enable Logging for the Orka Plugin for Jenkins

If you’re troubleshooting issues with the Orka plugin for Jenkins (current version: v2.09), you can enable detailed plugin logging directly from the Jenkins interface using the built-in System Log feature.

​
Steps to Enable the Orka Plugin Logger

  1. In Jenkins, go to Manage Jenkins -> System Log.
  2. Click Add new log recorder.
  3. Enter a name for the log recorder (e.g., Orka Plugin).
  4. Click Add under Loggers.
  5. In the Logger field, enter: 
   io.jenkins.plugins.orka
  1. Set the Log Level to All.
  2. Click Save.
Jenkins will now capture detailed logs for the Orka plugin. You can view them by returning to Manage Jenkins → System Log and selecting the recorder you created.

​
Performance Note

Using the All log level is the most verbose setting and can slow down Jenkins. If you notice performance degradation, you can limit logging to the core cloud class instead:
  • In the Logger field, use:
  io.jenkins.plugins.orka.OrkaCloud
  • Keep the log level set to All.
This collects the most relevant logs while reducing overall volume.

​
Plugin Requirements

  • Orka by MacStadium 3.0+ — The current plugin requires Orka 3.0 or later. If you are running Orka 2.x, use plugin version 1.35.
  • A VPN connection to your Orka environment is required. Your Jenkins master must have network visibility to the Orka cluster.

​
Need More Help?

If you’re still experiencing issues after reviewing the logs, contact MacStadium Support and include the log output for faster troubleshooting.