When you create a component, you complete these tasks:
You name the component, specify the agent to import the artifacts, and identify the type of artifacts and their location. Source artifacts can come from a file system, a source code management system such as Subversion, or another source-type plug-in. A component can contain any number of artifacts but they must all have the same source type.
A process defines what IBM® UrbanCode Deploy does with the component's artifacts. A process might consist of any number of steps, such as stopping and starting servers, and moving files. In addition to deploying, other processes can import artifacts and run various utility tasks.
A component consists of artifacts of a single source type, and one or more processes. In addition to creating a component manually, you can use a template to create one (see Component templates), or you can import a component directly (see Importing components).
Field | Description |
---|---|
Name | Identifies the component. The value of this field is included in many UI features. |
Description | The description can be used to convey more information about the component. If the component is used by more than one application, for example, entering Used in applications A and B can help identify how the component is used. |
Teams | The team that manages the component. Previously defined teams and roles are available. For information about teams, see Security |
Template | A component template enables you to reuse component definitions. Components that are based on templates inherit the template's source configuration, properties, and process. Previously created templates are listed. A component can have a single template that is associated with it. The default value is None. If you select a template, the Template Version field is displayed which is used to select a template version. By controlling the version, you can roll out template changes as needed. The default value is Latest Version, which means that the component uses the newest version (by creation date). See Component templates. Note: If
you select a template that has a source that is configured for it,
the dialog box changes to reflect values that are defined
for the template. Several fields, including the Source
Config Type field, become populated and locked.
|
Source Config Type | Defines the source type for the component's artifacts. All
artifacts must have the same source type. Selecting a plug-in
shows additional fields that are associated with the plug-in.
Source-dependent fields are used to identify and configure the component's
artifacts. If you selected a template, this field is locked
and its value is inherited from the template. For information about creating components of specific types, see Creating components from the file system, Creating components from build integration tools,or Creating components from source-code management systems. |
Import Versions Automatically | If selected, the source location is periodically polled for new versions. Found versions are automatically imported. The default polling period is 15 seconds, which can be changed with the System Settings pane. If left cleared, you can manually create versions by using the Versions pane. By default, the box is cleared. |
Copy to CodeStation | Creates a tamper-proof copy of the artifacts and stores them in the embedded artifact management system, CodeStation. If cleared, only metadata about the artifacts is imported. In most cases, select this check box. |
Default Version Type | Defines how versions are imported into CodeStation. The Full value means that the version is comprehensive and contains all artifacts. The Incremental value means that the version contains a subset of the component's artifacts. The default value is Full. |
Use the system's default version import agent/tag | If selected, the agent or tag that you specified on the System Settings page is used to import component artifacts. The agent or tagged agents must have access to the system where the artifacts are located. See System settings. |
Import new component versions using a single agent | If selected, use the Agent for Version Imports field to designate the agent that imports artifacts into the component. The agent must have access to the system where the artifacts are located. To import artifacts from the server location, install an agent in the same location and specify that agent. |
Import new component versions using any agent with the specified tag | If selected, use the Agent Tag for Version Imports field to designate the tag that is used to identify the agents that can import artifacts into the component. Tagged agents must have access to the system where the artifacts are located. |
Inherit Cleanup Settings | Determines how many component versions are kept in CodeStation and how long they are kept. If selected, the component uses the values on the System Settings pane. If this field is cleared, the Days to Keep Versions (initially set to -1, which means keep indefinitely) and Number of Versions to Keep (initially set to -1, which means keep all) fields are displayed. With this selection, you can define custom values. By default, the check box is selected. |
Run process after creating a new version | If this option is selected, the specified application process runs in the environment that you select each time a new component version is created. |
For information about creating components of specific types, see Creating components from the file system, Creating components from build integration tools,or Creating components from source-code management systems.