Introduction
Understanding organizationsBest practices: organization designUnderstanding componentsManage organizationsManage componentsManage component Jira integrationsOrganization inheritance reference
Understanding users and teamsUnderstanding role-based access controlManage usersManage teamsConfigure role-based access controlRBAC permissions reference
Understanding authentication in CloudBees UnifyPersonal access tokensManage personal access tokensSet 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 application security posture managementUnderstanding Jira ticket creationUnderstanding security center workflowsConfigure security toolsConfigure implicit security analysisConfigure Jira ticketing for an applicationConfigure SBOM analysisDefine security SLAsTriage security findingsUse the organization security dashboardUse the component security centerUse the application security centerUse security overview
Get started with security scanningConfigure SAST scanningConfigure DAST scanningConfigure container scanningConfigure SCA scanningConfigure secret scanningConfigure IaC scanningVerify CloudBees action image signatures and SLSA attestationsSecurity scanner referenceSecurity findings taxonomy
Introduction
Actions catalog
Understanding workflowsCreate a build workflowCreate and manage workflowsCreate reusable workflowsTrigger workflows remotely
View pending approval tasks in your inboxMonitor workflow runsView test results in runsView evidence in runsView deployments in runsManage workflow artifacts
Understanding custom actionsCreate a custom action
Configure workflow credentialsConfigure AWS credentialsConfigure container registry credentialsConfigure Git credentialsIntegrate CyberArk Conjur secrets
Check out source codeBuild and publish container imagesTest and validate containers in workflows
Publish test resultsPublish evidence itemsGenerate a software bill of materialsManage ServiceNow change requestsServiceNow actions reference
Workflow syntax referenceJobs syntax referenceSteps syntax referenceServices syntax 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

Execute jobs with Edge Runners

2 minute readAutomation
How-to guide— Task-oriented: directions to achieve a specific goal.

Execute jobs on your edge runners by specifying runner labels in your workflow definition. Before you begin, complete Get started with Edge Runners and ensure that your organization has at least two registered runners.

  1. Create a component in CloudBees Unify.

  2. Create a workflow.

    For each workflow you want to execute on-premises, use runs-on to specify the labels of your edge runner. Any runner available for the workflow (in the organization hierarchy) and matching the labels will execute the remote job. For example:

    apiVersion: automation.cloudbees.io/v1alpha1
kind: workflow
name: My workflow

on:
  push:
    branches:
      - '**'
  workflow_dispatch:

jobs:
  build:
    runs-on: [label1]
    steps:
      - name: Say hello
        # note: uses is only supported when running in container based execution mode
        uses: docker://golang:1.20.3-alpine3.17
        shell: sh
        run: |
          echo "hello world "
    ▼

    All CloudBees Unify workflow features are supported in Edge runners, with the only exception being sidecar services.

  3. Trigger the workflow.

    When the workflow runs, an eligible edge runner picks up and executes the job. For a runner to be eligible, it must declare all the labels specified in the job. When more than one runner is configured and available for that workflow, any of the matching runners can execute the job.

    Anyone who can create and execute workflows in organizations where runners are available can run scripts on the runner. There is no sandboxing or containerization support at this time. Execute the runner in a container locally, if desired, for testing purposes. However, there is currently no published container image available.

Monitor the job execution in the CloudBees Unify interface and review the logs on your edge runner to verify that the job is running as expected. For more information about best practices for securing your edge runners, refer to Edge Runners security best practices.

CloudBees Unify recommends registering at least two groups of runners for workflow job execution; one for operations with private tools like SCM, and one for user defined workflow execution. Integration with GitHub enterprise requires at least two runner groups.