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.
Processes
Processes are automated tasks that run on agents.
User impersonation for process steps
HCL DevOps Deploy (Deploy) can use user impersonation when an agent must run a command for which it might not otherwise have permission, or when a specific user must be employed for a process.

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.
- 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).
- 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.
  - Process step types and logic
    When you design processes, you use different kinds of process steps and joining techniques. You can assign properties to process steps and use them to control step execution.
  - Component processes
    A component process is a series of user-defined steps that operate on a component's artifacts. Each component has at least one process that is defined for it and can have several.
  - Application processes
    You can use application processes to deploy or to roll back components.
  - Generic processes
    Generic processes are not specific to a particular component and can be used in any number of applications. They are like general purpose processes. You can use generic processes to download and install packages on the system or perform other configuration management related tasks such as configuring SSH or completing FTP tasks. With a generic process, for example, you can update Linux agents that were recently installed by using SSH to run as a service on a Linux computer. Linux agents cannot be updated in this way during a remote installation.
  - Editing processes
    In the process editor you organize the steps in a process, specify their properties, and connect them to each other.
  - Working on processes in safe edit mode
    Safe editing enables you to test component processes before making them available in normal environments. Make updates to your component process, test those updates safely, and then promote to a new version when you are ready.
  - Running processes
    The way you run a process is different for each type of process.
  - Adding process properties
    A process property provides a way to add user-supplied information to a process. A running process can prompt users for information and then incorporate it into the process. For example, if the process entails authenticating with another server, you can require that a user enter an ID and a password for the process to continue. Properties are defined in the Edit Property dialog box.
  - Copying process steps
    You can copy and paste process steps in all process types: component, application, approval, and generic.
  - Manage process step authentication
    Use token restrictions to manage process step authentication.
  - User impersonation for process steps
    HCL DevOps Deploy (Deploy) can use user impersonation when an agent must run a command for which it might not otherwise have permission, or when a specific user must be employed for a process.
    - Impersonation on Linux™ and UNIX™ systems
      The su command (as used by HCL DevOps Deploy (Deploy)) enables a user to start a shell as another user (process steps can be considered individual shells).
    - Impersonation on Windows™ systems
      For agents that are running on Windows™, HCL DevOps Deploy (Deploy) provides a program that handles impersonation.
    - Impersonation on z/OS® systems
      The su command is used to impersonate users on agent computers that are running IBM® z/OS®.
  - Process steps: Reference
    Application processes, component processes, and generic processes are created with the process editor.
- 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.
- Secret Stores
  Allows you to retrieve credentials of individual servers from the Vault and authenticates a plug-in step in the 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.

User impersonation for process steps

HCL DevOps Deploy (Deploy) can use user impersonation when an agent must run a command for which it might not otherwise have permission, or when a specific user must be employed for a process.

On UNIX™ and Linux™ systems, the su and sudo commands are used to impersonate users; on Windows™ Deploy provides a utility program to handle impersonation. You implement impersonation when you configure a component's plug-in process step or resource.

Note:

When using impersonation, the user running the agent needs to have read, write, and execute access to the <DEPLOY_AGENT_HOME>/var/work directory.

The user starting the plugin as impersonating user needs to also have read, write, and execute access to the <DEPLOY_AGENT_HOME>/var/work directory.