Manage components

2 minute read

A component is a connected source code repository that enables you to create and run workflows in the CloudBees platform. Refer to the components documentation 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. 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, or select Filter to list components by last run status.

  2. 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 source code repository.

To create a component, you must have a valid GitHub or Bitbucket account containing at least one source code repository.

To create a component:

  1. Follow the steps to connect your repository to the CloudBees platform at SCM integrations.

  2. Select an organization, and then select Components.

  3. Select Create component.

  4. Select a connected repository from the options, or enter all or part of a repository name into Search, and then select a connected repository. The repository integration you have set up displays in the connected repository list.

    • Select Hide connected repositories to display connected repositories as grayed out on the list.

    • Select Show connected repositories to include all repositories in the list.

    • Select Connect your repository to create a new integration, if desired.

  5. Select Next.

  6. Enter a Component name.

  7. (Optional) Enter a Description.

  8. Select Create.

The component is created accordingly.

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