Welcome
Modeling Software Deployment
Modeling software deployment in HCL DevOps Deploy (Deploy) includes configuring components and component processes and adding those components to applications. Then, you use processes to deploy the components to environments.
Resources
A resource is a logical deployment target that typically resolves to an agent and a user-defined construct that is based on the architectural model of HCL DevOps Deploy (Deploy).
Modifying the resource tree
You can create, delete, and modify the contents of the resource tree.
Restoring the resources from the Recycle Bin
When needed, you can choose to restore the resources to their original locations in the Resource Tree after you delete them. When restored, the resources are restored as a child resource of the original parent resource. If the parent is moved, the resource is restored to the parent's new location. However, after resources are deleted from the Recycle Bin, they cannot be restored.

Release Notes
This section includes what's new, defect fixes, and deprecations and removals in all releases.
System Requirements
This document includes information about the hardware, containers, prerequisite software, supported operating system, and database requirements with component level detail for the HCL DevOps Deploy (Deploy).
Getting Started
Quickly become productive with HCL DevOps Deploy (Deploy).
Installing
A HCL DevOps Deploy (Deploy) installation consists of a Deploy server, a database server, and at least one agent.
Upgrading and Migrating
Stay updated with latest features and functionalities by upgrading HCL DevOps Deploy (Deploy) server, agents, and relays. This section also provides instruction on how to migrate your Deploy instance.
Integrating
HCL DevOps Deploy (Deploy) supports integrations with other IBM® and HCL products, products from others, and certain cloud systems.
Administering
Learn how to administer settings in HCL DevOps Deploy (Deploy) elements and communication between the elements.
Managing Security
HCL DevOps Deploy (Deploy) uses a flexible team-based and role-based security model that maps to your organizational structure.
Modeling Software Deployment
Modeling software deployment in HCL DevOps Deploy (Deploy) includes configuring components and component processes and adding those components to applications. Then, you use processes to deploy the components to environments.
- Dashboard
  The Dashboard is a live page that gives you real-time insights into the status of your deployments and agents through graphs and charts.
- Components
  Components represent deployable items along with user-defined processes that operate on them, usually by deploying them.
- Resources
  A resource is a logical deployment target that typically resolves to an agent and a user-defined construct that is based on the architectural model of HCL DevOps Deploy (Deploy).
  - Getting started with creating resources
    Resources associate agents with components and, after they are mapped to an application environment, provide deployment targets.
  - Modifying the resource tree
    You can create, delete, and modify the contents of the resource tree.
    - Creating groups
      Resource groups organize resources into logical groupings.
    - Creating agent-type and agent pool-type resources
      Agent-type and agent pool-type resources represent the computers where components are deployed.
    - Creating component-type resources
      Component-type resources represent the components that are deployed to target environments.
    - Adding agents to resource groups
      You can find agents that are not associated with a resource and add them to a resource group.
    - Moving and copying resources
      Resource tree structures in the Resources Tree page can be configured by moving and copying the resources using the drag and drop feature.
    - Deleting resources
      When you no longer require the resources, you can remove them from the Resource Tree page and choose to delete them permanently.
    - Deleting resources from the Recycle Bin
      When you no longer require the resources permanently, you can delete the resources from the Recycle Bin by setting up time and duration for the cleanup.
    - Restoring the resources from the Recycle Bin
      When needed, you can choose to restore the resources to their original locations in the Resource Tree after you delete them. When restored, the resources are restored as a child resource of the original parent resource. If the parent is moved, the resource is restored to the parent's new location. However, after resources are deleted from the Recycle Bin, they cannot be restored.
    - Comparing and synchronizing resources
      You can compare the contents of a resource group to another group or a resource template and then apply changes to the group or template.
    - Synchronizing resources from a template
      You can add the contents of a resource template to the top-level resource group.
    - Adding resources from a template
      You can add the structure from a resource template to a new group within an existing resource group.
  - Importing resources from WebSphere® Application Server
    Use the WebSphere® Application Server - Deploy plug-in to import information about an IBM® WebSphere Application Server system into a collection of resources. Typically, importing information by using the plug-in takes less time than manually creating resources to match the IBM WebSphere Application Server.
  - Importing resources from WebSphere® Portal
    With the WebSphere® Portal plug-in, you can discover resources for a portal cell and use plug-in steps to deploy artifacts.
  - Defining default user impersonation credentials
    You can define default user impersonation credentials for a resource.
  - Resource templates
    A resource template is a model for a group of resources. The template contains a hierarchy of resources, groups, and agent prototypes that is a starting point for creating new resources.
  - Agents
    An agent is a lightweight process that runs on a deployment-target host and communicates with the HCL DevOps Deploy (Deploy) server.
  - Agent relays
    Agent relays coordinate communication between agents and the HCL DevOps Deploy (Deploy) server. Agent relays improve the performance of communication between the server and agents. Relays also allow agents to communicate through firewalls.
- Applications
  Applications are responsible for bringing together all the components that must be deployed together.
- Application environments
  An environment is a user-defined collection of resources that hosts an application.
- Application templates
  With an application template, you can save and reuse a collection of resources, environments, processes, and tagged components or component templates to create a standardized application.
- Application processes
  Application processes, like component processes, are created with the process editor. You use application processes to deploy or to roll back components.
- Application blueprints
  An application blueprint maps application components to a resource template. When you create an environment or provision one from the cloud, you can use the blueprint as a model.
- Application pipelines
  Allows you to run application processes in multiple environments and promote versions through a set of stages.
- Snapshots
  A snapshot is a collection of specific versions of components and processes. Typically, a snapshot represents a set of component versions that are known to work together. In most cases, snapshots include all of the components in an application.
- Manual application tasks
  A manual application task interrupts an application process until manual intervention is done. To create a manual task, add a manual step to an application process and select a notification template.
- Approval process
  You can add approval requirements to deployments. Deployments with approvals cannot be completed until all approvers respond. Approvers can respond to requests on the Work Items tab, or by email.
- Inventories
  You use different inventories to track installed components and properties in HCL DevOps Deploy (Deploy) elements.
- Processes
  Processes are automated tasks that run on agents.
- Statuses
  Create and apply statuses to track component inventory states or to track component versions in environments and resources.
- Properties
  Properties are variables that store information about many different elements, including components, environments, processes, and applications. You can also set global properties for the system.
- Tags
  A tag is a user-defined, shared, short label that you use to classify, view, and conduct operations on objects such as applications, components, agents, and resources.
- Webhooks
  Using the webhooks, you can send text-based responses to users in messaging platform such as MS Teams and Slack when a specific event occurs during deployment process.
Deploying
Learn how to deploy applications in HCL DevOps Deploy (Deploy).
Reporting
Provides several different deployment and security reports.
Extending Product Function
Learn how to extend the function of HCL DevOps Deploy (Deploy).
Troubleshooting and Support
Learn how to troubleshoot some common issues with HCL DevOps Deploy (Deploy).
Security Considerations
You can act to ensure that your installation is secure and set up user access controls.

Restoring the resources from the Recycle Bin

When needed, you can choose to restore the resources to their original locations in the Resource Tree after you delete them. When restored, the resources are restored as a child resource of the original parent resource. If the parent is moved, the resource is restored to the parent's new location. However, after resources are deleted from the Recycle Bin, they cannot be restored.

Before you begin

You must be logged in as an administrator or must have the permissions to Execute on Resources and Manage Children.

About this task

The Recycle Bin lists retained resources after you delete them. The recycle bin contains information such as the user who deleted the resource, the date, and the original path. You can sort and filter the resources by using this information and restore multiple retained resources at once.

Notes:

You cannot restore a resource if the parent is also deleted. Therefore, you must restore the parent resource along with the child resource.
Resources that are part of the resource template and dynamic resources, if deleted, are not moved to the Recycle Bin.

Procedure

Login to HCL DevOps Deploy (Deploy).
Go to Resources > Recycle Bin tab.
Select the checkbox that is associated with the resource to restore.

Note: You can also select multiple resources that you want to restore.
From the Actions list, click Restore.
The resources are restored and available on Resource Tree.

Results

You have restored the resources.

To add feedback about this topic, select the following checkbox:

By clicking this box, you acknowledge that you are NOT a U.S. Federal Government employee or agency, nor are you submitting information with respect to or on behalf of one. HCL provides software and services to U.S. Federal Government customers through its partners Four, Inc. Contact this team at https://hcltechsw.com/resources/us-government-contact. Do not include any personal data in this Comment box. Note: To report a problem or question about the product software, do not use this form. Instead, go to the HCL Software Support site. Personal data should not be shared in this comment box. See our Privacy Statement to understand how personal data is used.