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 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 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

Set up configuration as code with GitHub

4 minute read
How-to guide— Task-oriented: directions to achieve a specific goal.

Connect a GitHub repository to a CloudBees Feature Management application to manage flags, target groups, and flag configurations as YAML files in your repository.

For background on how CasC works, refer to Understanding configuration as code.

Prerequisites

  • Install the CloudBees Feature management SDK in your application.

  • Have a GitHub repository to store your CasC files. Before connecting to a new repository, ensure it contains at least one commit, such as a README. For more information, refer to Quickstart for repositories.

  • To connect a repository that is not yet installed in CloudBees Unify, you must have administrator access to CloudBees Unify, and permission to install GitHub Apps in the GitHub organization that owns the repository. If you do not have this access, ask an administrator to connect the repository for you.

CloudBees Unify connects to GitHub through a GitHub App, and only reads and writes the CloudBees Feature Management files in the repository you select.

Open the configuration as code panel

  1. Select Feature management. The default display is the Flags page.

  2. Select Application, and then select your application.

  3. Select icon Connect your configuration as code (CasC).

    The icon link appears only if CasC is not yet set up for the selected application.

The Configuration as code panel opens and lists the GitHub repositories already installed in CloudBees Unify.

Configuration as code panel
Figure 1. Configuration as code panel

  1. Search: Enter a full or partial name to find a repository.

  2. Hide connected repositories: Enable this toggle to display only repositories that are not yet connected to CasC.

  3. Repository list: Displays the GitHub repositories installed in CloudBees Unify.

  4. Connect your repository: Install and connect a repository that is not in the list.

Install the GitHub App for a new repository

Do this only if your repository is not listed in the Configuration as code panel.

  1. In the Configuration as code panel, select Connect your repository below the repository list.

  2. Select GitHub App.

  3. Enter a Name and Description for the integration.

    1. Choose a name that identifies the organization and what the integration is for, making it easy to recognize later in the list of integrations. For example, acme-corp-fm-casc.

  4. In GitHub, select the organization that contains your repository.

  5. Select the repository access for the app, and then select Save.

  6. You return to CloudBees Unify. Go back to Open the configuration as code panel.

Your repository now appears in the list. Navigate to Connect the repository.

Connect the repository

With your repository listed in the Configuration as code panel, connect it to your CloudBees Feature Management application.

  1. In the Configuration as code panel, find your repository. To narrow the list, enter part of its name in Search, or turn on Hide connected repositories.

  2. Select your repository.

  3. In Configuration branch, enter the branch where CloudBees Unify reads and writes CasC files, such as main.

  4. Select Submit.

CloudBees Unify connects the repository and creates the CasC folder structure in it. If your application already has flags, target groups, or flag configurations, CloudBees Unify writes them as YAML files in an initial commit to the configuration branch. The icon Connect your configuration as code (CasC) link at the top of the Flags page changes to a link to your GitHub repository.

Add CasC files to the repository

After you connect the repository, add YAML files in one of these ways:

  • Create entities in the UI (recommended to start).

    • Select Feature management from the left-hand navigation to create flags, target groups, or custom properties.

    • CloudBees Unify generates the appropriate YAML files in the corresponding folders of your repository, which you can then edit.

  • Write the files yourself. Create YAML files in your editor, following the folder structure below, and commit them to the repository. Refer to Example CasC folder structure.

  • Copy an existing file. Copy a YAML file, change values such as the flag name, conditions, or target group, and commit it to the correct folder.

CloudBees Unify reads only valid files in these folders, under .cloudbees/casc/feature-management on your configuration branch:

CasC folder structure in a GitHub repository
Figure 2. Example CasC folder structure

  1. .cloudbees/casc/feature-management: The root folder for all Feature management CasC files.

  2. flag-configurations: Contains flag configurations, with one subfolder per environment, such as Dev, Staging, and Production.

  3. flags: Contains feature flag definitions.

  4. properties: Contains custom property definitions.

  5. target-groups: Contains target group definitions.

For the full folder structure and YAML schemas, refer to Configuration as code reference.

Verify the setup

  1. In CloudBees Unify, create a test flag in your application.

  2. In GitHub, confirm that a YAML file for the flag appears in .cloudbees/casc/feature-management/flags on your configuration branch.

  3. In GitHub, edit the flag’s YAML file, for example by changing its description, and commit the change.

  4. In CloudBees Unify, refresh the Flags page and confirm the change appears.

If changes sync successfully in both directions, CasC is configured correctly. Delete the test flag after verifying the setup.

Next steps