Getting started

CloudBees SDM is a preview, with early access for select preview members. Product features and documentation are frequently updated. If you find an issue or have a suggestion, please contact CloudBees Support. Learn more about the preview program.

CloudBees SDM requires some initial setup before users can access it. As a CloudBees SDM administrator, you will first need to:

  • Verify your account credentials provided by CloudBees.

  • Configure integrations for services like GitHub, Jira, and Jenkins.

  • Create products to model internal software development projects.

Once you have completed these steps, then CloudBees SDM will be ready to be used by your organization.

Accessing CloudBees SDM

When you joined the Preview program, your existing or new CloudBees account has a new subscription for CloudBees SDM. If an account was created for you as part of your Preview program on-boarding, you should receive initial administrative credentials for your CloudBees account and subscription management.

To access your CloudBees organization and user management:

  1. Go to app.cloudbees.com and sign in.

  2. From the upper right organization drop-down, select Manage organizations to update or modify an organization or Manage users to add or remove users associated with an organization.

  3. When redirected to CloudBees Network Portal, you may be prompted to log in again.

If you have any problems, contact CloudBees Support at support.cloudbees.com or your preview program coordinator at CloudBees.

You will need to add users for members of your team who will use CloudBees SDM. Refer to Managing accounts for instructions on adding users and modifying an organization.

Forgotten password

If you forget your password, you can reset your password using this page: https://grandcentral.cloudbees.com/forgot-password

Setting up integrations

Integrating external services like GitHub lets CloudBees SDM access data from these services. This data lets you monitor and manage the delivery of your products and features.

Integrating GitHub with CloudBees SDM lets you add GitHub repositories to products so you can display branches, pull requests, commits, and branch status.

Integrating GitHub

CloudBees SDM integrates with GitHub using the CloudBees SDM app, which connects a GitHub organization to your CloudBees SDM account. You need administrative rights on your GitHub organization to install the CloudBees SDM app.

You can associate a GitHub organization with only a single CloudBees SDM account currently.

To connect to GitHub.com, you must install the CloudBees SDM app on GitHub. After you have connected GitHub to CloudBees SDM, you can see your GitHub repository data in CloudBees SDM. Then, you can link repositories and data to products to help you to prioritize work and locate blockers.

You must have administrative privileges in CloudBees to connect GitHub to CloudBees SDM.

To connect GitHub to CloudBees SDM:

  1. Select Apps.

  2. Select GitHub, and then select Install app.

  3. On the Add GitHub app screen, verify that you want to install and configure the CloudBees SDM app, and then click Install GitHub App.

  4. On the CloudBees SDM app screen, select Configuration.

  5. Select Configure GitHub and then select Configure GitHub on the pop-up window.

  6. Select Configure on the GitHub app.

  7. Select the GitHub organization you want to associate with your CloudBees SDM account. If you only have one account, that account is associated automatically.

  8. Select one of the following options:

    • To make all repositories in the organization available in CloudBees SDM, select All repositories. All future updates will automatically be imported into CloudBees SDM.

    • To allow CloudBees SDM to access only specific repositories, select Only select repositories, and then select the repositories you want to add. Any time a new repository is added, you must update the list of approved repositories to import the updates into CloudBees SDM.

  9. Select Install.

The GitHub page now displays a list of the authorized organizations and repositories. Use Configure GitHub to update the repositories list.

To remove an integration, refer to the GitHub integrations section.

Integrating Jenkins

Refer to Jenkins integration for instructions.

Integrating Jira

Refer to Jira Cloud integration for instructions.

Using products to model work

In CloudBees SDM, products help you conceptualize offerings into segments that represent work to be completed. The products correspond to your team’s or company’s work. For example, a single product could model a software deliverable, an open-source offering, APIs, versioned software, documentation, or graphic designs.

The number of products you create in CloudBees SDM should mirror the organization of work that needs to be tracked. Let’s say that your team works on three offerings: Solution One, Solution Two, and Solution Three. You would create a product for each solution and then associate repositories for those defined products.

The more services like GitHub and Jira are integrated with CloudBees SDM, the more data is available to associate with products.

For more information about products, refer to Organizing products with Products.

Creating a product

To create a product:

  1. Select Products.

  2. Select Create product, or Create new product if this is the first product.

  3. Enter a name for the product, and then select Create.

The new product name appears on the Products.

Once the product is created, you can use the options menu (three vertical dots) to edit the product name or delete the product.

Linking GitHub repositories with a product

To add GitHub repositories to a product:

  1. Select the product name from the Products.

  2. On the left pane, select Repositories.

  3. Select Link repository or, if this is the first time you are adding repositories, select Link your first repository, to display a list of available repositories.

  4. Choose the repositories to associate with the product. You can filter the repositories list by entering a complete or partial repository name in the text box or by selecting a GitHub organization from the Organization drop-down.

  5. Select Save changes.

Linking pipelines and jobs with a product

Linking Jenkins jobs and pipelines allows you to add build and job information to products. Selecting a Jenkins job links the job and any pipelines with the chosen product. Jenkins masters need to be connected before you can link jobs and pipelines to products.

Each job can be linked to one or more products.

To link pipelines:

  1. From the Products, select a product.

  2. Select Jobs.

    • If this is the first time you are linking a pipeline, select Link your first job.

    • Otherwise, select Link jobs.

  3. Select one or more check boxes to associate those jobs with the product. Select Save changes.

Policy engine and policies

The Getting started with policies section explains how to create your first policy.

Reports

Reports are explained in the Managing reports section of the user guide.