Red Hat Storage Console 2.0 Administration Guide

Transcription

1 Red Hat Storage Console 2.0 Administration Guide Administering Red Hat Storage Console Rakesh Ghatvisave Red Hat

2

3 Red Hat Storage Console 2.0 Administration Guide Administering Red Hat Storage Console Rakesh Ghatvisave Red Hat Customer Content Services

4 Legal Notice Copyright 2017 Red Hat, Inc. The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version. Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law. Red Hat, Red Hat Enterprise Linux, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries. Linux is the registered trademark of Linus Torvalds in the United States and other countries. Java is a registered trademark of Oracle and/or its affiliates. XFS is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Node.js is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project. The OpenStack Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community. All other trademarks are the property of their respective owners. Abstract This guides provides comprehensive information to manage and administer Red Hat Ceph Storage 2.0 cluster environment using the Red Hat Storage Console 2.0.

5 Table of Contents Table of Contents. CHAPTER OVERVIEW CHAPTER ABOUT THIS.... GUIDE CHAPTER CONSOLE NAVIGATION DASHBOARD VIEW CLUSTERS TAB HOSTS TAB STORAGE TAB 13. CHAPTER CLUSTER ADMINISTRATION CLUSTER DETAILS CLUSTER EXPANSION CLUSTER DETACHMENT 22. CHAPTER HOST..... ADMINISTRATION HOST METRICS 25. CHAPTER STORAGE ADMINISTRATION MANAGING OBJECT STORAGE POOLS MANAGING RBDS 34. CHAPTER USER..... ADMINISTRATION ADMINISTERING USERS USER AUTHENTICATION AND MAIL SERVER CONFIGURATION 43. CHAPTER TASK..... MANAGEMENT TASK LIST TASK FILTERING 49. CHAPTER EVENT MANAGEMENT EVENTS VIEW EVENTS FILTERING DISMISSING EVENTS 54. CHAPTER NOTIFICATIONS AND..... SHORTCUTS MENUBAR EVENTS PREVIEW AND SHORTCUT DISCOVERED HOSTS SHORTCUT TASKS PREVIEW AND SHORTCUT CONSOLE VERSION USER SIGNOUT 61. CHAPTER CONSOLE JOURNAL MAPPING CONSOLE JOURNAL MAPPING MECHANISM 63. CHAPTER TROUBLESHOOTING TROUBLESHOOTING NODES CONFIGURATION TROUBLESHOOTING MONITOR NODES CONFIGURATION TROUBLESHOOTING OSD NODES CONFIGURATION TROUBLESHOOTING IMPORT CLUSTER NODES TROUBLESHOOTING POST CLUSTER CREATION FAILURES TROUBLESHOOTING MISCELLANEOUS 69 1

6 Red Hat Storage Console 2.0 Administration Guide 2

7 CHAPTER 1. OVERVIEW CHAPTER 1. OVERVIEW Red Hat Storage Console is a web-based storage management platform specially designed to efficiently manage the software-defined storage technologies offered by Red Hat. The Console simplifies the installation, configuration, monitoring, and management of Red Hat s software-based storage systems. Red Hat Storage Console 2.0 provides seamless management of the Red Hat Ceph Storage ecosystem by providing functionalities such as creating new Ceph storage clusters, monitoring the cluster health and managing the storage capacity through an intuitive and simplified interface. 3

8 Red Hat Storage Console 2.0 Administration Guide CHAPTER 2. ABOUT THIS GUIDE The Red Hat Storage Console 2.0 Administration Guide is intended for all Storage administrators and users who plan to manage their Red Hat Ceph Storage cluster environment using Red Hat Storage Console in a simplified and GUI-based approach. 4

9 CHAPTER 3. CONSOLE NAVIGATION CHAPTER 3. CONSOLE NAVIGATION Red Hat Storage Console provides a vertical navigation bar available at the left hand side of the console to conveniently access the core administrative actions. Figure 3.1. Console Navigation Bar The Console navigation bar provides access to the following administrative tabs: 1. Dashboard: default landing interface 2. Clusters: clusters view and administration 3. Hosts : hosts view and administration 4. Storage : storage view and administration 5. Admin: events, tasks, user and mail server administration 3.1. DASHBOARD VIEW The Dashboard view is the default landing interface after logging into the Console. The Console Dashboard provides a high-level summary of the defined clusters and its associated components. Figure 3.2. Dashboard View 5

10 Red Hat Storage Console 2.0 Administration Guide The Dashboard view provides summary for the following components in a visual data cards format Aggregated Cluster Status The cluster status card displays the number of cluster(s) defined in the Console and the aggregated status. The cluster status is denoted in the form of on-screen status icons Disk Utilization Status The aggregated storage utilization percentage is depicted through a donut chart in color codes. The disk utilization of the last 24 hours is depicted in the form of a sparkline chart, progressively showing the variation and the utilization over a period of time. Figure 3.3. Aggregate Storage Utilization 6

11 CHAPTER 3. CONSOLE NAVIGATION The threshold breach conditions are reflected by the following color indicators: Table 3.1. Threshold Status Indicators Threshold Status Color Code No Threshold Blue When a threshold exists and the percentage has not surpassed any thresholds Green When the utilization percentage has surpassed the warning threshold, but not the critical threshold Orange When the utilization percentage has surpassed the critical threshold Red Storage Profiles The storage profiles card depicts the utilization of the most used storage profiles. Figure 3.4. Most Used Storage Profiles 7

12 Red Hat Storage Console 2.0 Administration Guide For thresholds breach condition indicators, see Table 3.1 Threshold Status Indicators Cluster Elements Status The associated elements of a cluster is depicted in an aggregated status card format. Figure 3.5. Cluster Elements The aggregated cluster elements displayed in the card along with their current status are: The number of hosts participating in the clusters The number of Monitor hosts The number of Placement Groups The number of storage pools The number of OSDs and Object block devices Most Used Pools The Most Used Pools card lists the most used pools in the cluster with their utilization values. 8

13 CHAPTER 3. CONSOLE NAVIGATION Figure 3.6. Most Used Pools For thresholds breach condition indicators, see Table 3.1 Threshold Status Indicators. For example, in the following screen, the storage pools are displaying full capacity utilization, depicted in red. It means that the utilization percentage has surpassed the critical threshold. 9

14 Red Hat Storage Console 2.0 Administration Guide System and Memory Performance The System and Disk Performance card displays the cross-cluster system and disk performance. Figure 3.7. System and Network Performance The aggregated CPU and Memory utilization is displayed in the form of a donut chart. To view the available CPU and memory percentage, hover the cursor anywhere on the grey area of the donut chart. A tooltip will appear showing you the available CPU and memory in percentage unit. The utilization is also depicted in the form of a sparkline chart, progressively showing the variation and the utilization over a period of time. The sparkline charts are placed before the donut charts. The aggregated disk and the network performance values are displayed with the corresponding sparkline charts. Storage administrators can use the data available here as a baseline to monitor the performance of the disks in the cluster. The system calculates the following disk and network performance metrics: IOPS (Input/Output Operations Per Second): shows the average read/writes requested on the disk with a sparkline chart Network Throughput: shows the throughput in kilobytes per second (KB/s) with a sparkline chart Network Latency: shows the network latency in milliseconds (ms) with a sparkline chart Figure 3.8. Disk and Network Performance 10

15 CHAPTER 3. CONSOLE NAVIGATION 3.2. CLUSTERS TAB The Clusters tab in the navigation bar lists all the defined clusters in the Console in a rows format. Each row shows the individual cluster attributes. At a glance, for a given cluster, the viewable visual items are: The cluster status The disk utilization summary The number of hosts The number of pools part of the cluster The number of alerts triggered Figure 3.9. Cluster Attributes The clickable attributes in the cluster row are the cluster name, the number of hosts and pools, and the alerts. Clicking on any of these attributes will redirect you to the specific administration page. 11

16 Red Hat Storage Console 2.0 Administration Guide The various administrative operations such as create and import cluster are invoked from the Clusters tab. Note For detailed instructions to create a new cluster, see the Initial Cluster Creation section of the Red Hat Storage Console 2.0 Quick Start Guide HOSTS TAB The Hosts tab in the navigation bar lists all the accepted hosts assigned to different clusters. Unaccepted hosts which are not part of any cluster appear in the events notifications bar. The Hosts can be filtered by the host name and the host role. To filter host names, enter the name of the host in the Search field at the right hand side of the hosts view interface. Figure Hosts View The Hosts view displays the following labels at a glance for individual hosts: The host name The storage utilization and system performance. The name of the assigned cluster The role of the host whether Monitor or OSD. The number of alerts Note For detailed instructions on accepting hosts, see the Accepting Hosts section of the Red Hat Storage Console 2.0 Quick Start Guide. 12

17 CHAPTER 3. CONSOLE NAVIGATION 3.4. STORAGE TAB The Storage tab in the navigation bar lists the created Object storage pools and allows the administrator to create new Object storage pools and RADOS Block Devices (RBD). The Object storage pool view is the default view after clicking on the Storage tab Object Storage Pools View Users can view the list of all object storage pools created in the Storage pools view. The configuration attributes and the metrics of each Object storage is displayed. Figure Storage Pools View For a given Object storage, the following attributes are displayed: The storage pool name along with the current status The Storage pool utilization data in donut chart format The number of configured replicas, OSDs and PGs Quotas whether enabled or disabled. Active alerts for the pool The vertical ellipsis icon for administrative actions RBD View To view the RBDs, navigate to Storage > RBDs from the console navigation bar. Figure RBD View 13

18 Red Hat Storage Console 2.0 Administration Guide Users can view a list of all RBDs created in the system in the RBDs view. The configuration summary and the metrics of each RBD is displayed. For a given individual RBD, the following summary is displayed: The RBD label and the cluster name The RBD storage size The Backing Pool name The Alerts configuration status The vertical ellipsis icon for administrative actions Note For detailed instructions on creating storage pools, see the Provisioning Storage section of the Red Hat Storage Console 2.0 Quick Start Guide. 14

19 CHAPTER 4. CLUSTER ADMINISTRATION CHAPTER 4. CLUSTER ADMINISTRATION Red Hat Storage Console provides efficient administration of Ceph clusters. The various administrative tasks available are outlined below CLUSTER DETAILS Cluster Overview To get an overview of an individual cluster, follow these steps: 1. Click on the Clusters tab from the console navigation bar. 2. In the Clusters view, click on the name of the cluster. 3. The entire cluster information is displayed in a tabbed structure with Overview being the first tab Cluster Hosts To view the hosts part of an individual cluster, follow these steps: 1. Click on the Clusters tab from the Console navigation bar. 2. In the Clusters view, click on the name of the cluster. 3. Click Hosts from the tabs. 15

20 Red Hat Storage Console 2.0 Administration Guide Cluster Pools To view the object storage pools part of an individual cluster, follow these steps: 1. Click on the Clusters tab from the Console navigation bar. 2. In the Clusters view, click on the name of the cluster. 3. Click Pools from the tabs Cluster RBDs To view the object storage pools part of an individual cluster, follow these steps: 1. Click on the Clusters tab from the Console navigation bar. 2. In the Clusters view, click on the name of the cluster. 3. Click RBDs from the tabs. 16

21 CHAPTER 4. CLUSTER ADMINISTRATION Cluster OSDs To view the OSDs part of an individual cluster, follow these steps: 1. Click on the Clusters tab in the console navigation bar. 2. In the Clusters view, click on the name of the cluster. 3. Click OSDs from the tabs Cluster Configuration Metadata To view the Ceph cluster configuration details, follow these steps: 1. Click on the Clusters tab from the console navigation bar. 2. In the Clusters view, click on the name of the cluster. 3. Click Configuration from the tabbed view. In the Configurations tab, the following information can be viewed: Ceph Cluster Configuration The general cluster settings and default values. 17

22 Red Hat Storage Console 2.0 Administration Guide Notifications The Notifications box displays the general notifications for the different events in the Console. Utilization Thresholds 18

23 CHAPTER 4. CLUSTER ADMINISTRATION The Utilization box displays the thresholds values to alert the user when there is a breach CLUSTER EXPANSION An existing cluster in the Console can be expanded by provisioning additional nodes through the expand cluster mechanism. The user can add additional Monitor or OSD nodes depending on the need. The cluster will expand automatically after adding the nodes. In order for the hosts to appear in the list of available hosts, Red Hat Storage Console agent must be installed, configured and activated in each participating Ceph Storage nodes. For instructions on configuring the Red Hat Storage Console agent, see the Installing and Configuring the Red Hat Storage Console Agent section of the Red Hat Ceph Storage Installation Guide for Red Hat Enterprise Linux available on the Red Hat Customer Portal. The following procedure outlines the steps to expand an existing cluster: Procedure. Expanding a Cluster 1. Log into Red Hat Storage Console using the default username and password as admin, at the following URL: 2. Click on the Clusters tab in the navigation bar. The list of clusters are listed. 19

24 Red Hat Storage Console 2.0 Administration Guide 3. Locate the cluster to be expanded. Click on the vertical ellipsis icon at the right hand side. A callout menu opens up. Click Expand. 4. The unaccepted hosts dialogue appears. Click View and Accept. Note The steps 4-7 are not applicable if the required hosts for cluster expansion are already accepted and initialized. 5. The list of unaccepted hosts is displayed. To accept the hosts individually, click Accept on the right of the corresponding hostnames. Alternatively, the Accept All button can be used to accept all the displayed hosts at once. 20

25 CHAPTER 4. CLUSTER ADMINISTRATION 6. The selected hosts initialize. 7. Once the hosts are initialized, a green check mark appears before the hostnames. Click Continue. 8. Select the hosts from the list of initialized hosts by checking the check-box. The role of the hosts, whether Monitor or OSD can be selected from the drop-down menu. After selecting the required hosts, click Expand Cluster. 21

26 Red Hat Storage Console 2.0 Administration Guide 9. The expand cluster request is submitted. Click Close. Note After closing the dialogue box, the Tasks page opens, displaying the progress of the cluster expansion. Alternatively, the detailed cluster expansion progress can be viewed in the Tasks page. Cluster Expansion Status To view the cluster expansion status: 1. From the Console navigation bar click Admin > Tasks. 2. The latest submitted task is displayed at the top. Locate your submitted task and click on it to display the Task metadata and the completion status CLUSTER DETACHMENT A defined cluster can be removed or detached from the Console. The detaching cluster from the Console undergoes two stages: Unmanage Cluster 22

27 CHAPTER 4. CLUSTER ADMINISTRATION The unmanage cluster action is triggered from the Cluster view page of the Console. By invoking the Unmanage action, the user intends to detach the specific cluster from the Console management. Once the cluster is unmanaged, its monitoring is disabled and no further actions can be performed on the cluster. Forget Cluster Forget cluster is the second stage to remove a cluster from the Console. Once the cluster is forgotten, it will not be viewable in the Clusters view of the Console. However, the cluster can be viewed in the Calamari API and the cluster data is archived in the Console repository. The following procedure outlines the steps to detach a cluster from the Console: Procedure: Detaching a cluster from the Console 1. Log into Red Hat Storage Console using the default username and password as admin, at the following URL: 2. Click on the Clusters tab in the navigation bar. The list of clusters are listed. 3. Locate the cluster to be unmanaged and click on the vertical ellipsis icon at the right hand side. A callout menu appears. Click Unmanage. Note The unmanage operation is triggered in the backend after clicking Unmanage. After a while, a notification pops out on the notifications bar at the top right hand corner confirming the cluster is successfully unmanaged. The cluster status icon turns from the current status to a spanner icon indicating that the cluster is unmanaged. To see the detailed cluster unmamage status, navigate to the Tasks page and locate the recent unmanage cluster task. 4. After the cluster is unmanaged, click on the vertical ellipsis icon at the right hand side. 23

28 Red Hat Storage Console 2.0 Administration Guide 5. Click Forget from the callout menu. The cluster is successfully removed from the Console. Cluster Detachment Status To view the cluster unmanage and forget status: 1. Click Tasks from the Console navigation bar. The latest submitted task is displayed at the top. 2. To view task details of Unmanage cluster, locate and click on the Unmanage Cluster task. The task box is displayed with the task metadata and the completion status. 3. To view the task details of the Forget cluster request, locate and click on the Forget Cluster task. The task box is displayed with the task metadata and the completion status. 24

29 CHAPTER 5. HOST ADMINISTRATION CHAPTER 5. HOST ADMINISTRATION 5.1. HOST METRICS The detailed individual host metrics can be viewed in the Console. To view individual host metrics, navigate to the Hosts view from the console navigation bar. In the hosts view, select the host by locating it or by searching it using the search field provided. Once the Host is located, click on the host name to view the detailed host metrics. The Individual hosts view is divided into three tabs: Overview, Configuration and OSDs. Note For a Monitor host, only Overview and Configuration tabs are available Host Overview The Overview tab is selected by default. It provides comprehensive detail of the selected host in data cards format. The viewable details are described below Host Summary The Host role - whether OSD or Monitor The operation time - shows the time elapsed in days and hours since the start The Cluster group - shows the cluster name on which the host is assigned. Utilization The host node CPU and Memory utilization is displayed in form of a donut chart. The CPU usage and Memory utilization is depicted in percentage unit. The utilization data is also depicted in the form of a sparkline chart, progressively showing the variation and the utilization over a period of time. 25

30 Red Hat Storage Console 2.0 Administration Guide In case there is no data to load, the chart will display a placeholder saying No data available like shown in the below screen: Viewing Host CPU Utilization For example, in the below donut chart, the CPU utilization percentage is given within the donut chart and highlighted by a green curve on the donut chart. Alongside, the CPU usage percentage label is shown. 26

31 CHAPTER 5. HOST ADMINISTRATION To view, the available processing power, hover the cursor anywhere on the grey area of the donut chart. A tooltip will appear showing you the available CPU in percentage unit. 27

32 Red Hat Storage Console 2.0 Administration Guide Viewing Host Memory Utilization For example, in the below donut chart, the Memory utilization percentage is highlighted in a green colored curve on the donut chart. To view the available memory, hover the cursor anywhere on the grey area of the donut chart. A tooltip will appear showing you the available memory in percentage format. 28

33 CHAPTER 5. HOST ADMINISTRATION Viewing Network Utilization The overall network utilization is depicted in the form of a donut chart, displaying the network usage in percentage unit. Additionally, the cluster network address and the Public network address is displayed with the current status. At the top right hand side of the Network utilization card, a drop-down menu allows the user to view the network utilization in the elapsed hours. By default, the past 1 hour network utilization metrics is displayed. 29

34 Red Hat Storage Console 2.0 Administration Guide Performance The overall performance is displayed in the Performance data card. A storage administrator can use the data available here as a baseline to monitor the performance of the disks in the host. The system calculates the following disk performance metrics: IOPS (Input/Output Operations Per Second) - shows the average read/writes requested on the disk Network Throughput - shows the throughput in bytes per second (B/s) Network Latency - shows the network latency in milliseconds (ms) Note The network throughput value shows the summary of read/write average in bytes compounded from all the interfaces. At the top right hand side of the Network Performance card, a drop-down menu allows the user to view the network performance metrics in the elapsed hours. By default, the past 1 hour network utilization metrics is displayed Host Configuration

35 CHAPTER 5. HOST ADMINISTRATION Host Configuration The configuration tab displays the essential network, hardware and the OS information in a tabular format Host OSDs The OSDs tab lists all the OSDs in the selected host. The OSDs can be filtered by entering the OSD name. Additionally, a sidebar is provided at the left side to filter OSDs by OSD Status, PG Status and by Utilization. To view the OSDs belonging to a particular storage profile, a Storage Profile drop-down is provided. Select the storage profile to list the OSDs part of the selected storage profile. To view the OSD summary, select the OSD from the list and the OSD summary is displayed at the right hand side of the interface. 31

36 Red Hat Storage Console 2.0 Administration Guide CHAPTER 6. STORAGE ADMINISTRATION Red Hat Storage Console allows storage administrators to efficiently manage the object storage pools and block storage devices that are part of the nodes participating in the clusters. The Storage view page provides configuration summary for each pool in the cluster and supports creation of new storage pools. Note For detailed instructions on creating storage pools, see the Provisioning Storage section of the Red Hat Storage Console 2.0 Quick Start Guide MANAGING OBJECT STORAGE POOLS The console allows administrators to perform storage specific operations such as editing and deleting storage pools Editing Object Storage Pools The following procedure outlines the steps to edit an Object Storage pool: Procedure. Editing an Object Storage Pool 1. Navigate to Storage Pools view by clicking Storage > Pools from the console navigation. 2. Locate the storage pool to be edited from the storage pools list. Click on the vertical ellipsis icon at the right hand side of the storage pool. 3. A callout menu opens up. Click Edit. 4. The individual pool view expands below exposing the editable pool attributes. The editable pool attributes exposes actions such as renaming a pool, setting the number of object replicas and tweaking the quota settings. 32

37 CHAPTER 6. STORAGE ADMINISTRATION 5. Enter the required values in the attribute fields and click the check mark icon at the right hand side of the expanded panel to save the new settings. 6. A pop-up notification appears over the notification bar at the top right hand side corner of the interface confirming the saved changes Removing Object Storage Pools The Red Hat Storage Console allows administrators to remove storage pools from the cluster. Object storage pools can be disassociated from the cluster and then removed from the console. The following procedure outlines the steps to remove an object storage pool: Procedure. Removing an Object Storage Pool 1. Navigate to Storage Pools view by clicking Storage > Pools in the console navigation. 2. Locate the storage pool from the storage pools list. Click on the vertical ellipsis icon at the right hand side of the storage pool. 3. A callout menu opens up. Click Remove. 33

38 Red Hat Storage Console 2.0 Administration Guide 4. A confirmation dialogue box appears. Click Ok to remove the selected storage pool. Object Storage Removal Status To view the object storage removal status: 1. Navigate to the Admin tab at the left hand side of the Red Hat Storage Console interface and click Tasks. 2. The latest submitted task is displayed at the top. Locate your submitted task and click on it. 3. The completion status is displayed MANAGING RBDS 34

39 CHAPTER 6. STORAGE ADMINISTRATION The configured RBDs that are part of clusters in the console can be reconfigured and re provisioned to the clusters. Additionally, RBDs can be dissociated and removed from a pool Resizing RBD The following procedure outlines the steps to resize a RBD: Procedure. Resizing a RBD 1. Navigate to RBD view by clicking Storage > RBDs from the console navigation. 2. The RBD view is displayed. Locate the RBD to be resized from the list. 3. Click on the vertical ellipsis icon at the right hand side of the RBD. 4. A callout menu opens up. Click Resize. 5. The individual RBD view expands below. The resizable attribute available is Target Size. 6. Enter the required storage size and select the storage capacity unit from the drop-down menu. Click Save. 35

40 Red Hat Storage Console 2.0 Administration Guide A pop-up notification appears over the events sidebar at the top right hand side corner of the console confirming the saved changes Removing RBD The following procedure outlines the steps to remove a RBD: Procedure. Removing a RBD 1. Navigate to RBD view by clicking Storage > RBDs from the console navigation bar. 2. The RBD view is displayed. Locate the RBD to be removed from the list. 3. Click on the vertical ellipsis icon at the right hand side of the RBD. 4. A callout menu opens up. Click Remove. 5. A confirmation dialogue box appears. Click Ok to remove the RBD. 36

41 CHAPTER 6. STORAGE ADMINISTRATION RBD Removal Status To view the RBD removal status: 1. Navigate to the Admin tab at the left hand side of the Red Hat Storage Console interface and click Tasks. 2. The latest submitted task is displayed at the top. Locate your submitted task and click on it. 3. The completion status is displayed. 37

42 Red Hat Storage Console 2.0 Administration Guide CHAPTER 7. USER ADMINISTRATION Red Hat Storage Console provides efficient and user-friendly way of managing console users. The console provides user administrative tasks such as adding, editing and deleting a console user. The console also allows user management and authentication through directory services such as Lightweight Directory Access Protocol (LDAP) and Active Directory (AD) ADMINISTERING USERS Adding User To add a new user, in the Console navigation bar, click Admin > Users. The list of created users is displayed in the user view. If there are no prior users created, only the default admin user is listed. The following procedure outlines the steps to add a new user: Procedure: Adding a New User 1. On the right hand side, click Add User button highlighted in blue. 2. Enter the user credentials: User ID, the First Name and Last Name, the address and the Password. Click Save. 38

43 CHAPTER 7. USER ADMINISTRATION Note To enable events and alerts notifications via , check the check-box for Notifications 3. The new user is added successfully Editing User To edit an existing user: 1. Navigate to the user view by clicking Admin > Users from the console navigation. 2. Locate the user to be edited and click Actions at the right hand side. 3. From the callout menu, click Edit user. 4. The user editing interface is opened. The editable attributes are the address and the password. 39

44 Red Hat Storage Console 2.0 Administration Guide 5. Click Save after the editing is complete Enable and Disable User The console user operations can be enabled and disabled in the User view of the console. To disable a created user, perform these steps: 1. In the User view, locate the user to be disabled and click Actions at the right hand side of the user row. 2. From the callout menu, click Disable user. 3. The status icon for the user turns X indicating that the user is disabled. 40

45 CHAPTER 7. USER ADMINISTRATION 4. To enable the user for console operations, from the callout menu, click Enable user. 5. The status icon for the user turns from X to a green check mark indicating that the user is enabled Enable and Disable Notifications notifications for console alerts can be enabled and disabled for a console user. Note For mail server configuration instructions, see the Mail Server Configuration section of this guide. To enable notifications perform the following steps: 1. In the User view, locate the user and click Actions at the right hand side. 2. From the callout menu, click Enable Notification. 41

46 Red Hat Storage Console 2.0 Administration Guide 3. The icon in the notification attribute for the user changes from X to a green check mark. 4. To disable the notifications, from the callout menu, click Disable Notification. 5. The icon in the notification column attribute for the user changes from green check mark to X Deleting User The users created for console operations can be deleted from the console. To delete a user, in the User view, locate the user to be deleted and click Actions > Delete user. 42

47 CHAPTER 7. USER ADMINISTRATION 7.2. USER AUTHENTICATION AND MAIL SERVER CONFIGURATION LDAP and AD Configuration Before configuring the LDAP/AD, perform the following steps: 1. Stop the skyring service by executing the following command: # systemctl stop skyring 2. Change the variable providername: localauthprovider to providername: ldapauthprovider in the following file: /etc/skyring/skyring.conf 3. Start the skyring service by executing the following command: # systemctl start skyring After the above steps are performed, the LDAP/AD settings can be configured in the console. The following example procedure outlines the steps to configure the LDAP/AD in the console: Procedure. Configuring LDAP Example 1. Navigate to the LDAP/AD settings page by clicking Admin > LDAP/AD Settings. 2. The LDAP configuration input fields are displayed. Select the authentication method, whether AD or LDAP. For this instance, LDAP is selected. 43

48 Red Hat Storage Console 2.0 Administration Guide 3. Enter the following information in the input fields: LDAP/AD Host: The LDAP server address Port: The port number Base Path Name: The base path to search accounts Bind Account: The LDAP Admin account Bind Password: The LDAP Admin account password 4. After entering the details, click Save. 44

49 CHAPTER 7. USER ADMINISTRATION 5. The configuration is saved successfully. Note Perform the same set of instructions for configuring AD by selecting the AD radio button Adding LDAP/AD User After LDAP/AD is successfully configured, a new LDAP/AD user can be added. The following procedure outlines the steps to add a new LDAP user: Procedure. Adding LDAP User 1. Navigate to the User view by clicking Admin > Users from the console navigation bar. 2. The Console users list is displayed. Click Add LDAP/AD User at the right hand side of the User view. 3. Enter the User ID in the Name or User ID input field and click Search. 45

50 Red Hat Storage Console 2.0 Administration Guide Note In Red Hat Storage Console 2.0, users can search for LDAP accounts only by using the User ID search parameter. 4. The system will search for existing users from the configured LDAP directory. Locate the user and click Import. 5. The User is successfully added to the console MongoDB database Mail Server Configuration Configure a mail server to send notifications to registered console users. The mail server will send notifications to users about state changes and any threshold breaches. To receive notifications, register a valid address. Note An SMTP server without SSL/TLS encryption can be configured only through Console API. The following example procedure outlines the steps to configure mailing server in the console: Procedure. Configuring Mail Server 1. Navigate to the mail settings page by clicking Admin > Mail Settings. 2. The LDAP configuration input fields are displayed. Enable notifications by checking the Notifications check box. Upon checking the check box, it changes to Enabled. 46

51 CHAPTER 7. USER ADMINISTRATION 3. Enter the following settings in the input fields: Outgoing Mail Server SMTP Address: The SMTP server address Port: The port number of the SMTP server depending on the encryption type selected Note The port number depends on the type of encryption selected. For SSL encryption, the port number is 465 and for TLS encryption, the port number is 587 User Name: The valid address to be registered with the mail server Password: The valid password of the account to be registered From: The valid address to be registered with the mail server Subject Prefix: The incoming subject prefix. 4. Validate the settings by testing it using the test process. Enter a test address in the Test Message Recipient input field. In order to determine that the settings entered are correct, click TEST. 47

52 Red Hat Storage Console 2.0 Administration Guide 5. If the entered settings are correct and the test is successful, a sample test is received by the test address from the registered address. Click Save to save the notification configuration. 48

53 CHAPTER 8. TASK MANAGEMENT CHAPTER 8. TASK MANAGEMENT Red Hat Storage Console consists of sizeable number of user initiated actions to accomplish operations such as creating clusters, creation of new storage pools, and importing cluster to name a few. It is crucial for the administrators or the users to monitor and view the status of the actions they initiated in a visual data format. The benefit of providing an advance monitoring mechanism of the initiated actions is to remedy any failed operation by analysing the execution steps and actuate troubleshooting. Red Hat Storage Console offers an advanced and intuitive task monitoring mechanism for each significant action initiated in the console by the user. A storage administrator can view and perform the following actions in the console: The status of an initiated task whether successful or failed The details of all past and present cluster-wide initiated actions The timestamp of the initiated task with the unique task ID Retrieve a specific task by adding available filters 8.1. TASK LIST To view the tasks list in the console: 1. Log into Red Hat Storage Console using the user login credentials. 2. From the navigate bar, navigate to Admin > Tasks. 3. The console wide initiated tasks are displayed in a page view with the most recent task at the top TASK FILTERING Task filtering makes it easy to retrieve a specific initiated task. A specific task can be retrieved by applying the available filters: The task name, the period between which the task was initiated and the status check boxes. Task Filtering Example 49

54 Red Hat Storage Console 2.0 Administration Guide For example, an administrator wants to retrieve all the successful tasks initiated for creating a storage block device in the console. The following procedure will help the administrator to retrieve the required tasks: 1. Navigate to the Tasks view by clicking Admin > Tasks from the console navigation. The Tasks view is displayed. 2. At the top of the page, the filtering widgets are available. Enter the keyword block device in the first search field. Note As the individual filters are applied, they are reflected in the Active Filters field in the form of labels. 3. Set the search period from the calendar widget. For this example, the start date is set as Fri July :00 Hours and the end date is set as Sun July :55 Hours. 4. Select the task status as Completed from the check box options. All the applied filter labels appear in the Active filters field with the number of retrieved results. 50

55 CHAPTER 8. TASK MANAGEMENT 5. Once all the necessary filters are applied, the system retrieves all the tasks related to block devices and displays the list. Note At any point of time, to remove an applied filter, click x on the filer labels. In order to clear all the applied filters, click Clear All Filters. Note A task cannot be paused, resumed or deleted from the console. All created tasks remains in the console history for an indefinite period. Task Details 1. The individual task detail for an initiated operation can be viewed by clicking on the Task name in the Tasks view. The task detail page displays the following information: Task Name: The name of the initiated operation Task ID: The unique task ID generated by the system Time Submitted: The time and date when the task was initiated Status: Progressive execution steps with status whether failed or success. 51

56 Red Hat Storage Console 2.0 Administration Guide CHAPTER 9. EVENT MANAGEMENT The Events management system in Red Hat Storage Console provides comprehensive information of all the events raised by the console. An Event is a record of a voluntary action carried out by a console user or any action triggered by the system. Events can be informative in nature such as user login records, creating and deleting a console user, configuring LDAP user and other similar administrative actions. Non-informative events are events related to critical system warnings and console health status to name a few. An Alert is a visual notification to draw the attention of a user to a single event or multiple events triggered by the console. The Events management system provides the following notifications and visual data to the user: Notifies the administrator of any critical event occurred in the console Provides summary of all severe and critical events occurred in the console Provides detailed information and an event Provides a comprehensive list of all active and dismissed events. Provides advanced event search filters based on filter inputs such as hostname and cluster name, time-period range and severity level EVENTS VIEW To view the Events generated in the console, follow these steps: 1. Log into Red Hat Storage Console using the user credentials. 2. From the navigate pane, navigate to Admin > Events. 3. The console wide triggered alerts are displayed in a page view with the most recent event at the top EVENTS FILTERING Events filtering makes it convenient to retrieve a specific event occurred in the console. A specific event can be retrieved by applying the available filters: The Object, the time period between which the task was initiated and the status check boxes - Active, Dismissed and All. 52

57 CHAPTER 9. EVENT MANAGEMENT Active events are events which are raised in the console but are not yet acknowledged by the user. Whereas, Dismissed events are events which are acknowledged by the user and is dismissed manually. Note Non-informative Events are dismissed manually by voluntary user action and also automatically by the system if it detects a corresponding event generated. Event Filtering Example For example, an administrator wants to retrieve all the events generated by the system related to user settings. The following filtering procedure will help the administrator to retrieve the needed events: 1. Navigate to the Events view by clicking Admin > Events from the console navigation bar. The Events view is displayed. 2. At the top of the page, the events filtering options are given. In the first filtering option, select the search criteria as Description from the drop-down and enter user setting in the search input field. 3. Set the search time period from the calendar widget. For this example, the From date is set as Fri July :00 Hours and the To date is set as Tue July :55 Hours. 4. Select the type of events from the available options: Active, Dismissed and All. By default, the Active type is selected. 5. All the applied filter labels appear in the Active filters field with the number of retrieved events. 6. The system retrieves all the events matching the applied filters and displays the list. 53

58 Red Hat Storage Console 2.0 Administration Guide Note At any point of time, to remove an applied filter, click x on the filer labels. In order to clear all the applied filters, click Clear All Filters DISMISSING EVENTS For example, to dismiss a warning event, follow these steps: 1. In the Events view, click on the warning icon in the Active filters row. 2. The Active filter is applied as severity: warning and the events matching the severity levels are retrieved. 3. Click Details at the right hand side to take you to the event detail page. 54

59 CHAPTER 9. EVENT MANAGEMENT 4. Enter an appropriate comment in the comments field and click Dismiss. 5. The event is successfully dismissed and can be retrieved by checking the Dismissed status checkbox. Alternatively, the events icon in the Notifications Menu Bar can also be used to direct the user to the event dismissal page. 55

60 Red Hat Storage Console 2.0 Administration Guide After the events are dismissed, they will no longer appear in the Notifications Menu Bar. 56

61 CHAPTER 10. NOTIFICATIONS AND SHORTCUTS MENUBAR CHAPTER 10. NOTIFICATIONS AND SHORTCUTS MENUBAR The Notifications and Shortcuts menubar is a utility embedded in the Red Hat Storage Console to issue visual alerts to notify the user of any critical events occurring in the console. Figure Notifications and Shortcuts Menubar Additionally, Notifications and Shortcuts menubar also provides previews and shortcuts to the following console related operations, starting from left to right: Events Preview Discovered Hosts Preview Tasks Preview About Version User Signout EVENTS PREVIEW AND SHORTCUT The Events preview and shortcut option displays a summary of all new and unread alerts. To view the alerts summary, click on the events icon on the menubar. A drop-down menu is opened displaying all the non-informative events. Figure Events Preview 57

62 Red Hat Storage Console 2.0 Administration Guide Click on a specific event and you will be redirected to the Events page where you can view and dismiss the event DISCOVERED HOSTS SHORTCUT The discovered hosts shortcut option displays a numerical alert of the number of discovered hosts by the console. To redirect to the View and Accept Hosts page, click on the Discovered Hosts icon. Figure Discovered Hosts Shortcut 58

63 CHAPTER 10. NOTIFICATIONS AND SHORTCUTS MENUBAR TASKS PREVIEW AND SHORTCUT To view the tasks that are in progress, click on the tasks icon from the menubar. To view the Task view, click on See All and you will be redirected to the Tasks view of the console. Figure Tasks Preview and Shortcut 59

64 Red Hat Storage Console 2.0 Administration Guide CONSOLE VERSION The About icon on the sidebar displays the version information of the Red Hat Storage Console, the storage provider, the Graphite-web and the MongoDB database. To view the version information, click on the About icon and a modal About box is opened. Figure Console Version 60

65 CHAPTER 10. NOTIFICATIONS AND SHORTCUTS MENUBAR USER SIGNOUT The user can sign out and change the user password using this option. To signout from the console: 1. Click on the user icon from the menu bar. 2. Click the green signout button. Figure User Signout To change the user password: 1. Click on the user icon from the menu bar. 2. Click change password. Figure Change Password 61

66 Red Hat Storage Console 2.0 Administration Guide 3. A dialog window is opened. Enter the new password twice and click Save. 62

67 CHAPTER 11. CONSOLE JOURNAL MAPPING CHAPTER 11. CONSOLE JOURNAL MAPPING In Red Hat Ceph Storage, when you create a OSD, you also need to create its Journal, which is where data is initially written before it is flushed to an OSD. Each OSD needs a Journal which is on a different disk than the OSD. The OSD to journal mapping in Red Hat Storage Console happens automatically based on various aspects such as the type of the disk whether SSD or rotational and the available size on the disks. This section describes the logic involved within Red Hat Storage Console for mapping journal disks. This will help storage administrators to map their knowledge with the output from Red Hat Storage Console during creating OSDs for clusters CONSOLE JOURNAL MAPPING MECHANISM The Journal mapping mechanism is based on a simple algorithm that maps disks with lower storage capacity as journals for disks with higher storage capacity. The selection of journals is not random. To achieve this, the algorithm first sorts the list of disks based on size in descending order and then starts the mapping of disks with their journal. The logic used for journal mapping is listed below: Disks with higher storage capacity is preferred to be used as a data disk. Whereas, disks with lower storage capacity is used as Journal disks. Mapping of data disks to their journal disk happens at per node basis. So a disk cannot have its journal disk on a separate node. In the case wherein all the disks are rotational in nature, a disk can serve as a journal for only one disk. In the case wherein all the disks are SSDs, one SSD can be used as a journal for a maximum of 4 disks. In the case wherein there are rotational and SSD disks both available on the node, the SSDs are given preference to be used as a journal. Also, one SSD can work as journal for a maximum of 4 disks as long as space is available. In this case, the disks are mapped to SSDs to be used as journal and is continued till the capacity is full or till the number of mapped disks reaches four. If a SSD already reaches the limit, the next SSD is used for journal mapping. In the case wherein all the rotational disks are exhausted with only SSDs left, SSDs tries to use journals among themselves and within them smaller ones would be used as journals. To achieve this, the SSD disks are sorted in their descending order of size and then this logic is applied to map the data disks to the journal disks. 63

68 Red Hat Storage Console 2.0 Administration Guide CHAPTER 12. TROUBLESHOOTING This Troubleshooting section is intended for users who are responsible for maintaining, administering, or supporting Red Hat Storage Console environment. There could be various reasons for a cluster creation operation to fail in the console. Few reasons that may cause cluster creation to fail at different stages are but not limited to: Incorrect storage nodes configuration Storage nodes not bootstrapped well with ceph-installer. Raw disks added to the storage nodes This section endeavors to list few commonly faced failure scenarios and the troubleshooting methods. About MongoDB Database Red Hat Storage Console 2.0 uses MongoDB as its database to store and maintain the configuration and entities detail under the database named skyring. Under the skyring database, there is a collection table called storage_nodes from where the specific records can be removed. The following commands are used with MongoDB: 1. To open MongoDB shell: mongo :27017/skyring -u admin -p <passwd> Note User authentication is enabled for MongoDB databass with the default user name as admin. Locate the password in the /etc/skyring/skyring.conf file. 2. To switch database to skyring: use skyring 3. To list all the collections(tables): show collections 4. To list all the contents of the storage_nodes collection(table): db.storage_nodes.find() 5. To remove a specific record: db.storage_nodes.remove({"hostname": "<FQDN of the node>"}) TROUBLESHOOTING NODES CONFIGURATION 64