Contribute in GitHub:

Installing the Adaptive Proxy

Installing the standalone version of the Adaptive Proxy

To install the standalone version of the Adaptive Proxy on a virtual machine, complete the following steps:

Download the IBM Quantum Safe Remediator installation package from IBM Passport Advantage. The adaptive-proxy-standalone-vm_<version>.tar file is included in this package.

Important: The name of the file you downloaded will have a version number in it instead of <version>. Use the actual file name where required in the remaining steps.
Open a terminal and switch to the root user. Enter your password when prompted.
```
sudo su 
```
Create the Adaptive Proxy installation directory:
```
mkdir /opt/adaptive-proxy
```

Extract the downloaded .tar file to the new directory:

tar -xf adaptive-proxy-standalone-vm_<version>.tar -C /opt/adaptive-proxy/

Navigate to the newly-created workdir folder, and run the Adaptive Proxy installation script:
```
cd /opt/adaptive-proxy/workdir
./install.sh
```
Follow the on-screen instructions to view and accept the license agreement. The script will then proceed with the installation:
```
License terms accepted. Continuing with installation
```
After the images are loaded, you will be prompted to choose the domain name, signature algorithms, and curves. Follow the on-screen instructions to make your selections.
Refer to Configuring the standalone version of the Adaptive Proxy for details on how to configure the standalone version of the Adaptive Proxy.

You will receive on-screen confirmation when the standalone Adaptive Proxy has finished installing:

INFO: The Adaptive Proxy successfully installed.

Important: You must not disable the access logs by editing the configuration or configmap files, and changing the access logs' specification strings is forbidden. Modifying the access log configuration will interfere with the functionality of the Adaptive proxy.

Installing the post-ingress version of the Adaptive Proxy

To install the Adaptive Proxy as a post-ingress component in your Kubernetes or OpenShift cluster, complete the following steps:

Download the IBM Quantum Safe Remediator installation package from IBM Passport Advantage. It contains one file for each cluster type. Choose the appropriate file for your cluster type, either OpenShift or k8s (Kubernetes).
```
adaptive-proxy-post-ingress-<cluster_type>_<version>.tar
```
Important: The name of the file will have the version number in it instead of <version>. Use the actual file name where required in the remaining steps.
Log in to the cluster by following the instructions provided in Logging in to your cluster.
Create a directory for the Adaptive Proxy. You can do this in your home directory.
```
mkdir adaptive-proxy
```
Open a terminal and extract the installation archive into the new directory:
```
tar -xf adaptive-proxy-post-ingress-<cluster_type>_<version>.tar -C ./adaptive-proxy/
```
If you have been provided with access to the container images hosted on the IBM Container Registry, skip to step 7.
Upload the required container images to your container registry by following the instructions provided in Hosting the Adaptive Proxy container images.
Update the values.yaml configuration files with your container registry URL by following the instructions provided in Adding your container registry URL to the configuration files.
A directory for the component type you are installing, and cluster type you are installing it on, will have been created when you extracted the .tar file. Navigate to the directory and run the installation script:
```
cd adaptive-proxy/post-ingress-<cluster_type>
./install.sh
```
Follow the on-screen instructions to view and accept the license agreement. The script will then proceed with the installation:
```
License terms accepted. Continuing with installation
```
The script will verify that the prerequisites are met, and will display the details of the cluster you are logged in to. A message will be displayed warning you to ensure that the cluster details are correct. You will then be shown the following prompt:
```
Please confirm the above target cluster details for the installation and press enter (Default: yes):
```
Press Enter to continue, or enter no to stop the installation.

Note: The installation will end immediately if the verification of prerequisites fails.
Refer to Configuring the post-ingress version of the Adaptive Proxy for details on how to configure the post-ingress component, and how to add a new backend application.

At the end of the installation process, you will be provided with the URL of the post-ingress Adaptive Proxy. The URL will be similar to the one in the following example:

INFO: Visit https://adaptive-proxy.ap-post-ingress.qs-remediator-test-f9f6c195465e0b0fcac01274faf6129a-0000.eu-de.containers.appdomain.cloud to access the Adaptive Proxy as post ingress

The resources created by the installer will use a namespace called ap-post-ingress, and if this namespace does not already exist in the cluster, it will be created. If an IBM Cloud Container Registry secret is found in this namespace, that secret will be used; otherwise, a new one will be created.

If an existing version of the post-ingress component is found in the cluster, it will be upgraded. If not, the new one will be installed.

Installing the Adaptive Proxy as ingress controller

To install the Adaptive Proxy as ingress controller in your OpenShift or Kubernetes cluster, complete the following steps:

Download the IBM Quantum Safe Remediator installation package from IBM Passport Advantage. The pqc_ingress_controller_<cluster_type>_<version>.tar file is included in this package.

Important: The file name will have the version number instead of <version>. Use the actual file name where required in the remaining steps.
Log in to the cluster by following the instructions provided in Logging in to your cluster.
Create an installation directory for the Adaptive Proxy and extract the archive into it. This can be done in your home directory.
```
mkdir adaptive-proxy
tar -xf pqc_ingress_controller_<cluster_type>_<version>.tar -C ./adaptive-proxy/
```
Important: Replace <cluster_type> with openshift if you are using an OpenShift cluster, or iks if you are using Kubernetes.
Navigate to the deployments directory:
```
cd adaptive-proxy/deployments
```
Open the init.properties file using your preferred text editor, and update the value of the cluster_name property with the name of your cluster, and the value of the registry property with your container registry URL. When you have done this, save the file and exit the editor. Refer to Configuring the Adaptive Proxy as ingress controller for additional configuration.
Ensure that you have permission to run the installation script by entering the following command:
```
chmod u+x install.sh
```
Run the installation script:
```
./install.sh
```

When the installation has completed, refer to Obtaining the load balancer URL for the Adaptive Proxy as ingress controller for the load balancer URL.