Ankush Cluster Manager - Cassandra Technology User Guide

Transcription

1 Ankush Cluster Manager - Cassandra Technology User Guide

2 Ankush User s Guide for Cassandra, Version 1.5 This manual, and the accompanying software and other documentation, is protected by U.S. and international copyright laws, and may be used only in accordance with the accompanying license agreement. Features of the software, and of other products and services of Impetus Technologies, may be covered by one or more of the following patents: U.S. Patent Nos. Other patents pending. All rights reserved. All other company, brand and product names are registered trademarks or trademarks of their respective holders. Impetus Technologies disclaims any responsibility for specifying which marks are owned by which companies or which organizations. USA Los Gatos Impetus Technologies, Inc. 720 University Avenue, Suite 130 Los Gatos, CA 95032, USA Ph: , Fax: Impetus Technologies, Inc., All rights reserved. If you have any comments or suggestions regarding this document, please send them via to [email protected]. AnkushUG1.5/01

3 Table of Contents List of Figures... 4 List of Tables Chapter-1 Introduction Objective Scope Target Audience Chapter-2 Ankush - Cassandra Capabilities Chapter-3 Creating Cassandra Cluster Common Inputs & Actions Cassandra Specific Inputs & Actions Node Level Configuration Chapter-4 Managing Cassandra Cluster Cluster Details Node List Node Details Node Level Actions Node Level Parameters Working With Keyspaces & Column Families Chapter-5 Monitoring Cassandra Cluster Node Utilization Graph Ring Topology Chapter-6 Tiles Summary Glossary List of terms Revision History Impetus Confidential Page 3 of 35

4 List of Figures Figure 1: Blank Cassandra Cluster creation page Figure 2: Filled Cassandra cluster creation page Figure 3: Configuring Cassandra Cluster Figure 4: Node Level Configuration Figure 5: Cassandra Cluster Details Figure 6: Cassandra Node List Figure 7: Cassandra Node Details Figure 8: Node Level Actions Figure 9: Node Level Parameters Figure 10: Keyspaces Link Figure 11: Keyspaces listing Figure 12: Column Families Figure 13: Keyspace - Actions Figure 14: Column Family - Properties Figure 15: Cluster Monitoring - Generic features Figure 16: Node Utilization Graph Figure 17: Ring Topology List of Tables Table 1: Cassandra - Configurable parameters Table 2: Tiles Summary Table 3: Revision History Impetus Confidential Page 4 of 35

5 Welcome to Ankush Welcome to Ankush, Impetus s Big Data Cluster Management product and Auto-provisioning product that creates and manages clusters of different technologies. Ankush provides visual, graphical, and notifications regarding the health of a Cluster that allow Cluster Administrators to take informed actions. Using This Guide This guide describes how to use Ankush for big data cluster management for Cassandra Technology. It provides step-by-step information and instructions (as required) to create, monitor and manage clusters with Ankush. PART I Introduction Provides an introduction to Cassandra Capabilities of Ankush and enlists all the supported features. PART II Creating Cassandra Cluster Describes how to create a new Cassandra cluster with all the relevant screenshots and details related to the configurable parameters. PART IV Managing & Monitoring Cassandra Cluster Describes about the various options and configurable parameters available to the user that can be applied over a running Cassandra Cluster. Provides the options through which a Cassandra cluster can be managed and configured. It also describes various options to monitor the health of a running Cassandra Cluster. This includes viewing utilization reports, heat maps etc. Glossary Impetus Confidential Page 5 of 35

6 Provides definition and description to difficult technical terminologies and jargons. Impetus Confidential Page 6 of 35

7 Ankush Documentation Set In addition to this user s guide, Ankush comes with the following printed documentation. Ankush Installation Guide explains how to install Ankush. Ankush - Getting Started Guide for getting started with Ankush, understand the UI Elements, Hierarchical views, user management and navigational possibilities. Ankush User s Guide for Storm explains about creating, managing and monitoring a Storm technology cluster using Ankush product. Ankush User s Guide for Kafka explains about creating, managing and monitoring a Kafka technology cluster using Ankush product. Ankush User s Guide for Hadoop explains about creating, managing and monitoring a Hadoop technology cluster using Ankush product. Ankush User s Guide for Elastic Search explains about creating, managing and monitoring an Elastic Search technology cluster using Ankush product. Ankush User s Guide for Oracle SQL explains about creating, managing and monitoring an Oracle NoSQL technology cluster using Ankush product. Impetus Confidential Page 7 of 35

8 Part I Introduction Impetus Confidential Page 8 of 35

9 Typographical Conventions This guide uses the following typographical conventions: 1, 2, 3 Sequence of steps in a procedure Used to indicate features Indicates options and steps Courier New Bold Used to indicate code Indicates important notes, method or function names [ ] Encloses optional arguments Figure 1, Figure 2 Table 1, Table 2 Indicates figure numbers in sequential order Indicates table numbers in sequential order 1.1, 1.2 Indicates sub-topics Impetus Confidential Page 9 of 35

10 1 Chapter-1 Introduction Ankush Cluster Manager or Ankush is a Big Data Cluster Management and Autoprovisioning web application that creates and manages clusters of different technologies. Ankush provides visual, graphical, and notifications regarding the health of a Cluster that allow Cluster Administrators to take informed actions. 1.1 Objective The objective of this document is to provide seamless assistance and support to the users of Ankush in exploring and understanding the features and functionalities offered by the product. It also furnishes a step-by-step guidance to help the users understand the operating steps, information flow with screenshots, navigation methods etc. 1.2 Scope The scope of this document is to elicit and describe all the features and functionalities of Ankush with Cassandra technology offered to user in detail. This includes the description of each feature along with the product screenshots. Prerequisites: It is expected that any reader using this guide has basic understanding of Ankush, its UI Elements, Hierarchical views, user management, navigational possibilities, common Cluster Creation inputs and actions, common cluster management and monitoring etc. as elaborated in Ankush - Getting Started Guide. 1.3 Target Audience The target audience of this document is cluster implementers and cluster managers. Impetus Confidential Page 10 of 35

11 2 Chapter-2 Ankush - Cassandra Capabilities Ankush brings forth wide-ranging set of features as follows: Cassandra Big Data Technology Supported Vendors: Apache (2.0.3, 2.0.1, 1.2.5) and DataStax (2.0.3, 2.0.1, 1.2.5) Management Services Keyspaces Column Families Parameter Management for Cluster & Nodes Configuring Alerts/Warnings threshold Monitoring Graphically represented Cluster Level Utilization Metrics Graphically represented Node Level Utilization Metrics Heat Maps Logs Audit Trail Events Impetus Confidential Page 11 of 35

12 Part II Creating Cassandra Cluster Impetus Confidential Page 12 of 35

13 3 Chapter-3 Creating Cassandra Cluster 3.1 Common Inputs & Actions There are various common inputs while creating a cluster as detailed in the Getting Started Guide. General Details: Includes Cluster Name and its description. Java: This deals with installing fresh Java or use existing Java. Nodes: Includes authenticating nodes, retrieving those for further operations and inspecting the nodes whether they suffices the basic installation prerequisites for cluster deployment like Firewall, Require TTY, Sudo user etc. Node Authentication Node Retrieval Node Inspection Configuration: This includes configuring cluster with various generic parameters. The technology-specific parameters are covered in the next section. Deploying Cluster: This includes description of how to deploy a cluster. Tracking Cluster Deployment Progress: This includes description of method to track the progress to deploy a cluster. Please refer to Cluster Creation - Getting Started Guide for more information. A screenshot of default blank Cassandra cluster creation page is as shown below: Impetus Confidential Page 13 of 35

14 Figure 1: Blank Cassandra Cluster creation page Impetus Confidential Page 14 of 35

15 A screenshot of a filled Cassandra cluster creation page is as shown below: Figure 2: Filled Cassandra cluster creation page Impetus Confidential Page 15 of 35

16 3.2 Cassandra Specific Inputs & Actions Use vendor, version and source input to configure the vendor, version and bundle source for the Cassandra version that needs to be deployed. Note: In many of the path related configuration parameters, the default value that appears contains $user. It should be noted that, it automatically gets updated to user name based on the value provided in user name input of node authentication. Other than this, there are few more Cassandra technology specific inputs as follows. Impetus Confidential Page 16 of 35

17 Figure 3: Configuring Cassandra Cluster Note: The default value is primarily provided either on the basis of what is suggested by the technology-specific component or is suggested by Ankush product. The various configurable parameters as per the user s deployment environment configuration are as follows: Sl. No. Field Default value / path 1 Partitioner ByteOrderedPartitioner 2 Snitch SimpleSnitch 3 RPC Port Storage Port Data Directory /home/${user}/cassandra/data 6 Log Directory /home/${user}/cassandra/log Table 1: Cassandra - Configurable parameters Note: Cassandra 2.x requires Java 7 on nodes Node Level Configuration In Oracle cluster creation, Ankush allows configuring below mentioned parameters at node level. VNode Count Figure 4: Node Level Configuration Impetus Confidential Page 17 of 35

18 It should be noted that the user needs to click the Deploy button as shown in the right topmost corner of the screen to deploy the cluster in the environment. In case deployment, fails, use Redeploy feature to avoid entering data for all the inputs. For more information, refer to Redeploying Cluster with Deployment Error section Getting Started Guide. Impetus Confidential Page 18 of 35

19 Part III Managing & Monitoring Cassandra Cluster Impetus Confidential Page 19 of 35

20 4 Chapter-4 Managing Cassandra Cluster This section includes the list of features through which Ankush is managed. The management function includes many features that includes: Adding nodes to a cluster: Add Nodes link from dropdown Actions enables you to add nodes. Configuring Cluster: This provides information about the configuration with which cluster was launched in preview only mode. The contents viewed may change depending on configuration values used for cluster deployment & depending on environment of the cluster. Configuring Alert levels: Alert configuration allows the user to configure alert & warning limits for a cluster. This feature enables the user to configure thresholds level of alert & warning for CPU & Memory utilization applicable over all the nodes of the cluster on which it is configured. View Node Details: Click Nodes > to view the detail of the nodes. This opens up a list of nodes that are members of this cluster. The user can perform node related operations like viewing further details, deleting nodes etc. Deleting nodes: This function enables the user to delete nodes. Deleting cluster: This function enables the user to delete a cluster. Please refer to Cluster Management section - Getting Started Guide for more information. 4.1 Cluster Details Cluster Details page for Cassandra Cluster covers the Cassandra specific items other than the generic items as covered in Ankush - Getting Started Guide. A screenshot of Cassandra Cluster Details page is as shown below: Impetus Confidential Page 20 of 35

21 Figure 5: Cassandra Cluster Details 4.2 Node List A screenshot of Cassandra node list page displays the tile for count of Cassandra Seed nodes as shown below. In order to delete nodes, refer to Delete Nodes - Getting Started Guide. Figure 6: Cassandra Node List 4.3 Node Details A screenshot of Cassandra node details page is as shown below: Impetus Confidential Page 21 of 35

22 Figure 7: Cassandra Node Details Node Level Actions Following operations are supported at node level of a Cassandra cluster. Impetus Confidential Page 22 of 35

23 Cleanup Compact Decommission Disable / Enable Binary Disable / Enable Gossip Disable / Enable Handoff Disable / Enable Thrift Drain Flush Invalidate Keycache Invalidate Rowcache Pause / Resume Handoff Reset Local Schema Scrub All the listed operations can be performed through Actions menu as shown below. Figure 8: Node Level Actions Impetus Confidential Page 23 of 35

24 4.3.2 Node Level Parameters Node level parameters enable the user to update parameters at node level. In order to understand how to add, update or delete parameters, refer to Parameters section - Getting Started Guide. Figure 9: Node Level Parameters 4.4 Working With Keyspaces & Column Families Keyspace is the container for application data, just like a schema in a relational database. Keyspaces are used to group column families together. Typically, a cluster has one keyspace per application. Impetus Confidential Page 24 of 35

25 Figure 10: Keyspaces Link Figure 11: Keyspaces listing Column families should define metadata about the columns, but the actual columns that make up a row are determined by the client application. Impetus Confidential Page 25 of 35

26 Figure 12: Column Families The various actions that can be performed over column families through Ankush Cluster Manager are Cleanup, Compact, Flush, Repair, Scrub, Invalidate Keyspace and invalidate Rowcache. Figure 13: Keyspace - Actions Ankush Cluster Manager enables you to view general properties like compaction, compression, and performance tuning and column metadata. Impetus Confidential Page 26 of 35

27 Figure 14: Column Family - Properties It should be noted that Actions menu is unavailable for System Keyspaces and their column families. Impetus Confidential Page 27 of 35

28 5 Chapter-5 Monitoring Cassandra Cluster A very important aspect of cluster management is monitoring its health, progress status etc. Ankush provides an exhaustive graphical representation and reporting system of varied aspects. There are numerous generic features / aspects that are covered across technologies as follows: Tiles: At very top various tiles are shown which can be classified into different categories like alerts, warning & information. Some of the tiles are clickable & opens up corresponding page related to it. Refer to Tiles Summary section to view details related to Cassandra specific tiles. Trend utilization of CPU, Memory, Network, Load and Packet Heat Map: This section provides CPU / Memory utilization HeatMap of cluster nodes. Each block corresponds to a node in the cluster. Color of individual block changes independently as per the value of utilization on the corresponding node. By default CPU utilization is shown. By clicking on required metric CPU or Memory its utilization heat map can be viewed. The node IP to which that HeatMap block corresponds can be identified by resting mouse pointer on it. Clicking on HeatMap of a particular node opens up node details page for that node. EcoSystem: This section provides details about various ecosystem components installed on cluster. Individual component details can be viewed by clicking on > against each component. This normally includes information related to Nodes, Configuration, Events, Logs and Audit Trails. However, the reporting system is further enhanced and provide lots of information about other components as well like Job Monitoring for a Hadoop cluster etc. Events: This summarizes various events occurred on the cluster. Logs: This functionality allows user to view or download logs of a cluster. Audit Trail: This functionality helps to track changes in the configuration. Please refer to Cluster Monitoring Section - Getting Started Guide for more information. Impetus Confidential Page 28 of 35

29 Figure 15: Cluster Monitoring - Generic features Note: Each technology contains Cluster details page which displays Node list section through the user can further navigate to Node details page. Refer to individual sections for more details. Node utilization graphs can be accessed through UTILIZATION GRAPHS > link on Node Details page. 5.1 Node Utilization Graph A screenshot of Cassandra node utilization graph page is as shown below. The user can view the trend cumulatively for last one hour, or one day, or one week, or one month or one year. Accordingly the utilization graphs are drawn. Impetus Confidential Page 29 of 35

30 Figure 16: Node Utilization Graph 5.2 Ring Topology To view ring topology of a running Cassandra cluster, click on Ring Topology button next to Heat Map. Figure 17: Ring Topology Impetus Confidential Page 30 of 35

31 Part IV Tiles Summary Impetus Confidential Page 31 of 35

32 6 Chapter-6 Tiles Summary The following table summarizes different Cassandra technology specific tiles shown on various pages: Page Tile Details Type / Comment Cluster Details Snitch Tile Unconditional, always visible Cluster Details Keyspace count Tile Unconditional, always visible Cluster Details Partitioner Tile Unconditional, always visible Nodes List Page Seed Nodes (Seed Nodes / Total Nodes) Unconditional, always visible Node Details Token count Tile Unconditional, always visible Node Details Load Tile Unconditional, always visible Node Details Node Ownership Tile Unconditional, always visible Keyspace Keyspace count Tile Unconditional, always visible Column Family Column Family Count Tile Unconditional, always visible Column Family Durable Writes Tile Unconditional, always visible Column Family Replication Strategy Tile Unconditional, always visible Column Family Replication Factor Tile Unconditional, always visible Note: Common tiles like Node Role tile are listed in Getting Started Guide. Table 2: Tiles Summary Impetus Confidential Page 32 of 35

33 Part V Glossary Impetus Confidential Page 33 of 35

34 7 Glossary This sections describes the definitions and meaning of various terminologies and technical jargons used in this manual. This helps the readers to understand the essence of the content in a better manner. 7.1 List of terms Cluster: A collection of nodes. ~: Implies user s home directory. For root user, the home directory is /root/ and normally for any other user the home directory is /home/username/ Cluster Details: Page that provides basic information and links for working with clusters. Node List: Page that provides list of nodes that are part of a cluster. Node Details: Page that provides node specific details (Node role, services) and options to perform node level operations. Cluster Level Graphs: Page that provides cluster level graphs. Node Level Graphs: Page that provides node level graphs. Impetus Confidential Page 34 of 35

35 8 Revision History This sections describes revision history of the document date-wise. Sl. No. Date Document Remarks version 1 14-Apr-2014 v1.5 Updated document according to latest 1.5 release features and functionalities. Also, formatted and structured in a new refined template and font scheming Apr-2014 v1.5 Refined and sent the guide for team review. Table 3: Revision History Impetus Confidential Page 35 of 35