Settings

Webinterface Settings Page

Categories:

Cc-Backend

The settings view allows non-privileged users to choose their preferred paging style, to customize how metric plots are rendered, and to generate personalized tokes for use with the API. Customization options include line width, number of plots per row (where applicable), whether backgrounds should be colored, and the color scheme of multi-line metric plots.

Privileged users will also find an administrative interface for handling local user accounts. This includes creating local accounts from the interface, editing user roles, listing and deleting existing users, generating JSON Web Tokens for API usage, and delegating managed projects for manager role users.

User Options

Field	Options	Note
Paging Type	Classic / Continuous	Style of paging in job lists
Line Width	# Pixels	Width of the lines in the timeseries plots
Plots Per Row	# Plots	How many plots to show next to each other on pages such as the job or nodes views
Colored Backgrounds	Yes / No	Color plot backgrounds indicating mean values within warning thresholds
Color Scheme	See Below	Render multi-line metric plots in different color ranges

Generate JWT

This function will generate and return a personalized JWT, printed into the “Display JWT” field.

If working with the ClusterCockpit API, this token is required to authorize the user against the REST API endpoints.

Color Schemes

Name	Colors
Default
Autumn
Beach
BlueRed
Rainbow
Binary
GistEarth
BlueWaves
BlueGreenRedYellow

Admin Options

Create User

New users can be created directly via the web interface. On successful creation a green response message will be returned, and the user is directly visible in the “Special Users” table - If the user has at least two roles, or a single role other than user.

Error messages will also be displayed if the user creation process failed. No user account is saved to the database in this case.

Please note: Users are usually imported via LDAP on ClusterCockpit startup.

Field	Option	Note
Username (ID)	`string`	Required, must be unique
Password	`string`	Only API users are allowed to have a blank password, users with a blank password can only authenticate via JW tokens
Project	`string`	Only manager users can have a project
Name	`string`	Name of the user, optional, can be blank
Email Address	`string`	Users email, optional, can be blank
Role	Select one	See roles for more detailed information
	`API`	Allowed to interact with REST API
Default	`User`	Same as if created via LDAP sync
	`Manager`	Allows to inspect jobs and users of given project
	`Support`	Allows to inspect jobs and users of all projects, has no admin view or settings access
	`Admin`	General access

Special Users

This table does not contain users who only have user as their only role saved in the database. This is the case for all users created by LDAP import, and thus, these users will not be shown here. However, LDAP users’ roles can still be edited, and will appear in the table as soon as a authority higher than user or two authorities were granted.

All other special case users, e.g. new users manually created with support role, will appear in the list.

User accounts can be deleted by pressing the respective function displayed for each user entry - A verification pop-up window will appear to stop accidental user deletion.

Additionally, JWT tokens for specific users can be generated here as well.

Column	Example	Description
Username	`abcd1`	Username of this user
Name	`Paul Atreides`	Name of this user
Project(s)	`abcd`	Managed project(s) of this user
Email	`demo@demo.com`	Email adress of this user
Roles	`admin,api`	Role(s) of this user
JWT	Press button to reveal freshly generated token	Generate a JWT for this user for use with the CC REST API endpoints
Delete	Press button to verify deletion	Delete this user

Edit User Role

On creation, users can only have one role. However, it is allowed to assign multiple roles to an user account. The addition or removal of roles is performed here.

Enter an existing username and select an existing (for removal) or new (for addition) role in the drop-down menu.

Then press the respective button to remove or add the selected authority from the user account. Errors will be displayed if existing roles are added or non-existing roles are removed.

Edit Managed Projects

On creation, users can only have one managed project. However, it is allowed to assign multiple projects to a manager account. The addition or removal of projects is performed here.

Enter an existing username and select an existing (for removal) or new (for addition) project by entering the respective projectId.

Then press the respective button to remove or add the selected project from the manager account. Errors will be displayed if existing projects are added, non-existing projects are removed, or if the user account is not authorized to manage projects at all.

Scramble Names (Presentation Mode)

Activating this switch will replace all user names, person names, and project names with random strings. Intended for presentations on a production system while retaining critical information from a publc audience.

Metric Plot Resampling

If “Resampling” of metric plots is enabled in the configuration file (config.json), and read correctly on start-up, this informational display will list both the amount of data points on whichthe next resolution will be requested (“Trigger”) as well as the applicable resolutions themselves.

Note: Changes to the resampling options have to be perfofmed by changing the configuration file and restarting the application.

Edit Notice Shown On Homepage

The contents of the text form field will be written into $CCPATH/var/notice.txt on submission. If this file does not exist, it will be created.

If any content is found, an informational card will be rendered above the home site table. The content will also be mirrored within the form field itself.

Removing any content from the form field, and submitting, will clear the file and remove the rendered card from the homepage. This state is indicated by the placeholder text “No Content.” being shown in the form field.

Feedback

Was this page helpful?

Glad to hear it! Please tell us how we can improve.

Sorry to hear that. Please tell us how we can improve.