Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Access to a working WhiteSource Application and a user with Admin privileges (either Organization or Product Admin).

  • Access to a working self-hosted GitLab instance and a user with Admin privileges.

  • The deployment includes two environments:

    • A build environment where the image is built.

    • A deployment environment where the image is deployed.

...

  1. Download the tar.gz file (agent-4-gitlab-server-<version>.tar.gz) for Linux or zip file Windows (agent-4-gitlab-server-<version>.zip)

  2. Extract the downloaded file to an empty directory.
    The extraction creates the following folders:
    wss-configuration: UI Configuration tool and related configuration file template
    wss-deployment: Deployment template (for example, deploying the integration using Helm charts)
    wss-gls-app: WhiteSource for GitLab application
    wss-remediate: WhiteSource Remediate worker
    wss-scanner: WhiteSource for GitLab scanner
    build.sh/build.bat (Linux/Windows): The build script that will create the relevant Docker images.

  3. Verify that the desired package managers will be installed on the wss-scanner Docker image.
    The package managers installed by default are - Maven (3.5.4), npm, Bower, Yarn, Gradle, Pip, and Pip3.
    If you want to scan a package manager not mentioned above, see Modifying the Scanner Dockerfile.

  4. Build the docker images. A total of three images will be built: wss-gls-app, wss-scanner, and wss-remediate.
    There are two options to build the Docker images:

    1. Using an executable script (recommended):
      Windows -Run build.bat which is located in the main folder where you extracted the agent-4-gitlab-server zip file.
      Linux - Run build.sh which is located in the main folder where you extracted the agent-4-gitlab-server tar.gz file.
      In order to ensure that the build succeeded, run the command docker images and check if the wss-gls-app, wss-gls-scanner, and wss-remediate images were created.

    2. Manually building the images:
      NOTE: If you selected option 4a (Using an executable script), skip this step.
      To run the steps of the build file manually, run the following commands directly:

Code Block
# For example:
docker build -t wss-gls-app:<version> wss-gls-app/docker
docker build -t wss-scanner:<version> wss-scanner/docker 
docker build -t wss-remediate:<version> wss-remediate/docker

NOTE: From version 21.5.1, the Remediate Dockerfile supports both Ubuntu 18.04 and Ubuntu 20.04-compatible images. The base image can be changed using the BASE_IMAGE build argument. e.g.

...