Step 1 - KnowHOW System Requirements
Please check here for System Requirements: PSknowHOW | System Requirements
Step 2 - Release Notes
Please read the release notes before starting the
...
Installation Steps
Update the DOcker Compose file with required variabale details as mentioned @ Environmental variables
...
installation.
Step 3 - Create folder structure
...
Please select the preferred location
...
for creating the PSKnowhow folder and Authentication application, ensuring that the chosen location offers a sufficient amount of available space.
Windows / MacOS:
...
Please Create "
PSKnowhow" directory in your preferred drive location. For instance, on Windows, you may choose to create it at “C:\UserName\
...
PSKnowhow”, whereas on macOS, you can opt for the “/Users/YourUsername/PSKnowhow
...
” directory
...
.
Linux: Use the bellow command to create “PSKnowhow” directory on your preferred location , Replace “location” from below code with your preferred location
| Code Block |
|---|
mkdir /location/PSKnowhow |
...
Step 4 - Download docker-compose.yaml
...
If you have a valid publicis sapient credentials, please follow instructions mentioned here else continue with below steps.
of PSKnowhow
Go to https://github.com/PublicisSapient/PSknowHOW/blob/master/docker-compose.yaml
Right Click on Raw and save link as to Download docker-compose.yaml file to local as shown in below picture
Upload the downloaded docker-compose.yaml to PSKnowhow folder which you created in Step 13.
Step
...
5 - Edit the docker compose file with appropriate values
Update Credentials of DB and other Environmental variable as specified hereApplication Environmental variables
...
To begin with PSKnowhow, it is essential to have three mandatory containers: i) UI, ii) CustomAPI, and iii) MongoDB. Additionally, there are other optional containers, such as jira-processor, devops-processor (including Jenkins, GitHub, GitLab, Bamboo, Bitbucket, Zephyr, Sonar, and TeamCity collectors), azure-board-processor (for Azure Board), and azure-pipeline-repo (for Azure Pipeline and Azure Repo).
Based on specific requirements, you can bring up these respective containers as needed.
Step 6 - Pull the docker images and Run the Containers
Open terminal/command prompt in PSKnowhow folder .
Pull the images by (For Docker for Desktop)
Code Block docker-compose pull
(For Podman)
| Code Block |
|---|
podman-compose pull |
Run the container by (For Docker for Desktop)
Code Block docker-compose up -d
(For Podman)
| Code Block |
|---|
podman-compose up -d |
Create readWrite Privileged user which adds extra layer of data protection from accidentally deleting collections and use this in application . follow this steps to create
Code Block docker exec -it mongodb /bin/bash mongo admin -u ${MONGO_INITDB_ROOT_USERNAME} -p ${MONGO_INITDB_ROOT_PASSWORD} use kpidashboard db.createUser({user: '<MONGODB_APPLICATION_USER>', pwd: '<MONGODB_APPLICATION_PASS>', roles:[{role:'readWrite', db:'kpidashboard'}]}) exit
Check Post installation steps for further configuration.
...