Navigating the User Interface¶
This section provides a guide to the Scalr User Interface. It will show you how the various functional features of the UI, but it will NOT show you every feature of Scalr.
The details of the UI, including the menu buttons and functionality, will vary according to the Scope you are logged in to, and the permissions you have been granted via Access Control Lists. This section of the documentation will show screen shots and examples based on a user having full access to Scalr at the Environment Scope. If you do not see all the options shown in these examples when you login to Scalr please contact your administrator.
DO NOT FORGET TO SAVE. When you are creating or editing anything in Scalr you must always click on the appropriate “Save” button. The button will either be located at the bottom of the screen, or the bottom of a pop-up dialogue. The Save button can appear in different formats, including have an associated options drop down.
The Scalr UI is highly optimised to provide fast response times and rapid loading of data, especially lists of items such as Images, Roles, Farms etc. Every list has a refresh button . For an optimal experience always use the list refresh button to refresh the list rather than your browsers page refresh option.
Aside from functionality the only difference between the UI for each scope is the colour as shown in these examples of the Bookmark Bar.
This screen shot shows an overview of the entire UI.
Each scope has a Dashboard which is the default landing page and provides quick access to some functionality and various status information via a series of Widgets. The Widgets can be customised so that the user can choose which ones to display, their position on the Dashboard, and, in some cases, their content. There is one dashboard at Scalr scope and then one dashboard for each Account and each Environment.
The following Dashboard configuration can be performed at all scopes.
Number of Columns
The number of columns displayed can be altered to suit.
Adding and Moving Widgets
The Add Widget button appears when the mouse is hovered below any column on the Dashboard. A check list of available widgets is displayed and widgets are then added to that column. Widgets can be re-positioned by dragging and dropping using the widget header.
Widget Settings and Removal
The widget header bars provide buttons to collapse, remove, and in some cases configure the settings of the widget. e.g. for “Resource Quotas” the clouds to be displayed can be configured.
The Inventory widget will give users a snapshot into their overall cloud usage at each scope within Scalr. If you are logged into the Scalr scope you will see the inventory for all resources across all Accounts and Environments. As you log into the lower scopes you will only see the inventory for those scopes.
The menu can be filtered by typing text into the filter box at the top. This will reduce the menu down to to items that include that text at any level in the menu. As you can see from this example, typing “server” in the filter reveals top level items that have sub-menu’s containing the word “server”.
The Bookmarks Bar provides quick access to commonly used menu items. It defaults to the items shown in the table above but can easily be edited to include the items most relevant to you.
You can edit the contents of the bookmarks bar in two ways.
Pin a Menu Item
When you select an item from the Main Menu that is not already in the Bookmarks Bar, it will be temporarily added to the Bookmarks Bar until you select a different menu item. Temporary bookmark items have an associated pin button . Click the pin to add the item to the Bookmarks Bar permanently.
Edit and Re-Order Via Settings
To remove or re-order Bookmarks Bar items you must navigate to settings. Click on the profile menu icon top right and select settings.
- Remove bookmarks by clicking the “x” next to the name.
- Re-order the bookmarks by dragging and dropping
- Suppress the confirmation if desired.
Click “Save” at the bottom of the screen when done.
The Profile menu also gives access to some security and UI related features.
|API access||The API Access option can be used to enable API Access and to obtain an API Key ID and Access Key ID for configuring the Scalr API. API Key’s only provide access at the Scope they are created at and scopes below that. See Scalr API & CLI for more details.|
|Security||The Security option can be used to make password changes and for creating an IP Access Whitelist.|
|Settings||The Settings option can be used to make profile changes, attach an avatar, configure RSS Feed for Logs, change timezones, configure the Dashboard, and for making Grid layout changes.|
|Logout||The Logout option will log you out of your session at the current scope. If you logged into to an Account from Scalr scope you will be taken back to you Scalr scope session.|
To enable two-factor authentication for your user, you can do so by navigating to the Profile Menu and clicking on Security. Once in the Security page, click “Enabled” for the two-factor authentication and following the instructions. Learn more about Google two-factor authentication here: Google Authenticator .
The Environments Menu is used to select and manage working Environments within an Account. Click on an Environment within this menu to switch between your available Environments.
The current working Environment will contain a dot as a visual indicator of the current selection, as shown below. Click on the green Account name to be taken to the Account Dashboard. If you have access to multiple Accounts you can use the “Switch Accounts ” button to change to another Account.
Lists are used all over the Scalr UI and have a common layout that includes the Search/Action tool bar, column headings and the list itself. Some lists will have a “New ….” button as shown in this Images example.
Some lists will include Action and a Settings buttons as well.
Action buttons can appear in both the list tool bar and alongside each item in the list. The toolbar action buttons can be used to apply the same action to multiple items in the list. These action buttons will be greyed out until at least one item in the list is checked. Note that the button is a drop down list of all the actions than can be taken on the specific farm.
|No items selected||Items selected|
When a list is selected via the main menu it will show an unfiltered list as can be seen in this example list of Servers.
A list can also be navigated to from some other context and will be filtered according to the context. E.g the Servers list can be reached from the Farms list and will then only show the servers for that farm due to the pre-applied search filter.