Prepare Your Installation

R2026b

Polyspace® Access™ provides a web browser user interface to review Polyspace analysis results that are hosted on a centralized database.

Polyspace Access uses the docker compose tool to install all the apps and services required to run Polyspace Access. Your container environments are set using a .env file and the majority of Polyspace Access settings are customized in this file.

When you install Polyspace Access, you install the following apps:

  • User Manager: Authenticates user logins against your company Lightweight Directory Access Protocol (LDAP) or against a custom internal database of users. The app issues signed JSON Web Tokens to authenticated users and provides a user interface to manage the custom database of users.

  • Issue Tracker: Manages the communication between Polyspace Access and your bug tracking tool (BTT) software and provides a user interface to create BTT tickets.

  • Polyspace Access: Manages results uploads to the Polyspace Access database and results exports from that database, and provides a user web interface to review results. This app includes the Polyspace Access ETL (Extract-Transform-Load) which transforms uploaded results for database storage.

Each app contains services that are deployed inside docker containers. A separate Gateway service handles communications between Polyspace Access and client machines.

Polyspace Access network diagram for single node configuration.

Before you begin your installation, decide whether to use the HTTPS protocol and how to configure user authentication and the optional bug tracking tool integration.

General Prerequisites

  • Install the required software and make sure that your system meets the minimum hardware requirements. See System Requirements for Polyspace Access.

  • Verify that you have enough data storage available and that the ports that you use are available and not blocked by your firewall. See Storage and Port Configuration.

  • Check that the license manager is installed and running, and that the license manager options file includes the users to whom you grant right-to-use privileges for Polyspace Access. See Network Named User (NNU) Licensing.

  • To avoid any potential issues with license file operation, consider upgrading the network license manager software whenever you upgrade Polyspace Access. See Update Network License Manager Software.

  • If you enable HTTPS to encrypt communications between Polyspace Access and client machines, obtain an SSL private key and a signed certificate from a certificate authority or use self-signed certificates. See Choose Between HTTP and HTTPS Configuration for Polyspace Access

  • If you use admin-docker-agent to install Polyspace Access and configure Polyspace Access to use the HTTPS protocol, generate a Java® Key Store (JKS) file to enable communications between Polyspace Access and the classic Polyspace user interface. See Generate a Client Keystore. You do not need a Java Key Store (JKS) file to enable communications between Polyspace Access and the Polyspace Platform (Polyspace Bug Finder) user interface.

  • Confirm you are using a minimum Docker API version of 1.44. To force Docker® to use the correct API version, set the environment variable DOCKER_API_VERSION to 1.44 or later. For more information, see the Docker Engine API documentation.

  • Check that the docker network does not conflict with an existing network. For more information on docker networks, see Networking overview.

    To check whether your docker network conflicts with an existing network, run this command:

    docker network inspect networkName
    and check that other services do not use the IP range listed in the IPAM.Config node. You might need to contact your network administrator to determine whether other services use the IP range.

    To find networkName, use the command docker network ls. If the command returns more than one network, inspect all the bridge networks (see the DRIVER column in the output).

    Create a network and specify the subnet and gateway to avoid conflicts with existing networks. See docker network create. To use the new network, specify the network name in the networks section of the docker-compose.yaml file.

  • To deploy Polyspace Access on a Kubernetes® cluster instead of using Docker Compose, see Kubernetes Based Installation.

  • To use an external relational database service (RDS) such as Amazon RDS to host the Polyspace Access databases, configure the external database connection settings in the .env file instead of using the bundled local PostgreSQL containers.

User Manager Prerequisites

  • The User Manager configuration requires the generation of an SSL private key file. See Configure User Manager. This private key must be different from the private key that you use for the HTTPS configurations.

  • If you use your company LDAP to authenticate user logins, contact your LDAP administrator to:

    • Obtain the LDAP URL and LDAP base that your organization uses.

    • Obtain LDAP login credentials if access to the LDAP server is password-protected.

    • Determine an LDAP search filter that enables you to retrieve specific subsets of users from the LDAP database. See LDAP filters.

  • If you use LDAP configured over SSL (LDAPS), you must add the LDAP SSL certificate to the certificate trust store file that you use for Polyspace Access. See Configure the User Manager for LDAP over SSL.

Issue Tracker Prerequisites

  • The Issue Tracker configuration requires the URL that you use to connect to your BTT interface.

  • If you use the Jira software with the OAuth authentication method, you must first create an application link in Jira. See the first step on this page.

  • If you use the Redmine BTT, contact your Redmine administrator to obtain the Redmine API key.

  • If you use a BTT configured by using HTTPS, you must add the BTT SSL certificate to the certificate trust store file that you use for Polyspace Access. See Add BTT Instance Configured Using HTTPS.

Polyspace Access Support on WSL

Polyspace Access does not support installation on the Windows Subsystem for Linux (WSL).

WSL is a Windows® feature that enables you to execute Linux® command-line tools on a Linux file system from Windows while using fewer resources than a regular virtual machine (VM). While you can use WSL for development, this feature lacks some of the functionalities of a regular Linux operating system. See Can I use WSL for production scenarios?.

WSL2 offers improved performance but relies on virtualized networking components and does not perform well across OS file systems. These issues affect the performance of Polyspace Access. See Comparing WSL Versions.