Skip to content

Netapp Poller

The Netapp Poller microservice polls metrics from the Netapp ONTAP REST API.

This microservice is part of the Metric microservice pipeline. See Understanding Microservice Pipelines in Unified Assurance Concepts for conceptual information.

You can enable redundancy for this microservice when you deploy it. See Configuring Microservice Redundancy for general information.

Netapp Poller Prerequisites

  1. A microservice cluster is set up. See Microservice Cluster Setup.

  2. The following microservices are deployed:

  3. You have set up a Kubernetes secret for the passwords for all Netapp API instances as follows:

    1. Create a plain text netapp.secret file that contains the BASE64 encoded Netapp API password.

    2. Run the following command as the assure1 user:

      a1k create secret generic netapp-secret --from-file=netapp.secret -n $NAMESPACE
      

      You must use netapp-secret as the secret name.

    3. For additional instances, create another file for each instance that contains the BASE64 encoded password for that instance, give the file a custom name (<custom_secret_file>), and rerun the command:

      a1k create secret generic netapp-secret --from-file=<custom_secret_file>.secret -n $NAMESPACE
      

Deploying Netapp Poller

The Netapp Poller microservice supports polling for multiple Netapp instances.

To deploy the microservice for a single instance, using the default netapp.secret file, run the following commands:

su - assure1
export NAMESPACE=<namespace>
export WEBFQDN=<WebFQDN> 
a1helm install <microservice-release-name> assure1/netapp-poller -n $NAMESPACE --set global.imageRegistry=$WEBFQDN --set configData.TARGET_HOST=<target_host> --set configData.TARGET_USER=<target_user>
In the commands:

  • <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.

  • <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 (netapp-poller) unless you are deploying multiple instances of the microservice to the same cluster.

  • <target_host> is the address of the Netapp API

  • <target_user> is the Netapp API user with rights to access performance counters endpoints

If you are using the default netapp.secret file, you do not need to specify it in the command.

To deploy additional instances of the microservice for additional Netapp instances, using your custom secret file, run the following commands for each additional instance:

su - assure1
export NAMESPACE=<namespace>
export WEBFQDN=<WebFQDN> 
a1helm install <microservice-release-name-2> assure1/netapp-poller -n $NAMESPACE --set global.imageRegistry=$WEBFQDN --set configData.TARGET_HOST=<target_host_2>--set configData.TARGET_USER=<target_user_2> --set configData.SECRET=<custom_secret_file>.secret
In the commands:

  • <microservice-release-name-2> is the unique release name for the additional microservice instance. You use any name, but Oracle recommends using something logical that includes the microservice name for tracking purposes. If you use a name that is not unique, a random suffix is added to differentiate between the first Netapp Poller instance.

  • <target_host> is the address of the additional instance of the Netapp API.

  • <target_user> is the Netapp API user for the additional instance with rights to access performance counters endpoints.

  • <custom_secret_file> is the file containing the credentials for the additional instance.

You can also use the Unified Assurance UI to deploy microservices. See Deploying a Microservice by Using the UI for more information.

Changing Netapp Poller Configuration Parameters

When running the install command, you can optionally change other 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 Netapp Poller 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.

Default Netapp Poller Configuration

The following table describes the default configuration parameters found in the Helm chart under configData for the microservice.

Name Default Value Possible Values Notes
LOG_LEVEL INFO FATAL, ERROR, WARN, INFO, DEBUG Logging level used by application.
STREAM_OUTPUT persistent://assure1/metric/sink Text, 255 characters Allows redirecting stream output to different topic.
TARGET_USER Text, 255 characters Netapp API User.
TARGET_HOST Text, 255 characters Netapp API address.
SECRET_NAME netapp.secret Text, 255 characters Name of the secret to read from.
POLL_INTERVAL_S 300 Integer Polling interval in seconds.
METRICS_V5_MODE false true, false Enables legacy compatibility mode (Metrics will be visible in v5 UI).
DEVICE_ZONE_ID 1 Text, 255 characters The poller will only poll devices that are in the specific zone.
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.