Page created: 1 Nov 2021
|
Page updated: 3 May 2022
To use the Docker toolkit, you need to untar the toolkit. Run the following command to
untar the toolkit:
tar -zxf pi-api-docker-toolkit-5.1.tar.gz
Untarring the Docker toolkit, creates the directory structure as shown in the following
table:
Directory | Description |
bin
|
Contains the build.sh script to build the Docker
images |
config
|
Contains the docker.conf file to configure the
base image name and the base image operating system |
certs/webgui
|
Contains the PingFederate public certificate file,
webgui-sso-oidc-provider.crt . PingIntelligence Dashboard
Docker image can be generated by optionally packaging it with the
PingFederate public certificate. |
certs/ |
Contains the folders
{ase,abs,apipublish,dataengine,webgui,kafka,mongo,elasticsearch} .These
contain certificate and key files for PingIntelligence components. The
keystore will be generated during image creation, with the password
configured in docker.conf .Note: PingIntelligence Dashboard has the components:
|
data
|
For internal use |
docker-toolkit |
For internal use |
external
|
Contains the third-party software:
|
helm-chart |
For internal use |
images
|
Contains the created Docker images using the
build.sh script |
keystore |
For internal use |
lib
|
For internal use |
license
|
Contains the PingIntelligence license
file. Note: You can build the images without adding the license file to the
license directory. If you build the Docker images
without the license file in license directory, then
you need to map or mount the license file in the /config/
directory.
|
logs
|
Contains the log files |
software
|
Contains PingIntelligence ASE, ABS, and Dashboard |
Configure docker.conf
Navigate to the
config
directory and edit the
docker.conf
file for base image name and base image operating
system. Following is a sample docker.conf
field: # Base image name using which all the PingIntelligence images are created
base_image=registry.access.redhat.com/rhel7:7.9
# Operating system of the base image. The valid values are ubuntu or rhel
base_image_os=rhel
# Define the username for images. This user is added to the Docker
# images. Containers created from these Docker images use the configured # user to run PingIntelligence software
user_name=pinguser
# Define the username for images. This user is added to the Docker
# images. Containers created from these Docker images use the configured # user to run PingIntelligence software
group_name=pinggroup
#Define keystore password for different component
#These will be used to create keystore while building images through crt and key while.ASE keystore password can be changed from helm values.
abs_keystore_password=changeme
apipublish_keystore_password=changeme
dashboard_keystore_password=changeme
kafka_keystore_password=changeme
Note:
- The setup requires the Community Version (CE) of Docker 18.09 or higher.
- Do not set the
user_name
asroot
indocker.conf
file.