2.2.8. Elevate - OPCC

Note

This section only concerns Elevate users. This deployment is not part of the OpenNAC infrastructure.

The OPCC (On-Premises Communication Component) is the component in charge of communicating with OpenNAC instances, obtaining their data, and sending it to the Central Services (CS) component of Elevate. The CS will then store and provide visual information for monitoring OpenNAC instances.

For more information, see the Elevate section.

2.2.8.1. OPCC Component Deployment

To achieve a resilient and efficient platform that adapts to the needs of each case, Elevate is deployed on a technology that is flexible, and dynamic and allows taking advantage of the resources in an efficient way.

That is why, as the basis of the deployment, Docker container technology has been chosen to deploy the different modules and components.

Regarding the OPCC component, a Docker image has been created from which a container is executed. This allows the deployment of the OPCC module in the different OpenNAC instances in a simple way, always replicating the exact same environment.

Execute the steps below to deploy the OPCC component.

Note

Deploy the OPCC module in one of the machines where OpenNAC is deployed. It cannot be in the “Core”, since Docker creates network interfaces and when validating a license, it can alter the interfaces and make them invalid. It can be in the Sensor or the Analytics.

1. Download and extract files from the OpenNAC repository (https://repo-opennac.opencloudfactory.com/opcc/opcc_deployment.tar.gz).

2. Enable connectivity to external URLs from the client:

3. Execute the on_docker_install_step_1.sh file to install the Docker on the machine.

4. Execute the on_load_opcc_image_step_2.sh file to obtain the OPCC image. It will ask for your credentials, use the same ones you used for downloading the “repo-opennac” packets.

5. Customize the following lines of the variables.conf file:

  • registration_token: Registration token generated in Elevate

  • opennac_api_ip_port: IP and Port of the OpenNAC API.

  • es_ip_port: Elasticsearch IP and Port.

  • logstash_ips_ports: Logstash IP and Port.

  • opennac_username: OpenNAC user name.

  • opennac_api_key: API KEY to access the OpenNAC API.

  • license_management: State weather Elevate shpuld manage OpenNAC licenses automatically.

  • days_before_license_expiring: The number of days before license expiration.

  • conn_protocol: Connection protocol (HTTP o HTTPS).

  • use_http_proxy: Use of client proxy.

  • http_proxy_address: Proxy IP address.

  • http_proxy_auth: Proxy authentication.

  • cloud_instance_url: Elevate URL.

  • opcc_version: OPCC version.

  • emmaabs_instance: If it is an emmaABS instance (the standard OPCC instances has this value set to “false”)

6. Execute the opcc_start.sh file to finally deploy the OPCC component.

7. Finally, verify if the deployment was successful. This can be done by running the following command and monitoring the logs to ensure that everything is functioning as expected:

[root@07-analytics-02 opcc_files]# docker logs -f opcc
[2023-11-16 15:01:59] OPCC starting...
[2023-11-16 15:01:59] Communication with central server OK
[2023-11-16 15:01:59] Communication with OpenNAC OK
[2023-11-16 15:01:59] Getting openNAC version...
[2023-11-16 15:02:03] Processing current state: AuthenticateState
[2023-11-16 15:02:03] OpenNAC ID still not obtained, obtaining...!
[2023-11-16 15:02:03] Processing current state: RegisterState
[2023-11-16 15:02:03] Instance correctly registered!
[2023-11-16 15:02:03] Processing current state: AuthenticateState
[2023-11-16 15:02:03] Instance correctly authenticated!
[2023-11-16 15:02:03] Processing current state: StaticDataState
[2023-11-16 15:02:04] Static data saved, start sending telemetry...!
[2023-11-16 15:02:04] Processing current state: TelemetryState
[2023-11-16 15:02:07] Telemetry saved, start sending healthchecks...!
[2023-11-16 15:02:07] Processing current state: HealthcheckState
[2023-11-16 15:02:07] Healthcheck saved, getting uptime data...!
[2023-11-16 15:02:07] Processing current state: UptimeState
[2023-11-16 15:02:07] Uptime saved, waiting 1 minute to send next healthcheck...!