Manage components

3 minute read

A component is a connected source code repository 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.

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. Select Filter to list 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 a component

You can create any number of components in an organization, each connected to a single source code repository.

To create a component:

  1. Configure an SCM integration with the CloudBees platform.

  2. Select an organization, and then select Components.

  3. Select Create component.

  4. (Optional) Select Edit below the organization name to change the parent organization for the component, and then select Save.

  5. Do one of the following:

    • Select a repository from the options, and then select Add.

      • Select Hide connected repositories to display only those repositories available for connection.

      • Enter all or part of a repository name into Search to select an integrated repository.

    • Select Connect your repository to create a new SCM integration, and then create a component.

  6. (Optional) Update the Component name. The default name is the name of the repository.

  7. (Optional) Enter a description.

  8. Select Next.

  9. Select Create.

The component is created accordingly and listed in Components for your 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.