Components

3 minute read

A component in the CloudBees platform is a piece of software, built and, if desired, released and deployed from source code.

Access components in an org

You can directly select a component, or display all components associated with an organization (org) in a list or block view. Filter, search, or sort the components in an org.

Example component list
Figure 1. Example organization with sub-orgs and components.

In the example above, an org (Building) contains multiple sub-orgs (Suitcase) and components (Box). The indentation indicates the relationships between orgs, sub-orgs, and components.

Table 1. Org, sub-org, and component relationships in the above example.
Item Direct parent of item Direct child(ren) of item

Org A

None

Component-1, Sub-org-B, Sub-org-C

Component-1

Org A

None

Sub-org-B

Org A

None

Sub-org-C

Org A

Sub-org-D, Component-3, Component-4

Sub-org-D

Sub-org-C

Component-2

Component-2

Sub-org-D

None

Component-3

Sub-org-C

None

Component-4

Sub-org-C

None

Directly select a component

Go to any component in an org without first displaying a list of all components.

To directly select a component:

  1. (Optional) Select Up/down arrows above Home to choose an org (Building).

  2. Select Up/down arrows below Home and then perform one of the following:

    • Scroll to display the components (indicated with Box) in the org, and then select a component.

    • Search for a specific component by entering all or part of its name into Search, and then selecting a component.

The run for the component selected is displayed, and you can also select the workflows and summary for that component.

Display all components in an org

Filter, search, or sort the components in an org.

To display all the components in an org:

  1. (Optional) Select the Up/down arrows above Home to choose an org (Building).

  2. Select the Up/down arrows below Home.

  3. Select an org (Building) or sub-org (Suitcase).

    Display the component list in either list view or block view by selecting Table or Blocks, respectively, in the upper-right corner.
  4. (Optional) Select FILTER to filter components by run status:

    • SUCCEEDED

    • FAILED

    • UNKNOWN

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

  6. (Optional) Sort the component list in either of two ways:

    • Select an option in Sort by; you can choose either ASCENDING or DESCENDING alphanumerical sort order for Component, Trigger summary, or Last run.

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

      • The default table sort is descending by the most recent status.

      • In block view, components are ordered left-to-right by rows.

The component list is displayed accordingly.

Component summary

Get a comprehensive view of component activity in the Summary listed on the left pane. This dashboard includes commit, build, and deployment information, and provides detailed security scan results. Refer to the component summary documentation to learn more.

Create a component

Create any number of components.

To create a component:

  1. Select Up/down arrows and select an org.

  2. Select Create component.

  3. Select a connected repository from the options, or enter all or part of a repository name into Search, and then select a connected repository.

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

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

    • Select CONNECT YOUR REPOSITORY to create a new integration.

  4. Select NEXT.

  5. Enter a Component name.

  6. (Optional) Enter a Description.

  7. Select CREATE.

The component is created accordingly.

Move a component

Move a component to a different org.

To move 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.

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.