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 organization
You can directly select a component, or display all components associated with an organization in a list or block view. Filter, search, or sort the components in an organization.
![Figure 1. Example organization with sub-organizations and components. Example component list](_images/example-relationships.c6c8f3d.png)
In the example above, an organization (org, ) contains multiple sub-organizations (sub-orgs,
) and components (
).
The indentation indicates the relationships between orgs, sub-orgs, and components.
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 organization without first displaying a list of all components.
To directly select a component:
-
(Optional) Select the
above Home to choose an organization (
).
-
Select the
below Home and then perform one of the following:
-
Scroll to display the components (indicated with a
) in the organization, 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 organization
Filter, search, or sort the components in an organization.
To display all the components in an organization:
-
(Optional) Select the
above Home to choose an organization (
).
-
Select the
below Home.
-
Select an organization (
) or sub-organization (
).
Display the component list in either list view or block view by selecting the or
, respectively, in the upper-right corner.
-
(Optional) Select FILTER to filter components by run status:
-
SUCCEEDED
-
FAILED
-
UNKNOWN
-
-
(Optional) Search for a specific component, by entering all or part of a component name into Search.
-
(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
or
next to a column heading to sort on that heading.
-
To switch an existing sort order, select
, or
, as applicable (or select an option in Sort by).
-
The default 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.
Run details
The run details for a component include the date, status, and logs for each step of a run.
-
Select a component, which displays a list of Runs.
-
Select a run using the commit message link.
The run details for that component are displayed accordingly, as in the below example:
![Figure 2. Example run with details annotated. Run details](_images/component-run-details.cda314f.png)
Perform any of the following options in the run details:
-
Note the run number and status. Run status is displayed as follows:
-
Processing run:
-
Successful run:
-
Failed run:
-
-
Note the run start and end dates, and duration.
-
Manually rerun a workflow without a commit (within 7 days of the original run) by selecting RERUN WORKFLOW. Select STOP RUN while a run is executing to cancel the run.
-
Enter text to Search within the log. Select
and
to step through the log and highlight found instances. Select to clear the search.
-
Select EXPAND ALL to display logs for all steps.
-
Select the
, and then:
-
Select Show timestamps or Hide timestamps to display or hide, respectively, the timestamp next to each log line number.
-
Select Download log to download a compressed archive file of the log.
-
-
Select the
next to any run step to display its log.
-
Select GO TO END to scroll down to the end of a step log or the list of steps.
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:
-
Select the
and select an organization.
-
Select CREATE COMPONENT.
-
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 NEXT.
-
Enter a Component name.
-
(Optional) Enter a Description.
-
Select CREATE.
The component is created accordingly.
Move a component
Move a component to a different organization.
To move a component:
-
Select a component.
-
Select the
next to the component you want to update.
-
Select Edit component.
-
Make any desired changes.
-
Select SAVE.
Update a component
Update the Component name or Description of a component.
To update a component:
-
Select a component.
-
Select the
next to the component you want to update.
-
Select Edit component.
-
Make any desired changes.
-
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:
-
Select a component.
-
Select the
next to the component you want to delete.
-
Select Delete component.
-
Select DELETE.
The selected component is deleted and removed from the component list.deleted and removed from the component list.