Installing on OpenShift by using the online method

You can use the online method to install HCL DevOps Velocity (Velocity) when you are able to connect to the Internet on your computer. In the online method, the installation files continuously extracts Docker images from the remote repository during installation.

Before you begin

You must have completed the following tasks:

Completed the tasks provided in the Installation prerequisites section. See Installation prerequisites.
Downloaded the online installation file and obtained the access key for Velocity. See Downloading the installation file.
Important: You must store the details of the installation directory and your credentials which is required when you want to upgrade to a later version.

Scanned for any security vulnerabilities in the installation environment, if you have not done so already.
Ran the following command in the folder that contains installation file, If you are using Linux or macOS computers:
sudo chmod +x <installation_file_name>

About this task

You must obtain the token, and then run the downloaded installation file for your platform to generate a Helm chart. You need to provide your credentials and the path where you want to install Velocity, along with an encryption key. You must also provide the hostname and port of the computer which will be used to access the web interface of Velocity.

If you do not use the defaults, you must store the custom values that you provide because the same values are required to be provided when you want to upgrade to a later version of Velocity.

You can use the generated Helm chart to install Velocity in the Kubernetes cluster.

Procedure

Perform the following steps to obtain the token:
1. Log in to OpenShift cluster console.
2. Click the cluster that you want to access.
3. Click OpenShift web console.
  The Overview window is displayed.
4. Click Username, and then click Copy Login Command from the list.
  The Display Token window is displayed.
5. Click Token.
  The Token is displayed.
6. Copy the Token and run it in command prompt. For example, oc login --token=sha256.......
7. Run oc projects in command prompt to get list of all projects.
  
  Note: To change the project, enter the project name with oc projects command. For example, to access helm-again project, use oc projects helm-again.
  
  The oc projects displays all projects with the current project in last row of command result.
Perform the following steps to generate a Helm chart:
1. Open the location where the installation file is downloaded and run the file.
  The following prompt is displayed:
```
Please enter your DevOps Velocity access key
```
2. Type the access key, and then press Enter.
  The license agreement is displayed.
3. Read the agreement and enter Y to accept the license agreement.
  The following prompt is displayed:
```
Enter your encryption key or leave blank to use the default. Key must be at least 8 characters
```
4. Perform any of the following actions to specify the encryption key:
  Note: The encryption key must be at least 8 characters. You must save the encryption key to use when you want to upgrade to a later version.
  - Type an encryption key, if you do not want to use the default key, and then press Enter.
  - To use the default encryption key, press Enter.
  The following prompt is displayed:
```
Choose the platform
```
5. Select Helm from the list, and then press Enter.
  The following prompt is displayed:
```
Enter the location where the DevOps Velocity files will be installed
```
6. Perform any of the following actions to specify the location for the product files:
  - To install the product files in a different location, type the location, and then press Enter.
  - To install the product files in the default location, press Enter.
    Note: The default location will be the location where the installation file is present.
  Note: The files are copied to the specified directory in a subdirectory named product_version_number.
  The following prompt is displayed:
```
Enter the initial password for the admin user
```
7. Type the password, and then press Enter. You must save the password for later use.
  The following prompt is displayed: What version of MongoDB are you using?
8. Select the version of the MongoDB that you want to use as the database for Velocity installation.
  The following prompt is displayed:
```
Please enter the hostname where you will run DevOps Velocity
```
9. Type the hostname or Ingress controller external IP address.
  
  Note: You cannot use localhost as the hostname. If you have not mapped your Ingress controller external IP address to your domain name then to use the Ingress controller external IP address directly you can enter the Ingress controller external IP address in the following format:<ingress_controller_external_IP>.nip.io.
  The following prompt is displayed:
```
Enter the desired port where DevOps Velocity will run
```
10. Perform any of the following actions to specify the port number for Web UI:
  - Type the port number, and then press Enter.
  - To use the default port number, press Enter.
    Note: The default port number is 443.
  A Helm chart customized for your environment is generated and saved in the location specified in step 2.f.
  
  Note: You can edit the values.yaml file to modify the Helm chart.

Perform the following steps to install the Helm chart:

Copy the generated Helm chart to the master Kubernetes node.

Run the following command to complete the installation of Velocity:


    helm install velocity -n <project_name>\
     ./accelerate-<version>-helm.tgz \
     --set runAsUser=PUID \
     --set license=accept \
     --set access.key=<my_access_key> \
     --set url.domain=<my_hostname> \
     --set mongo.url=<username>://<password>@<service_name>:<port>/<database_name>
     --set secret.tls=<tls_secrete_name>\
     --loglevel= <log_level_value>

The following table describes the parameters in the

helm
                                    install

command:

Table 1. Helm parameters
Parameter	Variable	Description	Required
helm chart name	`<version>`	Version of the product. For example, `5.0.3`	Yes
runAsUser	`<PUID>`	PUID obtained using `oc describe project` command.	Yes
access.key	`<access_key>`	Product access key obtained from Fix Central. For example, `uackjcbdciydskbvdwlinm2o223en4n4nlk`	Yes
url.domain	`<domain_name or I.P address>`	Domain name mapped to Ingress Controller external IP address or Ingress Controller external IP address. For example,`104.198.205.71` or `my-velocity.hcl.com`	Yes
access.key	`<access_key>`	Product access key obtained from Fix Central. For example, `uackjcbdciydskbvdwlinm2o223en4n4nlk`	Yes
mongo.url	`<username>`	User ID to authenticate with the MongoDB database. For example, `mymongo`.	Yes
	`<password>`	Password to authenticate with the MongoDB database. For example, `mongopassword`.	Yes
	`<port>`	Port number for the MongoDB database. Use the value shown in the example, which is `27017`.	Yes
	`<service_name>`	MongoDB URL or the MongoDB service name if it is running within the Kubernetes cluster. For example, `velocity-mongo`.	Yes
	`<database_name>`	Name of the database to be used by Velocity. For example, `velocity`.	Yes
secret.tls	`<tls_secrete_name>`	Name of the TLS secret created during the configuration of SSL certificate. For example, `velocity-custom-tls`	Yes
loglevel	`<log_level_value>`	Level of Log4j messages to display in the log file. Possible values are `ALL, DEBUG, INFO, WARN, ERROR, FATAL, OFF`. The default value is ALL.	Optional

You can use the optional Helm parameters to perform advanced functionality and silent installs. To identify optional parameters run the helm show values accelerate-<version>-helm.tgz command.

Wait for few minutes and run oc get pods command to see the status of pods. Installation is completed when the status of all pods are running.

Results

You have successfully installed Velocity on OpenShift by using the online method.

What to do next

You can perform the following tasks after you install Velocity:

Access the web UI and log in to Velocity. For more information, see Logging in to DevOps Velocity
Allocate the resources to four different nodes and set resource limits on the Kubernetes cluster for better performance of Velocity. For more information, see Node allocation and Resource limits.