Install Certifai Toolkit
Prerequisites
- Download the Certifai toolkit
- Python 3.6, 3.7, or 3.8
- Conda or another virtual environment manager (Required for Windows users and recommended for all others)
- Windows users must use PowerShell and have access to the folder where the toolkit was unzipped.
ALERT
When installing the toolkit, Mac users should run commands in bash rather than zsh.
Install the Certifai Toolkit
Set your context to the toolkit folder where you unzipped the contents of the Certifai Toolkit .zip during the download process.
cd <path-to-folder-where-toolkit-was-unzipped>Example
cd certifaiCreate a Python 3.6, 3.7, or 3.8 virtual environment.
conda create -n certifai python=<version number>Example
conda create -n certifai python=3.7Activate the newly created environment.
conda activate certifai(To enable the use of Jupyter notebooks) Install the base requirements.
conda install --file requirements.txtInstall the CERTIFAI packages.
On MAC or Linux:
Install the Certifai component packages. (This may take a couple of minutes to run.)
pip install packages/all/*Install the Certifai packages specific to your python version. MAKE SURE TO USE THE SAME VERSION OF PYTHON that you specified when you created the virtual environment. (To check Python version enter
python --version
in your terminal or command prompt.)pip install packages/[your_python_version]/*EXAMPLE:
If you are using python version 3.6, run:
pip install packages/python3.6/*
For Windows Powershell:
Install the CERTIFAI packages compatible with all supported Python versions.
Get-ChildItem .\packages\all\*.zip | ForEach-Object -Process { pip install $_ }Install the Certifai packages specific to your Python version. You should replace the
python3.6
in the example below with the Python version you are using.Get-ChildItem .\packages\python3.6\*.zip | ForEach-Object -Process { pip install $_ }
Verify that the Certifai CLI and client libraries are installed successfully.
certifai -hA usage statement is displayed if the Certifai CLI has been installed successfully.
Special Setup instructions for Certifai Pro and Enterprise
If you want to perform the following actions for their Pro or Enterprise Certifai installations, you must install certifai-commons for your platform.
- Push results directly to your configured cloud storage
- Use the Certifai CLI to get scans or use cases
- Use the Certifai CLI to get or set a baseline for a use case that is in cloud storage
Run this installation after you complete step 5 above.
AWS & RHOS:
pip install packages/all/cortex-certifai-common-<version image.zip>[s3]AZURE:
pip install packages/all/cortex-certifai-common-<version image.zip>[azure]GCP:
pip install packages/all/cortex-certifai-common-<version image.zip>[gcp]Example
pip install packages/all/cortex-certifai-common-1.2.14-59-g6a03e8fb.zip[s3]
Info
You can get the <version-image.zip>
by:
- Running
ls packages/all
and copying the image and tag forcortex-certifai-common
- Opening your toolkit folder in a file explorer window and opening
packages/all
to find thecortex-certifai-common
image and tag - Opening your toolkit folder in a file explorer window and opening
version.txt
file. Use the image and tag id beside "Scanner Build".
Next Steps
- Go to Import the Certifai remote configuration to download and set up the
certifai-kubeconfig.json
which allows you to work with remote scans.