Deploy an Embedded Cluster to Airgap VM

Paramify can be deployed in an embedded cluster or "virtual appliance" mode on an airgapped VM, as an alternative to deploying into an existing Kubernetes cluster.

The following instructions are an example of how to deploy into an airgapped VM with no external data services.

Prerequisites​

• An airgapped Linux VM (with at least 2 cores, 6GB of RAM, and 40GB of storage; more recommended)
• Console or SSH access to the VM
• Network access to ports on the VM (via tunnel, VPN, etc.)
• A Paramify license and access to copy a file to the VM
• (Recommended) An available subdomain to access the application (e.g., paramify.company.com)
• (Recommended) Credentials for an SMTP server to send email
• (Recommended) Access to configure SAML for internal SSO

1. Prepare Installer​

Follow these steps to prepare the installer:

1. Download the Paramify installer (replacing <paramify_license_id> with your License ID):

   curl -f "https://update.paramify.com/embedded/paramify/stable?airgap=true" -H "Authorization: <paramify_license_id>" -o paramify.tgz

2. Prepare a storage location on the VM for Paramify data files:

   mkdir -p /var/lib/paramify/{backup,db,images,packages}
   chown -R 65532:65532 /var/lib/paramify

3. Copy the Paramify installer to the VM and install the Admin Console (remember the password you set):

   tar -xvzf paramify.tgz
   sudo ./paramify install --license license.yaml --airgap-bundle paramify.airgap

   INFO

   This step usually takes about 5 minutes. If there are preflight warnings then correct, if needed, and proceed.

   • Note that you can access a shell with kubectl for troubleshooting on the VM with the following:

   sudo ./paramify shell

   TIP

   You can change the password from within the Admin Console by clicking the circle with three dots in the top right and choosing "Change password".

2. Deploy Paramify​

At this point the configuration and deployment will be similar to other Paramify deployment methods.

1. Open a tunnel to the host or have internal network access to ports on the VM
2. Open the Admin Console URL accessible at port 30000 (e.g., https://localhost:30000)
3. Login using the admin password previously set during installation
4. Enter your Paramify configuration information then continue
   • The "Application Base URL" should match the the VM IP or a DNS subdomain pointed at the VM or internal load balancer (e.g., https://paramify.company.com)
   • For "Database" select "Embedded Postgres"
     • Enable the "Embedded Postgres Backup" option to create daily backups of the db to storage
   • For "Cloud Storage Settings" select "Local Storage"
     • Match the filesystem directory you created in step 1.2 above
5. Click Next, and wait for Preflight checks to complete
6. Deploy the application and wait for the "Ready" status

Now you should be ready to access Paramify at the VM IP on port 30001 or the configured internal load balancer (e.g., https://paramify.company.com) and login using one of your configured methods. Enjoy!