Manage components

3 minute read

A component is a connected source code repository (SCM) that enables you to create and run workflows in the CloudBees platform.

Refer to Components to gain a deeper understanding of how to use components in the platform, and use role-based access control to manage permissions for component-related tasks. To learn how to connect your SCM, refer to SCM integrations.

Perform any of the following management functions on components in your organization:

Access a component

Select an organization, and then select Components, to display all components within that organization, including links to associated repositories and workflow runs.

Component filter
Figure 1. An example component list filtering for successful runs.

Perform any of the following in the component list:

  1. Select the component name to view the component summary, and the Repo link to view the repository.

  2. Select the run link to view the details of the most recent run.

  3. If the run is not manually triggered, select the Trigger link to view the commit in the repository.

  4. Select COMPONENT DETAILS to view the component summary (identical to selecting the component name).

To change the view, select the icon in the upper-right corner:

  • Table: List view. Default display is sorted descending by last run.

  • Blocks: Block view. Default display is sorted left to right by last run.

  • Use Sort by to choose either Ascending or Descending alphanumerical sort order for Component or Last run.

  • In table view only, select Sort down or Sort up next to a component list column heading to sort on that heading.

To access a component from the list:

  1. (Optional) Search for a specific component by entering all or part of its name into Search.

  2. (Optional) Select Filter to select for components by the status of their most recent run. Only status types which are present in the unfiltered list are available in the filter.

  3. Select a component name (in table view only) or Component details.

The component details are displayed accordingly.

Create components

Create one or more components at once, each connected to a single integrated SCM. Choose the organization where you want to create each component.

To create components:

  1. Configure an SCM integration with the CloudBees platform. You can integrate one or more repositories in your SCM organization.

  2. Select an organization, and then select Components.

  3. Select Create component.

  4. (Optional) Filter the integrated repository list by any of the following:

    1. Select Filters to filter by SCM provider: GitHub or Bitbucket.

    2. Enter all or part of a repository name into Search.

    3. Select Hide connected repositories to show only those repositories available for connection (not yet connected to a component).

      Filter repositories
      Figure 2. Component creation using three filters.
      Filters lists the number of active filters.
  5. Select a repository, which sets Organization to the current organization (the default).

  6. (Optional) Select Organization to choose a different organization:

    1. Select a different organization from the options.

    2. Select Save.

      Select organization
      Figure 3. Organization options selector highlighted.
  7. (Optional) Select more repositories, if desired.

    • Each repository selection creates a new component.

    • For each repository selected, you have the option to create the component in the organization of your choice.

  8. Select Create components to create and list your new components.

  9. Select Finish and close to return to Components for your current organization.

Each component is created in the organization of your choice, and listed by the repository name in Components for that organization. Select the organization name in the breadcrumbs to switch to a different organization.

Move a component

Move a component from one organization to another.

To move a component:

  1. Select a component.

  2. Select Vertical ellipsis next to the component you want to move.

  3. Select Move component.

  4. (Optional) Search to find the target organization.

  5. Select the target organization from the list.

  6. Select Move.

The component you have moved is now displayed on the component list for the target organization.

Update a component

Update the Component name or Description of a component.

To update a component:

  1. Select a component.

  2. Select Vertical ellipsis next to the component you want to update.

  3. Select Edit component.

  4. Make any desired changes.

  5. Select Save.

The selected component is updated accordingly.

Delete a component

Delete any of your components. A deleted component is completely removed from all organizations in the CloudBees platform, and deletion is irreversible.

To delete a component:

  1. Select a component.

  2. Select Vertical ellipsis next to the component you want to delete.

  3. Select Delete component.

  4. Select Delete.

The selected component is deleted and removed from the component list.