This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Configuring ESA

Update the configuration according to your preferences. These settings are required for the optimal performance for the setup.

1 - Rotating Insight certificates

Complete the steps provided here to rotate the Insight certificates on the nodes in the Audit Store cluster. Complete the steps for one of the two scenarios. For a single-node where nodes have still to be added to the cluster or a multi-node cluster where nodes are already added to the cluster.

These steps are only applicable for the system-generated Protegrity certificate and keys. For rotating custom certificates, refer here. If the ESA keys are rotated, then the Audit Store certificates must be rotated.

  1. Log in to the ESA Web UI.

  2. Navigate to System > Services > Misc.

  3. Stop the td-agent service. Skip this step if Analytics is not initialized.

  4. On the ESA Web UI, navigate to System > Services > Misc.

  5. Stop the Analytics service.

  6. Navigate to System > Services > Audit Store.

  7. Stop the Audit Store Management service.

  8. Navigate to System > Services > Audit Store.

  9. Stop the Audit Store Repository service.

  10. Run the Rotate Audit Store Certificates tool on the system.

    1. In the ESA Web UI, click the Terminal Icon in lower-right corner to navigate to the ESA CLI Manager.

    2. From the ESA CLI Manager, navigate to Tools > Rotate Audit Store Certificates.

    3. Enter the root password and select OK.

    4. Enter the admin username and password and select OK.

    5. Enter the IP of the local system in the Target Audit Store Address field and select OK to rotate the certificates.

    6. After the rotation is complete select OK.

      The CLI screen appears.

  11. From the ESA Web UI, navigate to System > Services > Audit Store.

  12. Start the Audit Store Repository service.

  13. Navigate to System > Services > Audit Store.

  14. Start the Audit Store Management service.

  15. Navigate to Audit Store > Cluster Management and confirm that the cluster is functional and the cluster status is green or yellow. The cluster with green status is shown in the following figure.

  16. Navigate to System > Services > Misc.

  17. Start the Analytics service.

  18. Navigate to System > Services > Misc.

  19. Start the td-agent service. Skip this step if Analytics is not initialized.

    The following figure shows all services started.

On a multi-node Audit Store cluster, the certificate rotation must be performed on every node in the cluster. First, rotate the certificates on a Lead node, which is the Primary ESA, and then use the IP address of this Lead node while rotating the certificates on the remaining nodes in the cluster. The services mentioned in this section must be stopped on all the nodes, preferably at the same time with minimum delay during certificate rotation. After certificate rotation, the services that were stopped must be started again on the nodes in the reverse order.

  1. Log in to the ESA Web UI.

  2. Stop the required services.

    1. Navigate to System > Services > Misc.

    2. Stop the td-agent service. This step must be performed on all the other nodes followed by the Lead node. Skip this step if Analytics is not initialized.

    3. On the ESA Web UI, navigate to System > Services > Misc.

    4. Stop the Analytics service. This step must be performed on all the other nodes followed by the Lead node.

    5. Navigate to System > Services > Audit Store.

    6. Stop the Audit Store Management service. This step must be performed on all the other nodes followed by the Lead node.

    7. Navigate to System > Services > Audit Store.

    8. Stop the Audit Store Repository service.

      Attention: This is a very important step and must be performed on all the other nodes followed by the Lead node without any delay. A delay in stopping the service on the nodes will result in that node receiving logs. This will lead to inconsistency in the logs across nodes and logs might be lost.

  3. Run the Rotate Audit Store Certificates tool on the Lead node.

    1. In the ESA Web UI, click the Terminal Icon in lower-right corner to navigate to the ESA CLI Manager.

    2. From the ESA CLI Manager of the Lead node, that is the primary ESA, navigate to Tools > Rotate Audit Store Certificates.

    3. Enter the root password and select OK.

    4. Enter the admin username and password and select OK.

    5. Enter the Ip of the local machine in the Target Audit Store Address field and select OK.

    6. After the rotation is completed without errors, the following screen appears. Select OK to go to the CLI menu screen.

      The CLI screen appears.

  4. Run the Rotate Audit Store Certificates tool on all the remaining nodes in the Audit Store cluster one node at a time.

    1. In the ESA Web UI, click the Terminal Icon in lower-right corner to navigate to the ESA CLI Manager.

    2. From the ESA CLI Manager of a node in the cluster, navigate to Tools > Rotate Audit Store Certificates.

    3. Enter the root password and select OK.

    4. Enter the admin username and password and select OK.

    5. Enter the IP address of the Lead node in Target Audit Store Address and select OK.

    6. Enter the admin username and password for the Lead node and select OK.

    7. After the rotation is completed without errors, the following screen appears. Select OK to go to the CLI menu screen.

      The CLI screen appears.

  5. Start the required services.

    1. From the ESA Web UI, navigate to System > Services > Audit Store.

    2. Start the Audit Store Repository service.

      Attention: This step must be performed on the Lead node followed by all the other nodes without any delay. A delay in starting the services on the nodes will result in that node receiving logs. This will lead to inconsistency in the logs across nodes and logs might be lost.

    3. Navigate to System > Services > Audit Store.

    4. Start the Audit Store Management service. This step must be performed on the Lead node followed by all the other nodes.

    5. Navigate to Audit Store > Cluster Management and confirm that the Audit Store cluster is functional and the Audit Store cluster status is green or yellow as shown in the following figure.

    6. Navigate to System > Services > Misc.

    7. Start the Analytics service. This step must be performed on the Lead node followed by all the other nodes.

    8. Navigate to System > Services > Misc.

    9. Start the td-agent service. This step must be performed on the Lead node followed by all the other nodes. Skip this step if Analytics is not initialized.

      The following figure shows all services that are started.

  6. Verify that the Audit Store cluster is stable.

    1. On the ESA Web UI, navigate to Audit Store > Cluster Management.

    2. Verify that the nodes are still a part of the Audit Store cluster.

2 - Updating configurations after changing the domain name

Complete these steps after updating the domain name for the system. This is important when the td-agent is used for sending logs to Insight and the external SIEM over TLS. These steps update the bind key in the INPUT_forward_external.conf file with the updated domain name.

Before you begin:

Ensure that the following prerequisites are complete:

  • The ESA is configured to forward logs to Insight and the external SIEM.

    For more information about forwarding logs to a SIEM, refer here.

  • The external syslog server is available and running.

  • If certificates are used, ensure that the certificates are updated with the required information.

    For more information about updating the certificates, refer here.

Ensure that the hostname does not contain the dot(.) special character.

Perform the following steps to update the configuration:

  1. Open the CLI Manager on the Primary ESA.

    1. Log in to the CLI Manager of the Primary ESA.

    2. Navigate to Administration > OS Console.

    3. Enter the root password and select OK.

  2. Run the following command to update the configuration files.

    /opt/protegrity/td-agent/scripts/update_bindaddress_td_agent_INPUT_forward_external.sh $(hostname)
    

    The bind address in INPUT_forward_external.conf is updated with the hostname.domainname.

  3. Restart the td-agent service.

    1. Log in to the ESA Web UI.

    2. Navigate to System > Services > Misc > td-agent,

    3. Restart the td-agent service.

  4. Complete the steps on the remaining ESAs where the domain name must be updated.

  5. If td-agent is used to receive logs on the ESA or are using an external SIEM, then update the upstream.cfg file on the protector using the following steps.

    1. Log in and open a CLI on the protector machine.

    2. Navigate to the config.d directory using the following command.

      cd /opt/protegrity/logforwarder/data/config.d
      

      Protectors v9.2.0.0 and later use the /opt/protegrity/logforwarder/data/config.d path. Use the /opt/protegrity/fluent-bit/data/config.d path for protectors v9.1.0.0 and earlier.

    3. Back up the existing upstream.cfg file using the following command.

      cp upstream.cfg upstream.cfg_updating_host_backup
      

      Protectors v9.2.0.0 and later use the upstream.cfg file. Use the upstream_es.cfg file for protectors v9.1.0.0 and earlier.

    4. Open the upstream.cfg file using a text editor.

    5. Update the Host value with the updated IP address of the ESA.

      The extract of the code is shown here:

      
      [UPSTREAM]
          Name       pty-insight-balancing
      
      [NODE]
          Name       node-1
          Host       <IP address of the ESA>
          Port       24284
          tls        on
          tls.verify off    
      

      The code shows information updated for one node. If multiple nodes are present, then ensure that the information is updated for all the nodes.

      Do not leave any trailing spaces or line breaks at the end of the file.

      Protectors v9.2.0.0 and later use the Name parameter as pty-insight-balancing. Use the Name parameter as pty-es-balancing for protectors v9.1.0.0 and earlier.

    6. Save and close the file.

    7. Restart logforwarder on the Protector using the following commands.

      /opt/protegrity/logforwarder/bin/logforwarderctrl stop
      /opt/protegrity/logforwarder/bin/logforwarderctrl start
      

      Protectors v9.2.0.0 and later use the /opt/protegrity/logforwarder/bin path. Use the /opt/protegrity/fluent-bit/bin path for protectors v9.1.0.0 and earlier.

    8. Complete the configurations on the remaining protector machines.

3 - Updating the IP address of the ESA

Update the configurations on the ESA after updating the IP Address of the ESA machine.

Perform the steps on one system at a time if multiple ESAs must be updated.

Updating the IP address on the Primary ESA

Update the ESA configuration of the Primary ESA. This is the designated ESA that is used to log in for performing all configurations. It is also the ESA that is used to create and deploy policies.

Perform the following steps to refresh the configurations:

  1. Recreate the Docker containers using the following steps.

    1. Open the OS Console on the Primary ESA.

      1. Log in to the CLI Manager on the Primary ESA.
      2. Navigate to Administration > OS Console.
      3. Enter the root password.
    2. Stop the containers using the following commands.

      /etc/init.d/asrepository stop
      /etc/init.d/asdashboards stop
      
    3. Remove the containers using the following commands.

      /etc/init.d/asrepository remove
      /etc/init.d/asdashboards remove
      
    4. Update the IP address in the config.yml configuration file.

      1. In the OS Console, navigate to the /opt/protegrity/auditstore/config/security directory.

        cd /opt/protegrity/auditstore/config/security
        
      2. Open the config.yml file using a text editor.

      3. Locate the internalProxies: attribute and update the IP address value for the ESA.

      4. Save and close the file.

    5. Start the containers using the following commands.

      /etc/init.d/asrepository start
      /etc/init.d/asdashboards start
      
  2. Update the IP address in the asd_api_config.json configuration file.

    1. In the OS Console, navigate to the /opt/protegrity/insight/analytics/config directory.

      cd /opt/protegrity/insight/analytics/config
      
    2. Open the asd_api_config.json file using a text editor.

    3. Locate the x_forwarded_for attribute and update the IP address value for the ESA.

    4. Save and close the file.

  3. Rotate the Audit Store certificates on the Primary ESA.

    For the steps to rotate Audit Store certificates, refer here.

Use the IP address of the local node, which is the Primary ESA and the Lead node, while rotating the certificates.

  1. Apply security configurations. This step should be performed only once from any node, after all updates have been applied to all nodes in the cluster.

    1. Open the ESA CLI.

    2. Navigate to Tools.

    3. Run Apply Audit Store Security Configs.

  2. Monitor the cluster status.

    1. Log in to the Web UI of the Primary ESA.

    2. Navigate to Audit Store > Cluster Management.

    3. Wait till the following updates are visible on the Overview page.

      • The IP address of the Primary ESA is updated.
      • All the nodes are visible in the cluster.
      • The health of the cluster is green.

      Alternatively, monitor the log files for any errors by logging into the ESA Web UI, navigating to Logs > Appliance, and selecting the following files from the Enterprise-Security-Administrator - Event Logs list:

      • insight_analytics
      • asmanagement
      • asrepository

Updating the IP Address on the Secondary ESA

Ensure that the IP address of the ESA has been updated. Perform the steps on one system at a time if multiple ESAs must be updated.

Perform the following steps to refresh the configurations:

  1. Recreate the Docker containers using the following steps.

    1. Open the OS Console on the Secondary ESA.

      1. Log in to the CLI Manager on the Secondary ESA.
      2. Navigate to Administration > OS Console.
      3. Enter the root password.
    2. Stop the containers using the following commands.

      /etc/init.d/asrepository stop
      /etc/init.d/asdashboards stop
      
    3. Remove the containers using the following commands.

      /etc/init.d/asrepository remove
      /etc/init.d/asdashboards remove
      
    4. Update the IP address in the config.yml configuration file.

      1. In the OS Console, navigate to the /opt/protegrity/auditstore/config/security directory.

        cd /opt/protegrity/auditstore/config/security
        
      2. Open the config.yml file using a text editor.

      3. Locate the internalProxies: attribute and update the IP address value for the ESA.

      4. Save and close the file.

    5. Start the containers using the following commands.

      /etc/init.d/asrepository start
      /etc/init.d/asdashboards start
      
  2. Update the IP address in the asd_api_config.json configuration file.

    1. In the OS Console, navigate to the /opt/protegrity/insight/analytics/config directory.

      cd /opt/protegrity/insight/analytics/config
      
    2. Open the asd_api_config.json file using a text editor.

    3. Locate the x_forwarded_for attribute and update the IP address value for the ESA.

    4. Save and close the file.

  3. Rotate the Audit Store certificates on the Secondary ESA. Perform the steps on the Secondary ESA. However, use the IP address of the Primary ESA, which is the Lead node, for rotating the certificates.

    For the steps to rotate Audit Store certificates, refer here.

  4. Apply security configurations. This step should be performed only once from any node, after all updates have been applied to all nodes in the cluster.

    1. Open the ESA CLI.

    2. Navigate to Tools.

    3. Run Apply Audit Store Security Configs.

  5. Monitor the cluster status.

    1. Log in to the Web UI of the Primary ESA.

    2. Navigate to Audit Store > Cluster Management.

    3. Wait till the following updates are visible on the Overview page.

      • The IP address of the Secondary ESA is updated.
      • All the nodes are visible in the cluster.
      • The health of the cluster is green.

      Alternatively, monitor the log files for any errors by logging into the ESA Web UI, navigating to Logs > Appliance, and selecting the following files from the Enterprise-Security-Administrator - Event Logs list:

      • insight_analytics
      • asmanagement
      • asrepository

4 - Updating the host name or domain name of the ESA

Update the ESA configuration after updating the host name or domain name of the ESA machine.

Updating the host name or domain name on the Primary ESA

Update the configurations of the Primary ESA. This is the designated ESA that is used to log in for performing all configurations. It is also the ESA that is used to create and deploy policies.

Ensure that the host name or domain name of the ESA has been updated.
Ensure that the hostname does not contain the dot(.) special character.

Perform the steps on one system at a time if multiple ESAs must be updated.

Perform the following steps to refresh the configurations:

  1. Update the host name or domain name in the configuration files.

    1. Open the OS Console on the Primary ESA.

      1. Log in to the CLI Manager on the Primary ESA.
      2. Navigate to Administration > OS Console.
      3. Enter the root password.
    2. Update the repository.json file for the Audit Store configuration.

      1. Navigate to the /opt/protegrity/auditstore/management/config directory.

        cd /opt/protegrity/auditstore/management/config
        
      2. Open the repository.json file using a text editor.

      3. Locate and update the hosts attribute with the new host name and domain name as shown in the following example.

        "hosts": [
            "protegrity-esa123.protegrity.com"
          ]
        
      4. Save and close the file.

    3. Update the repository.json file for the Analytics configuration.

      1. Navigate to the /opt/protegrity/insight/analytics/config directory.

        cd /opt/protegrity/insight/analytics/config
        
      2. Open the repository.json file using a text editor.

      3. Locate and update the hosts attribute with the new host name and domain name as shown in the following example.

        "hosts": [
            "protegrity-esa123.protegrity.com"
          ]
        
      4. Save and close the file.

    4. Update the opensearch.yml file for the Audit Store configuration.

      1. Navigate to the /opt/protegrity/auditstore/config directory.

        cd /opt/protegrity/auditstore/config
        
      2. Open the opensearch.yml file using a text editor.

      3. Locate and update the node.name, network.host, and the http.host attributes with the new host name and domain name as shown in the following example. Update the node.name only with the host name. If required, uncomment the line by deleting the number sign (#) character at the start of the line.

        ...
        <existing code>
        ...
        node.name: protegrity-esa123
        ...
        <existing code>
        ...
        network.host:
        - protegrity-esa123.protegrity.com
        ...
        <existing code>
        ...
        http.host:
        - protegrity-esa123.protegrity.com
        
      4. Save and close the file.

    5. Update the opensearch_dashboards.yml file for the Audit Store Dashboards configuration.

      1. Navigate to the /opt/protegrity/auditstore_dashboards/config directory.

        cd /opt/protegrity/auditstore_dashboards/config
        
      2. Open the opensearch_dashboards.yml file using a text editor.

      3. Locate and update the opensearch.hosts attribute with the new host name and domain name as shown in the following example.

        opensearch.hosts: [ "https://protegrity-esa123.protegrity.com:9200" ]
        
      4. Save and close the file.

    6. Update the OUTPUT.conf file for the td-agent configuration.

      1. Navigate to the /opt/protegrity/td-agent/config.d directory.

        cd /opt/protegrity/td-agent/config.d
        
      2. Open the OUTPUT.conf file using a text editor.

      3. Locate and update the hosts attribute with the new host name and domain name as shown in the following example.

        hosts protegrity-esa123.protegrity.com
        
      4. Save and close the file.

    7. Update the INPUT_forward_external.conf file for the external SIEM configuration. This step is required only if an external SIEM is used.

      1. Navigate to the /opt/protegrity/td-agent/config.d directory.

        cd /opt/protegrity/td-agent/config.d
        
      2. Open the INPUT_forward_external.conf file using a text editor.

      3. Locate and update the bind attribute with the new host name and domain name as shown in the following example.

        bind protegrity-esa123.protegrity.com
        
      4. Save and close the file.

  2. Recreate the Docker containers using the following steps.

    1. Open the OS Console on the Primary ESA, if it is not opened.

      1. Log in to the CLI Manager on the Primary ESA.
      2. Navigate to Administration > OS Console.
      3. Enter the root password.
    2. Stop the containers using the following commands.

      /etc/init.d/asrepository stop
      /etc/init.d/asdashboards stop
      
    3. Remove the containers using the following commands.

      /etc/init.d/asrepository remove
      /etc/init.d/asdashboards remove
      
    4. Start the containers using the following commands.

      /etc/init.d/asrepository start
      /etc/init.d/asdashboards start
      
  3. Rotate the Audit Store certificates on the Primary ESA. Use the IP address of the local node, which is the Primary ESA and the Lead node, while rotating the certificates.

    For the steps to rotate Audit Store certificates, refer here.

  4. Update the unicast_hosts.txt file for the Audit Store configuration.

    1. Open the OS Console on the Primary ESA.

    2. Navigate to the /opt/protegrity/auditstore/config directory using the following command.

      cd /opt/protegrity/auditstore/config
      
    3. Open the unicast_hosts.txt file using a text editor.

    4. Locate and update the host name and domain name.

      protegrity-esa123
      protegrity-esa123.protegrity.com
      
    5. Save and close the file.

  5. Monitor the cluster status.

    1. Log in to the Web UI of the Primary ESA.

    2. Navigate to Audit Store > Cluster Management.

    3. Wait till the following updates are visible on the Overview page.

      • The IP address of the Primary ESA is updated.
      • All the nodes are visible in the cluster.
      • The health of the cluster is green.

      It is possible to monitor the log files for any errors by logging into the ESA Web UI, navigating to Logs > Appliance, and selecting the following files from the Enterprise-Security-Administrator - Event Logs list:

      • insight_analytics
      • asmanagement
      • asrepository

Updating the host name or domain name on the Secondary ESA

Update the configurations of the Secondary ESA after the host name or domain name of the ESA has been updated.

Perform the steps on one system at a time if multiple ESAs must be updated.

Perform the following steps to refresh the configurations:

  1. Update the host name or domain name in the configuration files.

    1. Open the OS Console on the Secondary ESA.

      1. Log in to the CLI Manager on the Secondary ESA.
      2. Navigate to Administration > OS Console.
      3. Enter the root password.
    2. Update the repository.json file for the Audit Store configuration.

      1. Navigate to the /opt/protegrity/auditstore/management/config directory.

        cd /opt/protegrity/auditstore/management/config
        
      2. Open the repository.json file using a text editor.

      3. Locate and update the hosts attribute with the new host name and domain name as shown in the following example.

        "hosts": [
            "protegrity-esa456.protegrity.com"
          ]
        
      4. Save and close the file.

    3. Update the repository.json file for the Analytics configuration.

      1. Navigate to the /opt/protegrity/insight/analytics/config directory.

        cd /opt/protegrity/insight/analytics/config
        
      2. Open the repository.json file using a text editor.

      3. Locate and update the hosts attribute with the new host name and domain name as shown in the following example.

        "hosts": [
            "protegrity-esa456.protegrity.com"
          ]
        
      4. Save and close the file.

    4. Update the opensearch.yml file for the Audit Store configuration.

      1. Navigate to the /opt/protegrity/auditstore/config directory.

        cd /opt/protegrity/auditstore/config
        
      2. Open the opensearch.yml file using a text editor.

      3. Locate and update the node.name, network.host, and the http.host attributes with the new host name and domain name as shown in the following example. Update the node.name only with the host name. If required, uncomment the line by deleting the number sign (#) character at the start of the line.

        ...
        <existing code>
        ...
        node.name: protegrity-esa456
        ...
        <existing code>
        ...
        network.host:
        - protegrity-esa456.protegrity.com
        ...
        <existing code>
        ...
        http.host:
        - protegrity-esa456.protegrity.com
        
      4. Save and close the file.

    5. Update the opensearch_dashboards.yml file for the Audit Store Dashboards configuration.

      1. Navigate to the /opt/protegrity/auditstore_dashboards/config directory.

        cd /opt/protegrity/auditstore_dashboards/config
        
      2. Open the opensearch_dashboards.yml file using a text editor.

      3. Locate and update the opensearch.hosts attribute with the new host name and domain name as shown in the following example.

        opensearch.hosts: [ "https://protegrity-esa456.protegrity.com:9200" ]
        
      4. Save and close the file.

    6. Update the OUTPUT.conf file for the td-agent configuration.

      1. Navigate to the /opt/protegrity/td-agent/config.d directory.

        cd /opt/protegrity/td-agent/config.d
        
      2. Open the OUTPUT.conf file using a text editor.

      3. Locate and update the hosts attribute with the new host name and domain name as shown in the following example.

        hosts protegrity-esa456.protegrity.com
        
      4. Save and close the file.

    7. Update the INPUT_forward_external.conf file for the external SIEM configuration. This step is required only if an external SIEM is used.

      1. Navigate to the /opt/protegrity/td-agent/config.d directory.

        cd /opt/protegrity/td-agent/config.d
        
      2. Open the INPUT_forward_external.conf file using a text editor.

      3. Locate and update the bind attribute with the new host name and domain name as shown in the following example.

        bind protegrity-esa456.protegrity.com
        
      4. Save and close the file.

  2. Recreate the Docker containers using the following steps.

    1. Open the OS Console on the Secondary ESA, if it is not opened.

      1. Log in to the CLI Manager on the Secondary ESA.
      2. Navigate to Administration > OS Console.
      3. Enter the root password.
    2. Stop the containers using the following commands.

      /etc/init.d/asrepository stop
      /etc/init.d/asdashboards stop
      
    3. Remove the containers using the following commands.

      /etc/init.d/asrepository remove
      /etc/init.d/asdashboards remove
      
    4. Start the containers using the following commands.

      /etc/init.d/asrepository start
      /etc/init.d/asdashboards start
      
  3. Rotate the Audit Store certificates on the Secondary ESA. Perform the steps on the Secondary ESA using the IP address of the Primary ESA, which is the Lead node, for rotating the certificates.

    For the steps to rotate Audit Store certificates, refer here.

  4. Update the unicast_hosts.txt file for the Audit Store configuration.

    1. Open the OS Console on the Primary ESA.

    2. Navigate to the /opt/protegrity/auditstore/config directory using the following command.

      cd /opt/protegrity/auditstore/config
      
    3. Open the unicast_hosts.txt file using a text editor.

    4. Locate and update the host name and domain name.

      protegrity-esa456
      protegrity-esa456.protegrity.com
      
    5. Save and close the file.

  5. Monitor the cluster status.

    1. Log in to the Web UI of the Primary ESA.

    2. Navigate to Audit Store > Cluster Management.

    3. Wait till the following updates are visible on the Overview page.

      • The IP address of the Secondary ESA is updated.
      • All the nodes are visible in the cluster.
      • The health of the cluster is green.

      Monitor the log files for any errors by logging into the ESA Web UI, navigating to Logs > Appliance, and selecting the following files from the Enterprise-Security-Administrator - Event Logs list:

      • insight_analytics
      • asmanagement
      • asrepository

5 - Updating Insight custom certificates

Certificates must be rotated in certain cases, such as, when the certificates expire or become invalid. If the ESA Management and Web Services certificates are rotated, then the Insight certificates must be rotated. Complete the steps provided here to rotate custom Insight certificates on the nodes in the Audit Store cluster. Complete the steps for one of the two scenarios, for a single-node cluster where nodes have still to be added to the cluster or a multi-node cluster where the nodes are already added to the cluster.

These steps are only applicable for custom certificate and keys. For rotating Protegrity certificates, refer here.

For more information about Insight certificates, refer here.

Rotate custom certificates on the Audit Store cluster that has a single node in the cluster using the steps provided in Using custom certificates in Insight.

On a multi-node Audit Store cluster, the certificate rotation must be performed on every node in the cluster. First, rotate the certificates on a Lead node, which is the Primary ESA, and then use the IP address of this Lead node while rotating the certificates on the remaining nodes in the cluster. The services mentioned in this section must be stopped on all the nodes, preferably at the same time with minimum delay during certificate rotation. After updating the certificates, the services that were stopped must be started again on the nodes in the reverse order.

  1. Log in to the ESA Web UI.

  2. Navigate to System > Services > Misc.

  3. Stop the td-agent service. This step must be performed on all the other nodes followed by the Lead node.

  4. On the ESA Web UI, navigate to System > Services > Misc.

  5. Stop the Analytics service. This step must be performed on all the other nodes followed by the Lead node. The other nodes might not have Analytics installed. In this case, skip this step on those nodes.

  6. Navigate to System > Services > Audit Store.

  7. Stop the Audit Store Management service. This step must be performed on all the other nodes followed by the Lead node.

  8. Navigate to System > Services > Audit Store.

  9. Stop the Audit Store Repository service.

    Attention: This is a very important step and must be performed on all the other nodes followed by the Lead node without any delay. A delay in stopping the service on the nodes will result in that node receiving logs. This will lead to inconsistency in the logs across nodes and logs might be lost.

  10. Apply the custom certificates on the Lead ESA node.

    For more information about certificates, refer to Using custom certificates in Insight.

  11. Complete any one of the following steps on the remaining nodes in the Audit Store cluster.

    • Apply the custom certificates on the remaining nodes in the Audit Store cluster.

      For more information about certificates, refer to Using custom certificates in Insight.

    • Run the Rotate Audit Store Certificates tool on all the remaining nodes in the Audit Store cluster one node at a time.

      1. In the ESA Web UI of a node in the Audit Store cluster, click the Terminal Icon in lower-right corner to navigate to the ESA CLI Manager.

      2. Navigate to Tools > Rotate Audit Store Certificates.

      3. Enter the root password and select OK.

      4. Enter the admin username and password and select OK.

      5. Enter the IP address of the Lead node in Target Audit Store Address and select OK.

      6. Enter the admin username and password for the Lead node and select OK.

      7. After the rotation is completed without errors, the following screen appears. Select OK to go to the CLI menu screen.

        The CLI screen appears.

  12. In the ESA Web UI, navigate to System > Services > Audit Store.

  13. Start the Audit Store Repository service.

Attention: This step must be performed on the Lead node followed by all the other nodes without any delay. A delay in starting the services on the nodes will result in that node receiving logs. This will lead to inconsistency in the logs across nodes and logs might be lost.

  1. Navigate to System > Services > Audit Store.

  2. Start the Audit Store Management service. This step must be performed on the Lead node followed by all the other nodes.

  3. Navigate to Audit Store > Cluster Management and confirm that the Audit Store cluster is functional and the Audit Store cluster status is green or yellow as shown in the following figure.

  4. Navigate to System > Services > Misc.

  5. Start the Analytics service. This step must be performed on the Lead node followed by all the other nodes. The other nodes might not have Analytics installed. In this case, skip this step on those nodes.

  6. Navigate to System > Services > Misc.

  7. Start the td-agent service. This step must be performed on the Lead node followed by all the other nodes.

    The following figure shows all services that are started.

  8. On the ESA Web UI, navigate to Audit Store > Cluster Management.

  9. Verify that the nodes are still a part of the Audit Store cluster.

6 - Removing an ESA from the Audit Store cluster

When the ESA is removed from the Audit Store cluster, the td-agent service is stopped, then the indexes for the node are removed and the node is detached from the Audit Store cluster. The ports to the node are closed.

Before you begin:

Verify if the scheduler task jobs are enabled on the ESA using the following steps:

  1. Log in to the ESA Web UI.
  2. Navigate to System > Task Scheduler.
  3. Verify whether the following tasks are enabled on the ESA.
    • Update Policy Status Dashboard
    • Update Protector Status Dashboard

Perform the following steps to remove the ESA node:

  1. From the ESA Web UI, click Audit Store > Cluster Management to open the Audit Store clustering page.

    The Overview screen appears.

  2. Click Leave Cluster.

    A confirmation dialog box appears. The Audit Store cluster information is updated when a node leaves the Audit Store cluster. Hence, nodes must be removed from the Audit Store cluster one at a time. Removing multiple nodes from the Audit Store cluster at the same time using the ESA Web UI would lead to errors.

  3. Click YES.

    The ESA is removed from the Audit Store cluster. The Leave Cluster button is disabled and the Join Cluster button is enabled. The process takes time to complete. Stay on the same page and do not navigate to any other page while the process is in progress.

  4. If the scheduler task jobs were enabled on the ESA that was removed, then enable the scheduler task jobs on another ESA in the Audit Store cluster. These tasks must be enabled on any one ESA in the Audit Store cluster. Enabling on multiple nodes might result in a loss of data.

    1. Log in to the ESA Web UI of any one node in the Audit Store cluster.
    2. Navigate to System > Task Scheduler.
    3. Enable the following tasks by selecting the task, clicking Edit, selecting the Enable check box, and clicking Save.
      • Update Policy Status Dashboard
      • Update Protector Status Dashboard
    4. Click Apply.
    5. Specify the root password and click OK.

After leaving the Audit Store cluster, the configuration of the node and data is reset. The node will be uninitialized. Before using the node again, Protegrity Analytics needs to be initialized on the node or the node needs to be added to another Audit Store cluster.