Cisco Meraki Event Collector
The Cisco Meraki Event Collector microservice polls event data from discovered Cisco Meraki devices by API using an API key. It collects data at regular intervals according to the poll time, normalizes it, and writes it to Apache Pulsar topic for the Event Sink microservice.
Cisco Meraki has an API rate limited to five calls per second per organization.
You can enable redundancy for this microservice when you deploy it. See Configuring Microservice Redundancy for general information.
Cisco Meraki Event Collector Prerequisites
-
A microservice cluster is set up. See Microservice Cluster Setup.
-
The following microservices are deployed:
-
Meraki devices are already discovered and added to OCUA devices table and the meta data like Url, Organization name, Organization ID and API access key entries exist in the OCUA DB.
-
(Optional) You have created a Kubernetes secret containing the proxy certificates by running the following command as the assure1 user:
export NAMESPACE=<namespace> a1k create secret generic meraki-proxy-secret --from-file=<PROXY_CA_FILE> --from-file=<PROXY_CRT_FILE> --from-file=<PROXY_KEY_FILE> -n $NAMESPACE
where <namespace> is the namespace where you are deploying the microservice. The default namespace is a1-zone1-pri, but you can change the zone number and, when deploying to a redundant cluster, change pri to sec.
You can optionally use a different name for the secret files. If you do so, set them in the configData.PROXY_CA_FILE, configData.PROXY_CRT_FILE and configData.PROXY_KEY_FILE configuration parameters when you deploy the microservice.
Deploying Cisco Meraki Event Collector
To deploy the microservice, run the following commands:
su - assure1
export NAMESPACE=<namespace>
export WEBFQDN=<webFQDN>
a1helm install <microservice-release-name> assure1/cisco-meraki-event-collector -n $NAMESPACE --set global.imageRegistry=$WEBFQDN
In the commands:
-
<WebFQDN> is the fully-qualified domain name of the primary presentation server for the cluster.
-
<microservice-release-name> is the name to use for the microservice instance. Oracle recommends using the microservice name (cisco-meraki-event-collector) unless you are deploying multiple instances of the microservice to the same cluster.
You can also use the Unified Assurance UI to deploy microservices. See Deploying a Microservice by Using the UI for more information.
Changing Cisco Meraki Event Collector Configuration Parameters
When running the install command, you can optionally change default configuration parameter values by including them in the command with additional --set arguments. You can add as many additional --set arguments as you need.
For example:
-
Set a parameter described in Default Cisco Meraki Event Collector Configuration by adding --set configData.<parameter_name>=<parameter_value>. For example, --set configData.LOG_LEVEL=DEBUG.
-
Enable redundancy for the microservice by adding --set redundancy.enabled=true.
Default Cisco Meraki Event Collector Configuration
The following table describes the default configuration parameters found in the Helm chart under configData for the Cisco Meraki Event Collector microservice.
Name | Default Value | Possible Values | Notes |
---|---|---|---|
LOG_LEVEL | INFO | FATAL, ERROR, WARN, INFO, DEBUG | Logging level used by application. |
STREAM_OUTPUT_EVENT | persistent://assure1/event/sink | Text, 255 characters | Event sink topic path. |
REDUNDANCY_INIT_DELAY | 20 | Integer | The number of seconds the secondary microservice waits for the primary microservice to start |
REDUNDANCY_POLL_PERIOD | 5 | Integer | The number of seconds between status checks from the secondary microservice to the primary microservice. |
REDUNDANCY_FAILOVER_THRESHOLD | 4 | Integer | The number of times the primary microservice must fail checks before the secondary microservice becomes active. |
REDUNDANCY_FALLBACK_THRESHOLD | 1 | Integer | The number of times the primary microservice must succeed checks before the secondary microservice becomes inactive. |
PROXY_INSECURE_SKIP_VERIFY | true | Boolean | When set to true, certificate validation will be skipped. |
PROXY_USE_CERTS | false | Boolean | When set to true, custom TLS certificates will be used while connecting to Cisco Meraki API. |
PROXY_CA_FILE | "proxyCA.crt" | String | Custom filename for proxy TLS CA Bundle. |
PROXY_CRT_FILE | "proxy.crt" | String | Custom filename for proxy certificate file. |
PROXY_KEY_FILE | "proxy.key" | String | Custom filename for proxy key file. |