Ops Director Guide — Chapter 7

Roles Tab

The ROLES tab lists the available roles.The columns displayed for a role are described in the following table.

You may export data from the ROLES tab as a CSV (Comma Separated Values) file by clicking the Export icon in the upper right corner. The following rules apply:

• The resulting CSV file will have the same columns as the Roles table in the UI.
• All available columns are exported, regardless of whether they are visible or hidden in the UI.
• All records that satisfy the set filter parameters are exported.
• Data types of the fields in the CSV file correspond to those in the UI. In case of boolean values, Yes/No in the UI corresponds to TRUE/FALSE in the CSV file.

You may then import the CSV file into other applications (such As Excel) for further processing or analysis.

Resource Access Tab

The RESOURCE ACCESS tab lists the resource groups and their assigned roles. The columns displayed are described in the following table.

You may export data from the Resource Access tab as a CSV (Comma Separated Values) file by clicking the Export icon in the upper right corner. The following rules apply:

• The resulting CSV file will have the same columns as the Resource Access table in the UI.
• All available columns are exported, regardless of whether they are visible or hidden in the UI.
• All records that satisfy the set filter parameters are exported.
• Data types of the fields in the CSV file correspond to those in the UI. In case of boolean values, Yes/No in the UI corresponds to TRUE/FALSE in the CSV file.

You may then import the CSV file into other applications (such as Excel) for further processing or analysis.

Creating a Resource Group and Assigning it to a Role

The following procedure creates a Resource Group that represents all of the hosts in the Managed Clusters and then restricts access to monitor those hosts to only users with the opsdir-user role.

1. In Ops Director, select the CONSOLE SETTINGS view.
2. Select Resource Group in the left menu.
3. In the right pane, click CREATE GROUP.

   

4. In the CREATE GROUP dialog box, enter the Group Name, Description, and select Host from the Resource Type menu.

   

5. After creating the group, select the group. In the Resource Groups page for the selected group, scroll down to the Total Resources section (which will likely be out of sight until you scroll down) and select the check boxes to the left of each host in the cluster that you want to belong to this group.

   

6. Click ASSIGN to assign the selected resources to the group.

   

7. The Resource Group lists the assigned resources.

   

8. In the left menu, select Roles from under RBAC Settings.

   

9. In the ROLES tab, select CREATE ROLE.

   

10. In the Create Role dialog box, enter the Role Name (HostAccess, in this example) and Description. Select opsdir-user from the Sub-Roles menu.

    

    Select Hosts from the Resource Scope menu. Click ok.

    

Editing or Deleting a Role

To edit or delete a role, click the Action icon next to that role and select the desired action.

To delete multiple roles, select the checkboxes next to all roles you want to delete, then select Delete All Selected Roles in the ACTIONS menu.

The Delete All Selected Roles option is enabled when at least one role is selected.

Creating a Resource Group

Do the following to create a Resource Group.

1. Click CREATE GROUP.
2. In the pop-up window, enter a Group Name, select a Resource Type (Host, Database, Appserver, or Cluster), and enter a description for the resource group.

   

3. Click Save. The new Resource Group is added to the list of Resource Groups.
4. By default, no resources are included in the Resource Group. To include resources, click on the name of the newly created Resource Group.

   

5. Scroll down to the Total Resources section and select the resource to be included in the Resource Group. This view will differ for each type of Resource Group as described in Resource Group Views.

   

   By default, you can view 10 resources per page. You can adjust how many resources to view in the Resource Group page by changing the number in the menu at the bottom of the page.

   

6. When you have finished selecting resources for the Resource Group, click ASSIGN at the bottom of the page.

   

Editing or Deleting a Resource Group

To edit or delete a resource group, click the Action icon next to that resource group and select the desired action.

To delete multiple resource groups, mark checkboxes next to all resource groups you want to delete and select Delete All Selected Groups in the Actions menu.

The Delete All Selected Groups option is enabled when at least one resource group is selected.

Resource Group Views

Click on a resource group to display the assigned and unassigned resources, as well as assign and deassign resources. The contents of each type of resource group are described in the following sections:

• Host Groups
• Database Groups
• App Server Groups
• Cluster Groups

License Information By Host

Select a specific MarkLogic License Edition to view details, broken down by host or by license edition, such as cluster name, group membership, processor architecture, and the number of CPUs, cores, and running threads.

The displayed columns are described in the following table.

You may export data from the License Information by Host tab as a CSV (Comma Separated Values) file by clicking the Export icon in the upper right corner. The following rules apply:

• The resulting CSV file will have the same columns as the License Information by Host table in the UI.
• All available columns are exported, regardless of whether they are visible or hidden in the UI.
• All records that satisfy the set filter parameters are exported.
• Data types of the fields in the CSV file correspond to those in the UI. In case of boolean values, Yes/No in the UI corresponds to TRUE/FALSE in the CSV file.

You may then import the CSV file into other applications (such as Excel) for further processing or analysis.

License Information By License

Click the By License tab to view the license information by license key.

The displayed columns are described in the following table.

You may export data from the License Information by License tab as a CSV (Comma Separated Values) file by clicking the Export icon in the upper right corner. The following rules apply:

• The resulting CSV file will have the same columns as the License Information by License table in the UI.
• All available columns are exported, regardless of whether they are visible or hidden in the UI.
• All records that satisfy the set filter parameters are exported.
• Data types of the fields in the CSV file correspond to those in the UI. In case of boolean values, Yes/No in the UI corresponds to TRUE/FALSE in the CSV file.

You may then import the CSV file into other applications (such as Excel) for further processing or analysis.

Viewing and Filtering the List of Managed Clusters

Use the Managed Clusters page to view the list of all clusters currently managed by Ops Director, along with their health status.

The columns displayed in the Managed Clusters tab are described in the following table.

You may export data from the Managed Clusters tab as a CSV (Comma Separated Values) file by clicking the Export icon in the upper right corner. The following rules apply:

• The resulting CSV file will have the same columns as the Managed Clusters table in the UI.
• All available columns are exported, regardless of whether they are visible or hidden in the UI.
• All records that satisfy the set filter parameters are exported.
• Data types of the fields in the CSV file correspond to those in the UI. In case of boolean values, Yes/No in the UI corresponds to TRUE/FALSE in the CSV file.

You may then import the CSV file into other applications (such as Excel) for further processing or analysis.

A managed cluster may become disconnected from the Ops Director, either due to temporary network unavailability or because MarkLogic Server had stopped on the hosts comprising the cluster. In this case, the cluster's state cannot be determined by Ops Director, and hence the cluster is assigned the Unknown state.

For additional reasons why a managed cluster might be assigned the Unknown state, see Security and Database Dependencies of Managed Clusters.

You may filter the list of the managed clusters to view only those clusters that are currently in the Unknown state by selecting the Show only unknown checkbox.

Removing Unknown Managed Clusters from the List

You may remove a managed cluster that is currently in the Unknown state from the list of clusters managed by Ops Director. Perform the following steps:

1. Click REMOVE to the right of the cluster you want to remove from the list.

   

   The Remove button is enabled only for clusters that are currently in the Unknown state.

2. A confirmation box appears asking Do you wish to remove this cluster from the list of clusters managed by this instance of Ops Director? Click YES.

   

3. The cluster is removed, and the updated list of managed clusters is displayed by Ops Director.

   

Reconnecting a Managed Cluster to Ops Director

If you removed a cluster from the list of clusters managed by Ops Director, you may want to reconnect this cluster later on, such as when the issue that caused the Unknown state is resolved.

To add the cluster back to the list of clusters managed by Ops Director from the Admin Interface, perform the following steps:

1. Log into the Admin Interface on the cluster to be managed by Ops Director.
2. In the left menu, select Configure > Clusters.
3. Select the local cluster. The Edit Local Cluster Configuration page appears.
4. Select the Ops Director tab at the top of the page.
5. The Ops Director Setup page is displayed. Select stop managing this cluster.

   

   When you remove the cluster from the list of managed clusters in Ops Director, the cluster is not notified that it is no longer managed, because the connection between the cluster and the Ops Director is down at that point. Therefore, you must first update the cluster state by selecting stop managing this cluster from the Admin Interface.

6. On the Stop Managing this Cluster page, make sure the box to the left of Remove Ops Director Certificate Authority box is unchecked, then click ok.

   

   You may stop managing and start managing a cluster without re-importing a certificate to it, in case the cluster will be managed by the same instance of Ops Director.

7. The Server Restart page is displyed.The page informs you that MarkLogic Server is being restarted to load new Ops Director status configuration.

   

8. When the restart is completed, the Ops Director Setup page is displayed again. Select manage this cluster.

   

9. The Configure as a Managed Cluster page is displayed.
   • Enter the name of the host where your Ops Director application runs.
   • From the Ops Director Certificate Authority menu, select MarkLogic Ops Director Certificate Authority.

     You may optionally modify the level for log messages sent to Ops Director, as well as the frequency at which the metering data is collected.

     Click ok.

     

10. In Ops Director, select the CONSOLE SETTINGS tab. In the left menu under CONNECTIVITY, select Managed Clusters.

    Refresh the page. The updated list of managed clusters is displayed, with the newly reconnected cluster among them.

Setting Up Email Notifications

To set up Ops Director to notify you by email when a specific type of event occurs:

1. Make sure you have set up your SMTP relay. In the Admin Interface, navigate to Configure > Groups > Default. In the right pane, select the Configure tab. Make sure the smtp relay field contains the correct name and port of the SMTP relay host. If it needs to be changed, make sure to click ok at the bottom of the pane to save your changes.

   

2. Log into the XQuery console (port 8000) and submit the following query to update the From email address against the database OpsDirector and the server OpsDirectorApplication, replacing Test User and test-xdmp-email@marklogic.com with the name and email address from which the alerts are to come:

   xquery version "1.0-ml"; import module namespace cfg="http://marklogic.com/v1/opsdirector/config"     at "/common/config.xqy"; cfg:set-atomic-property("email-return-name", "Test User"), cfg:set-atomic-property("email-return-address", "test-xdmp-email@marklogic.com")

3. In the Ops Director interface, select CONSOLE SETTINGS. In the left menu, select Email Configuration. The Email Configuration page displays in the right pane.

   

4. Enter the Login and Password credentials for the the SMTP relay server configured in the Admin UI in step 1. Click SAVE to save the credentials.
5. To make sure the Ops Director email server is working correctly, click SEND TEST EMAIL. The SEND TEST EMAIL box displays.

   

6. Enter an email address to receive the test message and click OK. You will receive a test email message similar to the following:

   

To remove the account from Ops Director, click DELETE.

Setting up and Managing Alerts

The Alert Management page enables you to determine when email alerts are sent. To display the Alert Management page in the right pane, in the left menu, select Alert Management.