Configure and deploy a High Availability project

Configure and deploy a
FactoryTalk® Optix™
project to a high availability cluster to support data continuity and automatic failover.
  • In
    FactoryTalk Optix
     High Availability Manager, ensure the high availability cluster displays
    Deployed
    .
  • Obtain the Virtual IP address of the cluster from High Availability Manager.
    TIP: The Virtual IP is managed by keepalived, so it always routes to the currently active node. To verify the LoadBalancer service the Virtual IP forwards to, run:
    kubectl get svc <release>-runtime-lb -n <namespace>
  • Add a
    WebPresentationEngine
     to the project. See Configure a web presentation engine.
  • Configure retentivity storage for any application changes that occur at runtime to ensure that the changes are stored and synchronized across cluster nodes. See Retentivity storage.
  1. Add the
    HighAvailability
     module to your project.
    1. TIP: If the default project template already includes the
      HighAvailability
       folder, skip this step.
      (optional) In
      Project view
      , right-click the project root, and select
      Add
      HighAvailability
      .
    2. In
      Project view
      , right-click
      HighAvailability
      , and select
      Add
      HighAvailability (type)
      .
    TIP: This configures the retentivity module in the project to use the shared cluster database instead of a local SQLite file.
  2. Set the WebPresentationEngine port to match the cluster.
    1. In
      Project view
      , under
      UI
      , select
      WebPresentationEngine
      .
    2. In
      Properties
      , set
      Port
       to the web port configured for the cluster.
    The port value must match the HTTP or HTTPS web port configured for the cluster. The defaults values are
    80
     for HTTP and
    443
     for HTTPS, but always confirm the actual values configured for your cluster, since they can be changed during installation.
  3. Deploy the project to the high availability cluster.
    1. In the target selection dialog, select the new target entry under
      Local
      .
    2. Enter the following fields.
      Name
      A descriptive name for the target, for example,
      HA-Cluster
      .
      IPAddress
      The Virtual IP address of the high availability cluster.
      Username
      admin
    3. In the toolbar, select
      Run
      .
    4. Choose
      Select
      .
    5. In
      Device access
      , enter the cluster password.
    6. Select
      OK
      .
    TIP: The
    Device access
     dialog displays only the first time you connect, or when credentials need to be entered again.
    FactoryTalk Optix
     Studio remembers credentials for subsequent runs during the current session.
  4. Verify the project is running on the cluster.
    1. Open a web browser on any machine that can reach the cluster.
    2. Navigate to the Virtual IP address by using the configured HTTP or HTTPS web address.
    IMPORTANT: Always connect by using the Virtual IP address. This ensures automatic redirection to the active node during and after failover.
The
FactoryTalk Optix
 project runs on the active node of the high availability cluster. If the active node fails, the cluster promotes another node automatically. Clients connect to the Virtual IP address and continue to use the same endpoint.
Web interface
Use the Virtual IP address and the configured web port.
OPC UA server
Use the Virtual IP address and the configured OPC UA server port.
MQTT broker
Use the Virtual IP address and the configured MQTT broker port.
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal