https://docs.cyclecomputing.com/wp-content/uploads/2018/04/settings-1.png

About

The About page displays the current version and licensing information for CycleCloud. Click on Show License Details to view Account ID, license expiration date, and more.

The Enter License Code tab allows you to update your CycleCloud license, or install a new one.

Check for Updates

The Check for Updates page contains information about the version of CycleCloud presently in use. Toggle the arrow or click Show to view the release notes for your CycleCloud version.

Application Information

If you are not running the latest version of CycleCloud, you will see a link to download the latest package. Other associated tools such as CycleCloud CLI and Jetpack can be obtained via this page. Click the icon for the appropriate platform to begin the download.

My Profile

My Profile displays your username, full name, and email address. Click Edit Profile to change your name or email address. Your username cannot be modified.

Click on Change Password to update your CycleCloud password. Enter your current password, then select a new password. All passwords must be between 8 and 123 characters long, and meet at least 3 of the following 4 conditions:

  • Contain at least one upper case letter
  • Contain at least one lower case letter
  • Contain at least one number
  • Contain at least one special character: @ # $ % ^ & * – _ ! + = [ ] { } | : ‘ , . ? ` ~ ” ( ) ;

Click Save to update your password.

User Management

Administrators create and manage users through the User page, which is accessed through the User Management link in the upper-right dropdown menu. Selecting this link will bring up the Users page that lists all known users of the system, their names and their associated roles in the application.

To create a new user, click Create from the User Management menu. In the Create User window, enter a user name (i.e. “dvader”), full name, and email address. Enter a password for the user that meets the password policy guidelines (twice), and choose whether to force a password reset when the user logs in.

If you are setting up a new Superuser account, click the checkbox to provide full access to your resources. Alternatively, select the role(s) for your new user. Click Save to create the account.

Note

If you are using AD/LDAP authentication, the login ID entered in this screen must match their AD login.

Editing Users

To manage existing users, including newly created user accounts, select the desired name from the table and then select Edit. The edit dialog will appear where the user’s existing authorizations are listed. These can then be modified with the unassigned authorizations or removed entirely.

To delete users, select a user and click Delete.

Note

If you are trying to edit a single user, try typing his or her name into the Filter. It will filter out any row which doesn’t match the specified string.

Groups

Administrators can create a group of select users and assign it permissions that apply to that group only. On the Groups tab, click Create to set up a new group. In the Create Group window, enter a name and description. Click Add Member to select or search for a user, and assign them a role. Save your group, or Cancel to go back.

To Edit or Delete a group, select it in the Groups pane and click the appropriate action.

Roles and Permissions

For information on Roles and Permissions, please see the Roles section of the User Creation and Role Management guide.

Settings

The Settings page allows Administrators to fine-tune the CycleCloud configuration. Select any of the listed options and click Configure to modify the settings.

Name Description
Account Edit account and installation settings such as Site Name and CycleCloud portal account information
Authentication Modify authentication settings or switch between built-in, Active Directory, or LDAP authentication methods
CycleCloud Monitoring, Metrics, and display Cluster Type
DataMan Data Management and Proxy configuration
Email Configuration for email accounts for alerts and messaging
Ganglia Configuration options for Ganglia
Submission Directory path for submission scripts
SubmitOnce Settings for SubmitOnce jobs

The Advanced tab contains additional CycleCloud system settings. Select a line in the list and click Configure to modify.

Data Browser

Data Browser displays advanced details about CycleCloud activity. With it, you are able to drill down to specific details for almost every aspect of the product.

Warning

Modifying Data Browser settings is akin to changing Windows Registry files, and is not recommended for anyone other than extremely advanced users.

Event Log

The Event Log will show information about CycleCloud events in greater detail. Use the dropdown menu to select the Event Type, Priority, and Time Frame. You can sort each column in ascending or descending order, or search for a specific keyword.

Click to select any line within the event log to view the event in the Event Detail pane. To view even greater event detail, select a line and click Show Detail:

https://docs.cyclecomputing.com/wp-content/uploads/2018/04/eventdetail-1.png

Export Data

Click the disk icon in either the Event Log or in the Event Detail pane to export the data with the selected parameters. Choose a format, then check or uncheck Selected Rows Only based on your needs. Preview will display the export data in a window, or Download the data in the selected format.

Customize Event Detail View

Currently, there is only one option for viewing Event Details, which shows select attributes by default. However, you can create a custom view for event details by clicking on View: Details, Customize, and Create Copy:

https://docs.cyclecomputing.com/wp-content/uploads/2018/04/customeventview-1.png

This will create a copy of the default view, which you can then edit and save. Give your view a name, then use the + or – change the attributes shown. There are many additional attributes that can be displayed in the Event Detail pane. When you are done editing the attributes for your custom view, click Create to save or Cancel to discard.

In the Event Details pane, use the View dropdown to select which view you wish to see.

Note

Custom views are saved to the user account and are not visible to others.

Log Out

Click Log Out to log out of your CycleCloud account.