Skip to main content

Jama Connect User Guide

Create a Replicated Snapshot (KOTS)

Taking a full snapshot creates a backup of the KOTS Admin Console and application data. It can be used for full Disaster Recovery by restoring over the same instance or in a new cluster. Tenant assets are included in the snapshot. Elasticsearch data is included by default.

A Replicated Snapshot can be taken while Jama Connect is running without interruption.

Requirements

  • Replicated Snapshots must be enabled for your Replicated customer license.

  • KOTS Admin Console 1.79 and later.

  • Replicated Snapshots don't include your database. You must use a proprietary backup/restore system for your type of database, MySQL or SQL Server.

Important considerations

  • When restoring from a snapshot in a new cluster, you must reinstall KOTS.

  • Recommended — Include Elasticsearch data in snapshots to avoid having to reindex your data after performing a restore. However, if your snapshot is not recent, we recommend reindexing your data.

  • Replicated Snapshots don't support IAM authentication against EFS. Saving Replicated Snapshots in EFS requires that you use the default file system policy to allow all nodes in the cluster to mount the EFS.

To create a Replicated snapshot:

  1. Capture the KOTS installer.

  2. (Recommended) Include Elasticsearch data in snapshots: From the KOTS Admin Console under the Elasticsearch Settings section, select Include Elasticsearch in Replicated Snapshots.

  3. Airgap only — Capture the IP address of the private registry, which is the IP address value in the Cluster-IP column:

    kubectl get service/registry -n kurl

  4. Configure the storage destination:

    1. In the KOTS Admin Console, select Snapshots > Settings & Schedule.

    2. From the Destination drop-down menu, select a storage destination for your snapshots.

      • For AWS S3 — The IAM role assigned to the underlaying servers or the user associated with the credentials (access and secret key) must have the Policy template attached.

        Use the following template to create a policy, replacing the <arn-S3> parameter with ARN of the S3 bucket. For example: arn:aws:s3:::jama-snapshots.

        {
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "s3:PutObject",
                "s3:GetObject",
                "s3:AbortMultipartUpload",
                "s3:DeleteObject",
                "s3:ListMultipartUploadParts"
            ],
            "Resource": "<arn-s3>/*"
        },
        {
            "Effect": "Allow",
            "Action": "s3:ListBucket",
            "Resource": "<arn-s3>"
        }
    ]
}

      • For NFS — If using EFS as an NFS server, the Server field = the DNS name of the EFS and the Path field = a directory inside the EFS, writable by the user:group 1001:1001.

    3. Select Update storage settings to save your preferences.

  5. Schedule Full Snapshots:

    1. In the KOTS Admin Console, select Snapshots > Settings & Schedule.

    2. Select Enable automatic scheduled snapshots, then select Update schedule.

  6. Create a Full Snapshot (follow the steps provided by Replicated).

In this section: