Table below describes parameters requirement depending on whether you are building/compiling the NGINX+ KIC container image or not; while launching/deploying the CloudFormation template.
| CFT Label (Parameter Name) | When Build/Compile NGINX+ KIC | SKIP Build/Compile NGINX+ KIC |
|---|---|---|
| URL of NGINX+ Compilation Script (CompileNGINXPlusScript) | Mandatory | Mandatory |
| NGINX+ Repository Certificate (NGINXRepositoryCertificate) | Mandatory | Not Needed |
| NGINX+ Repository Private Key (NGINXRepositoryPrivateKey) | Mandatory | Not Needed |
| Repository (Docker Hub) User ID (DockerHubUserID) | Mandatory | Not Needed |
| Repository (Docker Hub) Password (DockerHubPassword) | Mandatory | Not Needed |
| NGINX+'s Repository (Docker Hub) Name (DockerHubRepositoryName) | Mandatory, need to be in sync with "Repository (Docker Hub) User ID" (DockerHubUserID) parameter | Mandatory |
| NGINX+ Version (NGINXPlusVersion) | Mandatory | Mandatory |
| URL of NGINX+ KIC Script (NGINXPlusIngressScript) | Mandatory | Mandatory |
On both cases, the scripts are all mandatory, and there are no differences in usage or treatment between both cases.
When you select to SKIP building/compiling the NGINX+ KIC container image, you do NOT need to supply the below parameters:
- NGINX+ Repository Certificate (NGINXRepositoryCertificate)
- NGINX+ Repository Private Key (NGINXRepositoryPrivateKey)
- Repository (Docker Hub) User ID (DockerHubUserID)
- Repository (Docker Hub) Password (DockerHubPassword)
This also means you are using NGINX+ KIC container image which has been built/compiled and stored in some repository somewhere which is publicly accessible. For example as depicted below:
Following the example above, the:
- NGINX+'s Repository (Docker Hub) Name (DockerHubRepositoryName) is the complete Repository Name, which is
gjwdyk/nginx-ingress. - NGINX+ Version (NGINXPlusVersion) is the tag (version) of repository you want to choose. From the example above there is only one tag (version) available, which is
v1.11.3.
This step/procedure also applies when you want to deploy any other service container image where you do not have the source and/or you do not want the hassle to build/compile it, and the service container image is available/publicly accessible on some repository.
When you select to Build/Compile the NGINX+ KIC container image, that means you do:
- Build/Compile the NGINX+ KIC container image, and Push/Upload the built/compiled container image to the Repository (Docker Hub) following the configured Account Credentials, Repository Name and Container Image's Tag (Version).
- Pull/Download the NGINX+ KIC container image from the exact same Repository Name and Container Image's Tag (Version). This step is exactly the same as the above When SKIPPING Building/Compiling NGINX+ KIC Container Image section. This is why the "NGINX+'s Repository (Docker Hub) Name" (DockerHubRepositoryName) parameter needs to be in sync with the "Repository (Docker Hub) User ID" (DockerHubUserID) parameter.
When you choose to build/compile the NGINX+ KIC container image, choose the tag/version from the NGINX+ KIC GitHub Repository . As depicted on the below capture, the "branches/tags" drop-down selection lists the available tags/versions. The "Releases" section on the right side of the page also states the latest tag/version available. Note that the exact same tag/version string will be used to push the built/compiled NGINX+ KIC container image into your Repository (Docker Hub) Account.
You may want to check whether the compilation process/procedure of commands of the tag/version you choose is still supported (same as) between the provided NGINX+ Compilation Script and the official guide for Building the NGINX+ KIC Container Image .
After the build/compile finished, the NGINX+ KIC container image needs to be pushed to the Repository (Docker Hub), and the Push needs account's credentials. Therefore the "Repository (Docker Hub) User ID" (DockerHubUserID) parameter and "Repository (Docker Hub) Password" (DockerHubPassword) parameter are needed. This is the same concept as Social Media account. Uploading content to your account, you need to provide credentials. However anyone else who just want to see/access your content, can do so freely.
The "NGINX+'s Repository (Docker Hub) Name" (DockerHubRepositoryName), use format of UserID/RepositoryName. So note that the required information also contains User ID information, which must be in sync with the Repository's User ID parameter.
Both "NGINX+ Repository Certificate" (NGINXRepositoryCertificate) parameter and "NGINX+ Repository Private Key" (NGINXRepositoryPrivateKey) parameter are basically authentication/authorization method.
They're sensitive information which you should treat them securely.
Therefore they need to be supplied also in a secure manner.
"NGINX+ Repository Certificate" and "NGINX+ Repository Private Key" are usually supplied to you by NGINX, each in their own file: nginx-repo.crt and nginx-repo.key respectively.
You need to reformat a copy of the nginx-repo.crt and nginx-repo.key , each into a one-line information which you can copy and paste into the respective CloudFormation parameter input field.
Refer to KeyPair section for more detail on how to re-format the content of each file into a one-line information.
╔═╦═════════════════╦═╗
╠═╬═════════════════╬═╣
║ ║ End of Document ║ ║
╠═╬═════════════════╬═╣
╚═╩═════════════════╩═╝