Install Planning Analytics Workspace Local on Windows Server 2019 or 2022
To install Planning Analytics Workspace Local version
2.0.74 or later directly on Windows Server 2019 run the
./Start.ps1
script. You can run the same script to install Planning Analytics Workspace Local 2.0.96 and later versions on Windows Server 2022.
About this task
- VALIDATE_HOST
- Indicates whether to perform host validation and repair.
- VALIDATE_ANTI_VIRUS
- Indicates whether to check for unsupported anti-virus software while validating the host. If anti-virus software is found, the validation process fails.
- FREE_SPACE_REQUIRED_GB
- Indicates how much free space is required (in GB) before you are notified that it might be insufficient.
The start script performs the following checks:
- Checks that you are running the Start.ps1 script as an administrator. If the PowerShell is not running elevated, the script does not run.
- Verifies that the version of Windows Server is supported.
- Checks for unsupported anti-virus software installed. If the script finds any unsupported software, it displays an error and exits. You must uninstall the anti-virus software and run the script again.
- Checks to make sure that the required modules, such as HostNetworkingService PowerShell, and features, such as Hyper-V PowerShell and Containers, are installed and configured correctly on the server. If it can, the script installs the required software or updates the configuration.
- Checks for an existing version of Docker and validates that it is a supported version. Verifies
that the Docker service exists and is configured as Automatic (Delayed
Start).
If a Docker service doesn't exist, download Mirantis Container Runtime (https://www.mirantis.com/blog/getting-started-with-mirantis-container-runtime-on-windows-server/).
- Checks that the Docker service is running, the docker.exe is on the PATH, and Docker is
registered in the EventLog service.
If the state of the service is not "Running", the script starts it. If it fails to start, the script displays an error and exits. If it is not on the PATH, it automatically adds it. If the service is not registered, it is repaired.
- Verifies permission to use the Docker daemon.
- Checks that docker-compose.exe is installed. If docker-compose.exe is not found on the PATH, the script copies it from the Planning Analytics Workspace installation location to C:\Program Files\docker\docker-compose.exe.
- Validates that Windows container settings are correct and updates any that are required.
- Checks that there are free ports available. Ensures that the defined Planning Analytics Workspace ports (80 and 443 by default) are free. If the pa-gateway container is running, these tests are not run.
- Checks that there is sufficient space to install the required software. First, it reads the
currently configured Docker storage directory. Then, it fetches the free space on its drive and
converts it to GB. It outputs the amount of free space on the drive.
If the free space is less than
$env:FREE_SPACE_REQUIRED_GB
, a warning is displayed that indicates you might have insufficient space to load the images. A link is displayed where you can read how to switch the "Docker Root Dir" to another drive. - Installs the Planning Analytics Workspace Docker images.
- Opens the Planning Analytics Workspace administration tool.
Any check that results in an unrepairable error causes the script to exit and the following message to be displayed:
Run Start.ps1 again to revalidate your system after resolving the identified issues.
Follow these steps to install Planning Analytics Workspace Local.
Procedure
What to do next
- If there are any warnings or errors that can't be resolved, view container host validation errors in the log\validation.log file. View Windows event logs in the .log\docker_event_logs.csv file.
- If the administration tool doesn't open, copy and paste the address shown in the command or terminal window into a browser window.
- If you have other issues when you connect to Planning Analytics Workspace, see How do I fix my Planning Analytics Workspace Local installation?