Introduction
The Nok Nok Cloud Deployment Toolkit (CDT) package can build images for, install and manage the Nok Nok S3 Suite using Docker Compose. The CDT contains scripts and configuration files that support an evaluation or development deployment of the Nok Nok S3 Suite Version 9.4. The CDT can also be used as a foundation to build upon and customize for a production deployment.
This document takes you through the process of building images and deploying a Nok Nok Application Server, API Server and Authentication Server in a set of Docker containers. This includes detailed steps using MacOS and Linux, either on a local computer or in the cloud.
If you implemented a custom Crypto or Secrets Plugin, please contact Nok Nok Customer Support before continuing.
Who Should Read This Guide
This document is intended for administrators and integrators who are responsible for installing, configuring, administering, or deploying the Nok Nok S3 Suite. The reader must be familiar with Docker, Linux, and system utilities such as bash and sudo.
Terminology
For a list of general technical terms used throughout all documents, see Terminology.
Term | Description |
|---|---|
Browser Client System | The system where the browser is running. |
CDT Deployment Profile | The file at ${HOME}/.nn/cdt/deployment.profile that defines parameters for your deployment. The defaults provided there specify a Postgres operational database, a subdomain prefix of nns3, and a TLS certificate with the *.noknokeval.com wildcard domain name. |
CDT Host System | The system where the CDT package contents are unpacked and installed. This could be a MacOS or Linux system, a cloud compute instance or a virtual machine. |
CDT Working Directory | The CDT working directory, ${HOME}/.nn/cdt, is where the CDT contents that can be changed for your deployment are stored. The bin/unbox.sh script copies these CDT contents from the ${NN_CDT_HOME} directory. Specifically, the CDT working directory is where you place any third party jars, override the default TLS certificate, and change configuration settings. |
Evaluation TLS certificate | The CDT includes a TLS certificate that can be used for evaluation and development purposes. This Guide includes instructions to change the certificate for a production deployment. |
Tutorial Web App Server | Deployed with the Nok Nok CDT, this hosts the Tutorial Web Application that verifies and demonstrates authentication from a Web App. |
Note that the CDT Host System and the Browser Client System are the same for MacOS. But for cloud compute instances running Linux servers, they are different. This is because the cloud compute instances and VMs are typically servers without a desktop or a graphical user interface.