Adding an existing cluster

Add an existing DataStax Enterprise cluster to manage using OpsCenter Monitoring. Install agents on the cluster nodes automatically.

Add an existing DataStax Enterprise cluster to manage within OpsCenter. After you add the cluster to OpsCenter, you can import the cluster into Lifecycle Manager to centrally manage the cluster topology and configuration.
Note: If configuration encryption is active, OpsCenter automatically encrypts the sensitive fields such as passwords and writes the encrypted values to the configuration files. Do not enter manually encrypted values in the password fields.

Procedure

  1. Click New Cluster from the OpsCenter Monitoring main menu.
    The New Cluster prompt appears.

  2. Click Manage Existing Cluster and Get Started.
    The Connect to Existing Cluster dialog appears.


    Collapsed view Connect to Existing Cluster dialog in OpsCenter Monitoring

  3. Enter at least one hostname or IP address for a node in the cluster.
    
    ec2-123-45-6-789.us-west-1.compute.amazonaws.com
    ec2-234-56-7-890.us-west-1.compute.amazonaws.com
    
  4. If applicable, change the JMX Port and Native Transport Port listen port numbers if you are not using the defaults.
  5. If applicable, click Add credentials to add or edit the user credentials (username and passwords) if the JMX or Native Transport ports require authentication.
  6. Optional: If applicable to your environment, select DSE security (kerberos) is enabled on my cluster and complete the fields.

    DSE security (Kerberos) enabled configuration settings for OpsCenter connections

    1. Enter the Service Name. For example, if the server principal on your nodes is dse/nodeX.example.com@EXAMPLE.COM, this field should be dse.
    2. Enter the Opscenterd Client Principal for the OpsCenter process/machine to use. Example: opscenterd/opscenterd.EXAMPLE.COM.
    3. Enter the location of the keytab OpsCenter machine in Opscenterd Keytab Location, which contains credentials for the opscenter_client_principal. Example: /etc/opscenter/security/krb5_opsc.keytab.
    4. Enter the client principal for the DataStax Agent process/machine to use in DataStax Agent Client Principal. Example: dxagent/_HOST.
      Important: Because each datastax-agent has a different principal name, the DataStax Agent Client Principal entered in this field is a placeholder. The kerberos_client_principal property must be set in the address.yaml file for each datastax-agent. For example:
      kerberos_client_principal: datastax-agent@dsenode1/dsenode2/dsenode3
    5. Enter the location of the keytab on the DataStax Agent machines in DataStax Agent Keytab Location, which contains credentials for the agent_client_principal. Example: /usr/agent/conf/krb5_agent.keytab.

    For more information, see Setting up Kerberos and the Kerberos tutorial.

  7. Optional: If applicable to your environment, select Client-to-node encryption is enabled on my cluster.

    Client-to-node encryption enabled connection settings for OpsCenter and Agents

    Note: For information about creating keystores and truststores, see Enabling client-to-node encryption in OpsCenter.
  8. If configuring client-to-node settings, indicate the following for OpsCenter and each agent to use for connecting directly to the monitored DSE cluster.
    When client-to-node encryption is enabled for a cluster using Lifecycle Manager, the ssl_truststore and ssl_truststore_password fields are automatically propagated in cluster_name.conf with the corresponding values from ssl_keystore and ssl_keystore_password for both opscenterd and the agent: LCM propagates the ssl_keystore value into ssl_keystore and ssl_truststore; and the ssl_keystore_password value into ssl_keystore_password and ssl_truststore_password.
    1. Enter the OpsCenter Keystore Path, which is the SSL keystore location for OpsCenter (opscenterd) to use for connecting to the monitored DSE cluster. The value entered in the UI populates the [cassandra] ssl_keystore property in the OpsCenter cluster configuration file (cluster_name.conf).
    2. Enter the Password for the OpsCenter Keystore Path. The value entered in the UI populates the [cassandra] ssl_keystore_password property in cluster_name.conf.
    3. Enter the OpsCenter Truststore Path, which is the SSL truststore location for OpsCenter (opscenterd) to use for connecting to the monitored DSE cluster. This value should be the same as OpsCenter Keystore Path if the same file is used as both the keystore and the truststore (that is, there is not a separate truststore). The value entered in the UI populates the [cassandra] ssl_truststore property in cluster_name.conf.
    4. Enter the Password for the OpsCenter Truststore Path. This value should be the same as password for the OpsCenter Keystore Path if the same file is used as both the keystore and the truststore (that is, there is not a separate truststore). The value entered in the UI populates the [cassandra] ssl_truststore_password property in cluster_name.conf.
    5. Enter the Agent Keystore Path, which is the SSL keystore location for each agent to use for connecting to the monitored DSE cluster. The value entered in the UI populates the [agents] ssl_keystore property in cluster_name.conf.
    6. Enter the Password for the Agent Keystore Path. The value entered in the UI populates the [agents] ssl_keystore_password property in cluster_name.conf.
    7. Enter the Agent Truststore Path, which is the SSL truststore location for each agent to use for connecting to the monitored DSE cluster. This value should be the same as password for the Agent Keystore Path if the same file is used as both the keystore and the truststore (that is, there is not a separate truststore).The value entered in the UI populates the [agents] ssl_truststore property in (cluster_name.conf).
    8. Enter the Password for the Agent Truststore Path. This value should be the same as password for the Agent Keystore Path if the same file is used as both the keystore and the truststore (that is, there is not a separate truststore). The value entered in the UI populates the [agents] ssl_truststore_password property in cluster_name.conf.
  9. Click Next.
    The Set Up Agents dialog appears.

    Install Agents automatically or manually dialog

  10. Install or start agents automatically is selected by default. Click Next.
    If your environment requires manual installation of agents, click Install agents manually. Click the link to access the instructions for manually installing agents.
    The Agents Credentials dialog appears.

    Agents Credentials dialog for connecting to nodes

  11. Enter SSH credentials to connect to the nodes:
    1. Required: Enter a Username. The user must have root or sudo privileges.
    2. Optional: A sudo password can be entered in the Password box.
    3. Optional: Enter a Private Key.
    Entered credentials information is not saved or stored.
  12. Click Submit.
    The Agents tab opens, starts installing the agents, and displays the progress of the agent installation. The agent services may go up and down during the installation process.

    Agent Status while installing

    When the install process successfully completes, the DataStax agents have been deployed and configured for each managed node in the DataStax Enterprise cluster.

    Agents tab for viewing agents status