Driven Administrator Guide: Using the Driven Admin Features

version 2.2.6

Driven Administrator Guide: Using the Driven Admin Features

1. Prerequisite

1.1. Upgrading

1.2. Check your team’s demands and expectations

1.3. Check your hardware and software

2. Planning a Driven Deployment

2.1. Understanding the Deployment Architecture

2.2. External Dependencies

2.3. Selecting a Deployment Topology

3. Installing and Configuring the Driven Server

3.1. Downloading the Driven Server

3.2. Installing the Driven Server

3.3. Configuring the Driven Server

4. Starting and Stopping the Driven Server

4.1. Starting the Driven Server

4.2. Stopping the Driven Server

5. Uninstalling the Driven Server

5.1. Stopping the Server

5.2. Removing All Files and Data

6. Using the Driven Admin Features

6.1. Manage Users

6.2. Managing A Single User

6.3. Manage Teams

6.4. Manage System

7. The Driven Command Line Client

7.1. Installing the Driven CLI Client

7.2. Backing Up and Restoring Driven Repositories

7.3. Backing Up Your Driven Data

7.4. Extracting Data with the scope Command

7.5. Examples of Command Usage

7.6. Common Command-Line Options

7.7. How-To Tips

8. Integrating with Third-Party Monitoring Applications

8.1. Using Java Management Extensions (JMX) with Driven

8.2. Using Nagios Plugins with Driven

9. Upgrading Driven Server

9.1. Before WAR Replacement

9.2. Upgrade the Driven Server

10. Troubleshooting Driven

10.1. The Driven Server installation generates a Java incompatibility error

10.2. Can not install a valid license

10.3. Transmission of application metrics data to Driven stops but app status remains in RUNNING state

Using the Driven Admin Features

If you are logged in to Driven with administrator (admin) privileges, you can access the Driven Admin Features to perform the following tasks:

  • Manage Users

    • Driven Environment Notifications

    • Adding User(s)

    • Deleting User(s)

    • Disable/Re-enabling User(s)

  • Managing A Single User

    • Update username and email

    • Change admin privileges

    • View and modify team membership

  • Manage Teams

    • Create Team

    • Delete Team(s)

  • Managing A Single Team

    • Team Info

    • Application data searchable and displayed in app views; Discoverability

    • Application Execution Detail Access; Visibility

    • Members

    • Invitations

    • Issue Tracking

    • Webhook Connections and Email Notifications

    • Messaging Rules

  • Manage System

    • Driven License Information

    • Cluster Statistics

    • Node Statistics

    • Elasticsearch Summary

    • Backup and Snapshot Repositories

You can view the Driven Admin Features by hovering over the gear icon in the right side of the Global Navigation. Clicking on the options will bring you to their respective page.

admin options
Figure 1. Driven Admin Features menu

Manage Users

  • Driven Environment Notifications

  • Adding User(s)

    • Creating A Single User

    • Creating Multiple Users

      • CSV Column Headers

      • Duplicate Username

      • Review Users/ Set Admin permission

    • Add New User(s) to Team(s)

  • Deleting User(s)

  • Disable/Re-enabling User(s)

  • Managing A Single User

Click the Manage Users option to view all Driven users, create one or many users, disable/enable, or delete Driven user accounts.

manage users
Figure 2. The Manage Users page to manage Driven user accounts

Driven Environment Notifications

On the Manage Users page, if SMTP (Simple Mail Transfer Protocol) is disabled on your server, the "SMTP Disabled" notification will be surfaced, and you cannot bulk add users via a CSV file.

On individual User Profile pages, you cannot reset user passwords.

Please refer to Enabling SMTP to learn more about SMTP within Driven.

smtp disabled
Figure 3. SMTP Disabled Notifier

On the Manage Users page, if Driven is configured with LDAP enabled, the "LDAP Enabled" notification will be surfaced. Any LDAP users will have the "External" icon next to their name.

Please refer to LDAP Integration to learn more about LDAP within Driven.

manage users ldap enabled
Figure 4. LDAP Enabled Notifier
external icon
Figure 5. External User Icon

Adding User(s)

Click the "Add Users" button in the top right of the Manage Users page to add one or more users to Driven.

add users
Figure 6. Add User Button
Creating A Single User
add single user
Figure 7. Add Single User

To add a single User to Driven, complete the fields of

  • Username (required) Usernames must be unique to Driven, and are case sensitive - i.e. "Admin" and "admin" would be 2 different valid usernames)

  • email address (required) Generated passwords and notification will be sent from driven to this email if SMTP is configured.

  • Driven Admin? checkbox (optional) Checking this box will make the new user a full admin with access to the full admin console.

The new user will be emailed Driven login information.

If SMTP is disabled, you must enter an initial password for the user, and communicate the login information to them outside of Driven. The user will be prompted to change it upon first login.

add single user error
Figure 8. Username in use notification

Click "Next" in the bottom right of the modal to add the new user to a team(s). Skip the following section and go directly to the subsection "Add New User(s) to Team(s)."

Creating Multiple Users

If SMTP is enabled, you can upload users via a CSV file. If column names are provided, the upload wizard looks for columns for name (either "First Name" AND "Last Name", OR "Full Name") and email ("Email").

add users upload
Figure 9. Upload CSV Button

If column headers are not present, you will be asked to help Driven map the columns.

add users noheaders
Figure 10. Upload wizard - prompt when no valid column headers are found

If usernames are duplicated (either within your CSV or with existing Driven users), you will be prompted to modify the username. Click on the username, edit the username inline, and click the green checkbox to submit.

add users names exist
Figure 11. Upload wizard - prompt when desired usernames already exist

Once all of your usernames have been verified, you will be asked to choose if you would like to grant Admin permission to any of the new users.

add users review
Figure 12. Upload wizard - review and grant Admin permission

You are now ready to add the new users to one or more teams. When uploading via CSV, all the of the uploaded users must be added to the same team(s).

Add New User(s) to Team(s)

Choose the team(s) that you would like to add the new user(s) to, and click Submit.

add users choose teams
Figure 13. Upload wizard - Choose team(s) for the new user(s)

The new user(s) will be added to Driven, and can be seen in the Manage Users table.

Deleting User(s)

Deleting a User from Driven will remove them from any team they are a member of, but will not delete any Saved Views they have shared.

To Delete a user from Driven, select the desired user(s) from the Manage Users table, and click the "Delete User(s)" button. You will be prompted to confirm the user(s) you wish to delete.

manage users delete table
Figure 14. Choose user(s) to delete
manage users delete confirm
Figure 15. Confirm user(s) to delete

Disable/Re-enabling User(s)

Disabling a user in Driven only prevents them from logging in. All other user data is retained.

To Disable/Re-enable a user from Driven, select the desired user(s) from the Manage Users table, and click the "Disable/Re-enable User(s)" button. You will be prompted to confirm the user(s) you wish to disable/re-enable.

manage users disable table
Figure 16. Choose user(s) to disable/re-enable
manage users disable confirm
Figure 17. Confirm user(s) to disable/re-enable

Managing A Single User

Note
 For an explanation of managing a single user, please go to the User Profiles page, see User Profile in the Driven User Guide.

Manage Teams

  • Create Team

  • Delete Team(s)

  • Managing A Single Team

Click the Manage Teams option to view all teams, create a new team, or delete team(s). From the Manage Teams page, you can see how many members and applications are associated with a team. As well as the chronological history of member and application associations with their respective teams.

manage teams
Figure 18. Manage Teams

Create A Team

Click the "Create" button in the top right of the Manage Teams page to create a new team in Driven.

create team
Figure 19. Add User Button

Enter the name of the new team you would like to create.

Note
 Two or more teams can have the same name.
create team prompt
Figure 20. Add User Button

The new team will be added to Driven, and can be seen in the Manage Teams table.

Delete Team(s)

Deleting a Team from Driven does not delete the team’s application data from Driven, but does does delete the team’s API Key, removes the members from the team (but does not delete the members), and deletes any associated Invitations, Issue Tracking links, Webhook Connections and Email Notifications, and Messaging Rules. The team’s Discoverability and Visibility settings will continued to be honored.

Note
 For a more in-depth explanation of team functionality in Driven, see Configuring Teams for Collaboration in the Driven User Guide. The user guide information also explains how users without administrator privileges can create and set up teams.

To Delete a team from Driven, select the desired team(s) from the Manage Teams table, and click the "Delete Team(s)" button. You will be prompted to confirm the team(s) you wish to delete.

manage teams delete table
Figure 21. Choose team(s) to delete
manage teams delete confirm
Figure 22. Confirm team(s) to delete

Managing A Single Team

Note
 For an explanation of managing a single team, please go to the Team Details page, see Configuring Teams for Collaboration in the Driven User Guide. The user guide information also explains how users without administrator privileges can create and set up teams.

Manage System

  • Driven License Information

  • Cluster Statistics

  • Node Statistics

    • Web Requests

    • Plugin

  • Elasticsearch Summary

  • Backup and Snapshot Repositories

The Driven Manage System page contains performance metrics related to your Driven deployment. This page provides statistics about your deployment including node metrics and Elasticsearch information. The Elasticsearch information can help uncover issues in the persistence layer. Driven aggregates deployment statistics and events and offers a single interface to view and analyze them.

Note
 All metrics displayed in the Driven Health page are not stored by the server but rather are kept in memory. Therefore, if the server is shut down for any reason all counters are reset.