Skip to main content
Keystone

Configure Keystone Collector in private mode

Contributors netapp-shwetav
PDFs

Complete a few configuration tasks to enable Keystone Collector to collect usage data in an environment that does not have internet access, also known as a as a dark site or private mode. This is a one-time activity to activate and associate the required components with your storage environment. Once configured, Keystone Collector will monitor all ONTAP clusters managed by Active IQ Unified Manager.

Note Keystone Collector provides you with the Keystone Collector Management Terminal User Interface (TUI) utility to perform configuration and monitoring activities. You can use various keyboard controls, such as the Enter and arrow keys, to select the options and navigate across this TUI.
Steps

  1. Start the Keystone Collector management TUI utility:

    keystone-collector-tui

  2. Go to Configure > Advanced.

  3. Toggle the Darksite Mode option.

    Darksite mode

  4. Select Save.

  5. Go to Configure > KS-Collector to configure Keystone Collector.

  6. Toggle the Start KS Collector with System field.

  7. Toggle the Collect ONTAP Usage field. Add the details of the Active IQ Unified Manager (Unified Manager) server and user account.

  8. Optional: Toggle the Using Tiering Rate plans field if data tiering is required for the subscription.

    Based on the subscription type purchased, update the Usage Type.

    Note Before configuring, confirm the usage type associated with the subscription from NetApp.

    Usage type option

  9. Select Save.

  10. Go to Configure > KS-Collector to generate the Keystone Collector keypair.

  11. Go to Encryption Key Manager and press Enter.

    Encryption Key Manager option

  12. Select Generate Collector Keypair and press Enter.

    Generate Collector Keypair option

  13. Ensure that the Keystone Collector is in a healthy state by returning to the main screen of the TUI and verifying the Service Status information. The system should show that the services are in an Overall: Healthy status. Wait up to 10 minutes, if the overall status remains unhealthy after this period, review the previous configuration steps and contact the NetApp support team.

    Service status

  14. Exit the Keystone Collector management TUI by selecting Exit to Shell option on the home screen.

  15. Retrieve the generated public key:

    ~/collector-public.pem

  16. Send an email with this file to keystone.services@netapp.com.

Export usage report

You should send the monthly usage summary report to NetApp at the end of every month. You can generate this report manually.

Follow these steps to generate the usage report:

  1. Go to to Export Usage on the Keystone Collector TUI home screen.

  2. Collect the files and send them to keystone.services@netapp.com.

    Keystone Collector generates both a clear file and an encrypted file, which should be manually sent to NetApp. The clear file report contains the following details that can be validated by the customer.

    Clear file report

Upgrade ONTAP

Keystone Collector supports ONTAP upgrades through TUI.

Follow these steps to upgrade ONTAP:

  1. Go to Maintenance > ONTAP Upgrade Webserver.

  2. Copy the ONTAP upgrade image file to /opt/netapp/ontap-upgrade/, then select Start Webserver to start the web server.

    Start Webserver option

  3. Go to http://<collector-ip>:8000 using a web browser for upgrade assistance.

Restart Keystone Collector

You can restart the Keystone Collector service through the TUI. Go to Maintenance > Restart Collector Services in the TUI. This will reboot all collector services, and their status can be monitored from the TUI home screen.

Restart Collector Services option