This chapter provides information that will help you quickly become productive with uDeploy. First, it describes the steps performed to install and configure uDeploy. Next, it provides the "happy path" to productivity: it describes how to create components and define applications to deploy them, and, finally, describes how to perform deployments. The following topics should be reviewed in order.
Other topics you might find of interest are provided in the section called “Other Topics”. This book also provides a step-by-step tutorial on creating components and applications.
Installing uDeploy
A basic configuration consists of a server, a database, and at least one agent. In production environments, all three should be installed on separate machines.
The following table summarizes basic installation steps. Related topics are listed below the table.
Table 3. Installation Steps
| Step | Description |
|---|---|
| 1. Review installation recommendations | Requirements and recommendations, including performance recommendations, are provided. |
| 2. Download uDeploy installation files | Download the server, agent, agent relay, and CLI client (command line interface) installation packages. Installation files can be downloaded from the UrbanCode support portal http://support.urbancode.com. If you are installing an evaluation version, the license is included with the downloaded files. For evaluations, the agent relay (used to communicate with remote networks) and the CLI client can be skipped. At a minimum, an installation must have the server, a database, and at least one agent. |
| 3. Install the database | Create an empty database for uDeploy. uDeploy supports Oracle, MySQL, and Microsoft SQL Server. For installation information, see the section called “Database Installation”. Note, the installation package includes a lightweight database—Derby—that can be used for evaluation purposes. |
| 4. Install the server | For installation information, see the section called “Server Installation”. You will need to supply values for the IP address, ports for HTTP communication (secured and unsecured), port for agent
communication, and URL. The installation program provides default values for many parameters. The properties set during installation
are recorded in the installed.properties file located in the server_install/conf/server/ directory. If you intend to turn on SSL, see the section called “SSL Configuration”.
|
| 5. Install agents |
Agents are installed on target machines and communicate with the server. When installing an agent, you supply several values defined during server installation. See the section called “Agent Installation” for instructions about installing agents. An agent requires various access privileges for the machine where it is installed, which are described in that section. |
| 6. Confirm installation |
Start the server and agents. For information about running the product, see the section called “Running uDeploy”. To determine if the agent is in
communication with the server, display the web application's
Resource pane. A value of |
Related topics:
Create a Component
Components are the centerpiece of uDeploy's deployment engine. Components associate items that will be deployed—artifacts—with processes that will deploy them. The following table summarizes the basic steps performed to create components. Related topics are listed below the table.
Table 4. Component Creation Steps
| Step | Description |
|---|---|
| 1. Define source configuration | Define the source type and identify the artifacts associated with the component. The source type can be any or nearly any associated with a software project. Once defined, all artifacts must be of the defined type. See the section called “Creating Components”. |
| 2. Create component version | Create the initial component version by importing artifacts into the artifact repository, CodeStation. Versions can be imported manually or automatically. Version imports can be full (all artifacts are imported) or incremental (only changed artifacts are imported). uDeploy tracks all artifact changes which enables you to rollback components or deploy multiple versions of the same one. |
| 3. Create component process | Use the process design editor to create a process for the component. Component processes consist of user-configured steps that operate on the component, usually by deploying it. The available steps are provided by installed plug-ins. As shipped uDeploy provides plug-ins for many common functions. Numerous other plug-ins are available from UrbanCode—http://plugins.urbancode.com. |
Related topics:
Create an Application
Applications associate components with the agents that will manage them, and define processes to perform deployments.
The following table summarizes the steps performed to create applications.
Table 5. Application Creation Steps
| Step | Description |
|---|---|
| 1. Create an application and identify its components | After defining the application, identify the components it will manage. Associating a component makes its processes and properties available to the application. An application can have any number of components associated with it. |
| 2. Create an environment | Define an environment and use it to map an agent to component(s). Mapping means assigning an agent to manage the component. Each component can be mapped to the same agent, a different one, or some combination. An application can have more than one environment defined for it. |
| 3. Create an application process | Use the process design editor to create a process. Application processes are created with the same editor used to create the component process, but uses a different toolkit of process steps. Previously defined component processes can be incorporated into the process. |
Related topics:
Deploy the Component
Components are deployed by application processes. The following table summarizes the steps performed to run an application process.
Table 6. Deployment Steps
| Step | Description |
|---|---|
| 1. Select environment | Application processes are run at the environment level; you run a process for a particular environment. Selecting an environment automatically selects its agent(s). All processes defined for the application are available. |
| 2. Run processs | You run a process by selecting it for a given environment and specifying certain other parameters. Processes can also be run with the CLI, or scheduled for a future time. |
| 3. Check results | When a process is started, the Application Process Request pane displays information about the application's status and provides links to logs and the application manifest. If an approval or manual task was used, this pane enables affected users to respond. |
Related topics:
Other Topics
The following list provides links to additional topics.
