Installing and Configuring ClearCase® GitViews server

This topic describes how to install and configure the ClearCase GitView server, manage administrative users, register UCM projects, and optionally enable Change Management Integration (CMI).

Before you begin

Before installing ClearCase GitViews, ensure that the following requirements are met:

Python version 3.11 or later is installed with SSL support.
Internet connectivity is available to download the required Python packages.

Note: The GitView backend server is supported on Linux only, while clients can access GitViews from any supported platform.

About this task

The GitView server installation files are available under the following directory and must be installed by running a script on the server of interest. The GitView code is available with the ClearCase installation on machines installed with the ClearCase Full Function Installation available when using Installation Manager.

/opt/devops/code/etc/extensions

The installation package consists of:

A setup script (setup_gitview.py)
A ZIP archive containing the GitView backend (gitview-backend.zip)

The GitView server must be installed by running the setup script on the target server.

Procedure

Log in to the target server as the root user.
Run the setup script using the system Python installation.

-i <installDirectory>

Specifies the parent directory in which the GitView server is installed.

-z <zipfile>

Specifies the GitView backend ZIP file (gitview-backend.zip).

--port <port>

Specifies the Django application port (default: 8000).

--nginxPort <port>

Specifies the Nginx HTTP port (default: 8086).

--nginxSecuredPort <port>

Specifies the Nginx HTTPS port (default: 443).

--nginxDefaultPort <port>

Specifies the Nginx default port (default: 8001).

--nginxServerNames <serverAlias1,serverAlias2,...>

Specifies a comma-separated list of server hostnames (for example, local hostname and fully qualified domain name).

--adminPassword <password>

Specifies the password for the default Django administrator user (default: password).
For example, run the following command for a basic installation:
```
# /usr/bin/python3 setup_gitview.py -i /opt/gitview -z gitview-backend.zip -–nginxServerNames gantu,gantu.prod.hclccq.com
```
During installation, the script performs the following actions:
- Creates a Python virtual environment.
- Extracts the GitView UI.
- Configures Nginx to serve the UI.
Configure GitView administrative users.
It is strongly recommended to add an additional user to the Django administrative group in order to maintain the server and create repositories using the repo_manage.py script.
Activate the GitView virtual environment:
```
# cd /opt/gitview/gitview
# . ../venv/bin/activate 
```
Use the admin_manage.py script to manage admin users:
–add <user>

Add the specified user into the Django admin group.

–delete <user>

Removes the specified user from the Django admin group.

–list

Lists all users in the specified admin group.
Example:
```
# python admin_manage.py –add mark
```
Note:
Both admin_manage.py and repo_manage.py prompt for a username and password. The credentials used must belong to users who are members of the administrative group, as defined using the admin_manage.py script.
Register UCM projects for GitViews:
A script, repo_manage.py is installed to support adding projects, with a number of options:

–create <JSON>

Add the ability to use a UCM project with GitViews.

–delete <JSON>

Remove the ability to use a UCM project with GitViews.

–list

List the available UCM projects for use with GitViews.

Note: The JSON input must include the vob_tag key with the specified UCM PVOB and a project key with the desired project.
Example:
```
# cd /opt/gitview/gitview
# . ../venv/bin/activate
# python repo_manage.py -create “{‘vob_tag’: ‘/var/tmp/mypvob’,‘project’: ‘MyProject’}”
```
Note: This operation does not create a project in the PVOB. It registers an existing project so that it can be used with GitViews. Registered projects appear in the GitView UI for selection.
CMI Integration (Optional)
If Change Management Integration (CMI) is used, an attribute type must be created in the PVOB to support task associations.
Example:
```
# cleartool mkattype -c “attribute type for supporting CMI in GitViews” -vtype string GITVIEW_PUSH_TASKS@/var/tmp/mypvob
```

Results

After completing this task:

The ClearCase GitView server is installed and operational.
Administrative users can manage GitView repositories.
Selected ClearCase UCM projects are available for use with GitViews.
Optional CMI task enforcement is enabled, if configured.