Configure High Availability

Here are the requirements and steps necessary to configure high availability for Output Automation. The instructions included here explain how to set up your Service Clients for redundancy and storage zones. To see full details about Output Automation high availability, see High Availability.

Requirements

  • You must have at least one additional Output Automation Service Client that meets the minimum required specs. See Service Client.

    Running IPv6 on your Windows Service Client may cause conflicts. You may need to disable IPv6 on the Service Client' network adapter to resolve the conflict.

  • A shared storage location from one of the following:
    • Samba.
    • AWS S3 bucket.
  • For LPD Service, you must also meet the following prerequisites:
    • Enable the LPD Service following these steps, if not already done.
    • A load balancer that can distribute print jobs to all available Service Clients configured to use persistent or sticky connections for this LPD traffic, as LPD has acknowledgment messages that need to go to the same service client as the job.
    • To use a health check in addition to checking if port 515 is open for the load balancer, you'll need a CA trusted by the load balancer, in a .pem and .key format for the certificate and private key, respectively.
  • For Epic, enable the API Print Service following these steps if not already done.

Redundancy

You must specify a configured shared storage location. This storage location stores the print job while determining which Service Client will process the job. If one Service Client is unavailable, the job is automatically routed to another available Service Client.

Zones (Beta)

Setting Zones gives you the choice of which Service Clients are redundant to provide high availability. If you have multiple Service Client machines in multiple regions, this feature offers you the option to ensure redundancy is happening in the same region.

Zone requirements

  1. Each Service Client in the same zone must use the same shared storage location.
  2. Each zone must have its own shared storage. Different zones cannot use the same shared storage.

Configure High Availability

Perform the following steps on all Service Clients you want to use for high availability.

  1. In the Admin Console, select the Service Client.
  2. Select the Output Automation tab.
  3. In the Shared Storage section, select the type of storage location.

    1. Samba — select Network Attached Storage Filepath field and complete the following:

      1. Enter the full filepath to the storage location to store print jobs.

        Shared Storage section with the Network Attached Storage Filepath option selected

    2. AWS S3 bucket — select AWS S3 Bucket and complete the following:

      1. Access Key ID — enter the access key ID for the S3 bucket.
      2. Secret Access Key — enter the secret access key for the S3 bucket.
      3. Region — use the drop-down to select the S3 bucket region.
      4. Bucket Name — enter the S3 bucket name.

      Shared Storage section with the AWS S3 Bucket bubble selected, and the Access Key ID, Secret Access Key, Region, and Bucket Name fileds filled in.

  4. In the Zonesection, use the drop-down to select the zone you want to assign to this Service Client.

    Zones (Beta) setting showing zone 1 selected in the drop-down.

Configure a Load Balancer Health Check for Epic

Configure the load balancers health check to use the following curl command replacing <ServiceClientDNSName> with the DNS name of your Service Client and the port number to the port you are using for your services.

Copy Code
curl --request GET \
  --url https://<ServiceClientDNSName>:31990/healthcheck

Configure a Load Balancer Health Check for LPD Service

The following section covers the necessary steps to configure a load balancer health check when you use LPD Service. Of course, you can just confirm that port 515 is open, but enabling some Epic-specific settings provide more detailed information on the load balancer's status.

  1. Scroll back up to the DNS Name section.
  2. In the Domain Name field enter the DNS Name of the Service Client you are using for Output Automation.

    DNS Name section of the Output Automation tab

  3. In the API Print Service section, select Enable API Print Service.

    Enable API Print Service option in the Output Automation tab

  4. Enter the information for your certificate using one of the following options:

    1. Path to Certificate — enter the file path to where your .pem and .key files are stored on the Service Client.

      Path to certificate option in the Output Automation tab

    2. Enter Certificate — paste the contents of the certificate and key files into the corresponding text boxes.

      Enter certificate opition in the Output Automation tab

  5. Select Save.
  6. Configure the load balancers health check to use the following curl command replacing <ServiceClientDNSName> with the DNS name of your Service Client.

    Copy Code
    curl --request GET \
      --url https://<ServiceClientDNSName>:31990/healthcheck