Miscellaneous

This document outlines miscellaneous topics around managing your GuardRails installation steps for operating the non-managed GuardRails on-premise deployment.

• Backups
• Disaster Recovery
• Troubleshooting
• Upgrading KOTS

Backups

This section covers the two different areas that need to be backed up.

1. GuardRails configuration
2. GuardRails database

GuardRails configuration

In order to save the current configuration that's used in the GuardRails admin dashboard, the command kots download can be used.

This will retrieve a copy of the application manifests from the cluster, and store them in a specific directory structure on your local workstation, which can then be backed up according to your company policies.

kubectl kots download --namespace <kubernetes namespace> guardrails-enterprise --decrypt-password-values

The full export will be stored in the ./guardrails-enterprise directory.

More information about the command can be found here.

GuardRails Database

For production deployments it is recommended to run on a dedicated managed PostgreSQL database, which confirms to the organizational standards around backups and snapshots.

The database contains all GuardRails platform specific data, such as installations, vulnerabilities, false positive information, integration configuration.

Disaster Recovery

If a Kubernetes cluster has gone done, or the GuardRails namespace has been deleted, then GuardRails has to be installed again with the correct configuration options.

kubectl kots install guardrails-enterprise \
  --license-file </path/to/license.yml> \
  --shared-password <admin console password> \
  --config-values <./path/to/config.yaml \
  --namespace guardrails-enterprise

More information about the command can be found here.

Troubleshooting

GuardRails allows you to generate a support bundle that can easily be shared with our support team. More details can be found here:

• Generate a support bundle

Upgrading KOTS

Warning: The latest version of KOTS Admin is not compatible with Robin.io, as Robin.io doesn't support dry runs. It is recommended to not upgrade KOTS for Robin.io users at this time. We will keep this document updated.

In order to upgrade the KOTS admin console, 2 steps have to be completed.

Step 1.) Upgrade the KOTS CLI on your local machine to the latest version and verify that the version was upgraded successfully.

• curl https://kots.io/install | bash
• kubectl kots version

Step 2.) Upgrade the KOTS Admin in your cluster.

• kubectl kots admin-console upgrade --with-minio=false --namespace guardrails-enterprise

Verify that the upgrade completed by checking the version in the footer of the KOTS admin console.

Note that it is recommended to install KOTS Admin without Minio, which can be done by setting the --with-minio flag to false.