Introduction
Understanding organizationsUnderstanding componentsManage organizationsManage componentsManage component Jira integrations
Understanding users and teamsUnderstanding role-based access controlManage usersManage teamsConfigure role-based access controlRBAC permissions reference
Understanding authentication in CloudBees UnifySet up multifactor authenticationConfigure SAML single sign-onConfigure OIDC authenticationConfigure network security policiesNetwork security reference
Understanding platform configurationUnderstanding environmentsManage properties and secretsManage environmentsTrack environment inventoryConfigure containersSet up preconfigured actionsConfigure notificationsSet up Slack webhook notifications
Accessibility policy referenceShared responsibility model referenceSubscription and services agreementSupport policiesSupported browsers and external tools
Introduction
Understanding CI workflowsUnderstanding custom actionsCreate a build workflowCreate a custom actionCreate and manage workflowsCreate reusable workflowsTest and validate containers in workflowsCheck out source codeTrigger workflows remotelyWorkflow syntax referenceJobs syntax referenceSteps syntax referenceServices syntax reference
View pending approval tasks in your inboxMonitor workflow runsView test results in runsView evidence in runsView deployments in runsManage workflow artifactsPublish test resultsPublish evidence itemsGenerate a software bill of materialsManage ServiceNow change requests
Configure workflow credentialsConfigure AWS credentialsConfigure container registry credentialsConfigure Git credentialsIntegrate CyberArk Conjur secrets
Understanding GitHub Actions integrationSet up GitHub Actions integrationDisplay GitHub Actions workflows and runsRegister GHA build artifactsPublish GHA deployed artifactsPublish GHA test resultsPublish GHA evidence itemsTrigger CloudBees workflows from GitHub ActionsScan with GitHub Actions
Understanding CloudBees CI and Jenkins® integrationConnect CI and Jenkins controllersMonitor CI and Jenkins buildsRegister CI build artifactsRegister CI deployed artifactsPublish CI test resultsConfigure CI security scanningCI and Jenkins integration reference
Build and publish container imagesUnderstanding external CI/CD integrationsRun external CI/CD jobsExternal CI/CD action reference
Introduction
Understanding release orchestrationManage applicationsCreate deployer workflowsCreate staged workflowsCreate and manage releasesOrchestrate multi-workflow releasesRelease management reference
Understanding artifact managementRegister and track artifactsStore and retrieve artifactsPromote artifactsGenerate a software bill of materialsArtifact management reference
Deploy with HelmDeploy to KubernetesContainer deployment reference
Deploy to AWSAWS deployment reference
Deploy with enterprise platformsExecute remote deployment commandsEnterprise deployment reference
Verify deployments with New RelicDeployment verification reference
Introduction
Understanding feature managementUnderstanding Configuration as CodeGet started with feature managementCreate and manage feature flagsConfigure feature flag targetingOrganize feature flagsImplement feature flag governanceEnable secret modeConfiguration as Code reference
Understanding flag impressions and activity statusUnderstanding flag healthUnderstanding code referencesReview and clean up feature flagsSet up code references
Understanding Jira integration for feature flagsSet up the Jira integrationLink Jira tickets to feature flags
Understanding multiple SDK keysBuild your first mobile app with feature flagsBuild your first feature-flagged web applicationBuild your first feature-flagged backend serviceInstall client-side SDKsInstall server-side SDKsConfigure multiple SDK keysFlag implementation reference
Backend SDK referenceGo SDK referenceJava SDK referencePython SDK referenceRuby SDK referencePHP SDK reference.NET/C# (server-side) SDK referenceNode.js SDK referenceMobile SDK referenceAndroid SDK referenceiOS/tvOS SDK referenceObjective-C SDK referenceSwift SDK referenceReact Native SDK referenceWeb SDK referenceJavaScript (browser) SDK referenceJavaScript SSR SDK referenceClient SDK referenceJava client SDK reference.NET/C# (client-side) SDK referenceC (server-side) SDK referenceC++ (server-side) SDK referenceC (client-side) SDK referenceC++ client SDK reference

Edge Runners binary reference

2 minute readReference
Reference— Information-oriented: exact details, structured for lookup.

The CloudBees Unify Edge runners binary supports several commands and flags to manage and operate the edge runner. Use this reference when configuring, starting, or managing the runner process from the command line.

Commands

CloudBees Unify Edge Runners connects your infrastructure to CloudBees Unify and executes CI/CD tasks.

Table 1. Available commands and flags for the Edge runner binary
Command Description

Usage: cloudbees-runner [command]

-completion

Generate autocompletion scripts for the specific shell.

configure

Configure the CloudBees Unify Edge runner.

delete

Delete the CloudBees Unify Edge runner from the server.

help

Help about any command.

run

Connects the runner to CloudBees Unify.

version

Show CloudBees Unify Edge runner version.

Usage: cloudbees-runner [flags]

-h, --help

Show help information for the edge runner CLI.

Use edge-runner [command] --help for more information about a command.

Configure

Configure CloudBees Unify Edge runners with settings such as server address, labels, and other runtime options. Configuration is saved to config.yaml in the CloudBees Unify Edge runners installation directory. The authentication token from CloudBees Unify is used for initial authentication. A private/public key pair will be generated for future authentication.

Table 2. Available configurations and flags for the Edge runner binary
Command Description

Usage: cloudbees-runner configure [flags]

--container-socket-path string

Override auto-detected container socket path.

--execution-mode strings

Execution mode (native and/or Docker). Repeatable. Defaults to Docker.

-h, --help

Help for configure.

--labels string

Comma-separated list of labels (OS and CPU architecture are added automatically).

--log-level string

Log level (panic, fatal, error, warn, info, debug, trace). Defaults to info.

--name string

Runner name (auto-generated from hostname if not provided).

--no-default-labels

Disable default labels.

--token string

CloudBees authentication token for initial setup and registration.

--token-stdin

Read CloudBees authentication token from stdin instead of --token flag.

--working-dir string

Working directory for runner execution (defaults to current directory).

Run

Start the CloudBees Unify Edge Runners and connect to CloudBees Unify. The runner will load configuration from config.yaml, check for updates, connect to the server, and begin processing tasks. Command-line flags override saved configuration values.

Table 3. Available run and flags for the Edge runner binary
Command Description

Usage: cloudbees-runner run [flags]

--disable-updates

Disable updates from being downloaded and applied automatically.

-h, --help

Help for run.

--log-level string

Set log level (panic, fatal, error, warn, info, debug, trace).

--working-dir string

Override working directory from configuration.

Delete

Delete the CloudBees Unify Edge runners registration from the server. This will remove the runner from the server’s registry and delete the local configuration and key files. This command requires an existing configuration with valid authentication credentials.

Table 4. Available delete and flags for the Edge runner binary
Command Description

Usage: cloudbees-runner delete [flags]

-h, --help

help for delete

--working-dir string

Working directory for runner execution (defaults to current directory).
Edge Runners API reference
Edge Runners hardware requirements