Installing and upgrading#
HCL™ Accelerate consists of services and other tools that are stored in Docker containers. A Docker container is a single unit that contains a software application, often called a service, and the environment needed to run it. Containers can be created and destroyed as needed.
HCL Accelerate consists or over 10 containers. Because of the number of containers, another application, called a container orchestrator, is used to manage the containers. Docker Compose is recommended for proof of concepts such as trials or test environments. For production environments, Kubernetes or another Kubernetes-based orchestrator, such as OpenShift, is only supported platform.
For Docker Compose installations, resources are defined in a file named docker-compose.yml
that is found in the installation folder. For Kubernetes and Openshift installations, the resources are combined into a single file called a Helm chart. You can change a resource by modifying the affected template file or the corresponding resource in the Helm chart.
Docker Compose | Kubernetes | |
---|---|---|
Product core configuration | 15 containers | 43 resources, 1 Helm chart |
External communication | 13 exposed ports | Ingress for communication. NodePort exposed for external communication. |
Storage | 4 volumes | None |
System requirements#
System requirement is an initial setup required before starting the installation. For more information about system requirement, see this page
Docker Compose versus Kubernetes versus OpenShift platform support#
HCL Accelerate installations on Docker Compose are not supported for production environments. The Docker Compose installation includes security and performance issues. The Docker Compose installation cannot control container runtimes and complex calculations, which impacts multiple UI components. For example, the random import of plug-ins impact the performance of product features, like the value stream, releases, and API response time.
Kubernetes installations using Helm provides good security and permissions. Kubernetes supports controlling the container runtime and manages complex calculations.
Considering the security and performance practices, use the Kubernetes and OpenShift platform installations for best results in production environments. For the supported version of Kubernetes and OpenShift platform, see system requirements.
Installing and Upgrading#
Download the installation files for your environment:
- Installing on Docker Compose
- Installing on Kubernetes
- Installing on OpenShift using Helm charts
- Upgrading Docker Compose installation
- Upgrading Kubernetes installation
- Upgrading OpenShift installation
Docker Compose is recommended only for proof of concept such as test or trial environments. Kubernetes or another Kubernetes-based orchestrator, such as OpenShift, is must for production environment.
License edition#
HCL Accelerate is available in three editions.
Community edition | Trial edition | Standard edition | |
---|---|---|---|
Access to product features | All | All | All |
Concurrent user limit | 2 | Unlimited | Unlimited |
Technical support | Community support | Non-production support | Full support |
Cost | Free | Free | $$$ |
Term | Unlimited | 60-day | Monthly or Yearly |
The default HCL Accelerate installation is the community edition. You can upgrade your license edition at any instance of time.
- Installing on Docker Compose
Install HCL Accelerateon Docker Compose container orchestrator. - Installing on Kubernetes
HCL Accelerate is designed as a containerized application and can be installed in a Kubernetes cluster, which is a supported platform for production instances of HCL Accelerate. - Installing an OpenShift application
You can install HCL Accelerate as an OpenShift application in the following ways, - Uninstalling the server
You can uninstall HCL Accelerate by stopping the server and removing the product containers. - HCL Accelerate plugin installations on air-gapped networks
HCL Accelerate plugin installations on air-gapped networks - Upgrading your trial version
Upgrade your installation to the full version. - Upgrading Docker Compose
Upgrade your Docker Compose installation. - Upgrading Kubernetes-based installations
Upgrade your Kubernetes installation. - Upgrading an OpenShift application
You can upgrade HCL Accelerate in OpenShift using the following ways,