Logo
latest

Scalr Introduction

  • Overview of Scalr
    • Multi-Cloud Support
    • High-Level Declarative Primitives vs Low-Level Imperative Instructions
    • Usable by Both Developers and IT
  • Scalr Architecture
    • Software Architecture
  • Concepts and Terminology
    • Scalr Scopes
      • Login Scopes
      • Configuration Scopes
    • Cloud Credentials
    • Accounts
    • Environments
    • Images and Roles
    • Farms and Farm Roles
      • Desired State Engine
    • Service Catalog and Applications
    • Cost Analytics/Manager
    • Policy Engine
    • Users, Teams and Access Control
    • Global Variables
    • Orchestration
    • Scripts
    • Webhooks, Endpoints and External Integrations

Scalr Server Admin Guide

  • Installation & Upgrades
    • Scalr Server Architecture and Requirements
      • Architecture
      • Supported Operating Systems:
      • Network Requirements
      • Scalarizr Network Requirements
      • Hosted Scalr Network Requirements
    • Scalr Server Install
      • Prerequisites
      • For DEB-based Linux operating systems
      • For RPM-based Linux operating systems
    • Scalr Server HA Replication
      • Setting up Replication for the Scalr Database
    • Scalr Server Maintenance
      • Upgrades
      • Automated Upgrades
      • Database Backups
      • Monitoring Best Practices
      • Troubleshooting
    • Scalarizr Installation
      • Scalarizr Functionality
      • Supported Server/Instance Operating Systems
      • Scalarizr Network Requirements
      • Installing Scalarizr
        • How to Install Scalarizr on Linux Images
        • How to Install Scalarizr on Windows Images
      • Scalarizr Logs
      • How to Create Your Own Scalarizr Repo
        • Managing Scalr Integrated Repo Service
        • Download and Set Up a Custom Repo
        • Removing Custom Repo Branches and Packages
    • Advanced Configurations
      • Proxy
      • SSL
      • LDAP
      • SAML
      • Logging
      • API
      • Agent Update
      • VMware
      • Uncategorized
  • Extensions
    • Enable LDAP Authentication
      • Configuration
    • Enable SAML Authentication
      • Integration with Scalr
      • Configuration
    • Enable Email Integration
      • Configuring Email
    • Enable Advanced Logging
      • Fluentd Configuration
      • Scalr Configuration
      • Log Examples
        • Agent
        • API
        • Audit
        • User

Cloud Configuration and Services

  • Cloud Configuration and Credentials
    • Connecting Scalr to AWS
      • Configure AWS for Scalr
        • Configure Virtual Private Cloud (VPC)
      • Configure Instance Connection Policy
        • Configure Detailed Billing
      • Configuring your AWS IAM User
      • Adding AWS Credentials to Scalr
      • Validating the Connection to AWS
    • Connecting Scalr to Google Cloud Platform (GCP)
      • Configure GCP for Scalr
        • Configure Virtual Private Cloud (VPC)
      • Configure Instance Connection Policy
      • Adding GCP Credentials to Scalr
      • Enable Billing
    • Connecting Scalr to Microsoft Azure
      • Configure Azure for Scalr
        • Configure Virtual Networks
      • Configure Instance Connection Policy
      • Adding Azure Credentials to Scalr
      • Enable Billing
    • Connecting Scalr to OpenStack
      • Configuring OpenStack for Scalr
        • Configure OpenStack API Access
        • Configure Virtual Private Cloud (VPC)
      • Configure Instance Connection Policy
      • Adding OpenStack Credentials to Scalr
    • Connecting Scalr to VMWare vSphere
      • Configure VMWare for Scalr
      • Configure Instance Connection Policy
      • Adding VMWare Credentials to Scalr
      • Adding Instance Types
      • VMware Activities that Impact Scalr
      • Enable Cost Tags
  • Cloud Services and Features in Scalr
    • Cloud Specific Configuring

Getting Started

  • Getting Started for Admins
    • Role of an Administrator
  • Getting Started for End Users
  • Navigating the User Interface
    • Scope Differences
    • UI Overview
    • Dashboards
      • Dashboard Configuration
      • Available Widgets
    • Main Menu
    • Bookmarks Bar
    • Profile Menu
      • Two-Factor Authentication
    • Environments Menu
    • List Views

Farm Fast Start

  • Building a Simple Farm
    • Overview
    • Fast Farm Build

Cloud Images and Templates

  • Images and Roles in Scalr
    • Cloning, Promoting and Using
  • Registering Images
    • AWS Images
    • Azure Images
    • GCE Images
    • Openstack Images
    • VMware Images
  • Creating Roles
    • Role Orchestration
      • Trigger Event
      • Target
      • Action
      • Advanced Configuration
    • Global Variables in Roles
    • Ansible Tower in Roles
    • Chef in Roles
    • Role Permissions
  • Creating Images and Roles from Non-Scalr Servers
  • Multi-cloud Roles

Infrastructure Management

  • Farm Configuration
    • Creating a Farm
      • Farm Parameters
    • Farm Roles
      • Database
      • Scaling
      • Network
      • Farm Role Orchestration
        • Trigger Event
        • Target
        • Action
        • Advanced Configuration
      • Cloud Provider Tabs
        • EC2
        • Azure
        • GCE Settings
        • OpenStack
        • VMware
      • Security
      • Storage
      • Global Variables
      • Advanced Options
      • Ansible and Chef in Farm Roles
  • Farm Launching and Managing Servers
    • Launching a Farm
    • Managing Servers
    • Terminating Servers
    • Server Dashboard
    • Allowed Hours
  • SSH Keys in Scalr
    • Definition and Scope
    • Accessing Keys
    • Usernames
    • Adding Policy for Keys
  • Configuring Storage
    • Volume Mounting
    • AWS Storage Configuration
    • Google Cloud Platform Storage Configuration
    • Azure Storage Configuration
    • OpenStack Storage Configuration
    • VMWare Storage Configuration
  • Scaling Applications
    • Auto Scaling
      • Definition and Scope
      • Simple Autoscaling
      • Dynamic Autoscaling
      • Autoscaling Configuration
      • Custom Scaling
    • Manual Scaling
      • Overview
      • Using Manual Scaling
      • Manually Launching Servers
      • Manually Terminating Servers
  • Service Auto Discovery
  • Using Cloud Services in Farms
  • Logs
    • Definition and Scope
      • Orchestration Logs
      • Event Logs
      • System Logs
  • External Integrations
    • Infoblox Integration
      • Definition and Scope
      • Installation & Setup
      • Configure Farm Roles to Use Infoblox
    • ServiceNow Integration
      • Overview
      • CMDB Integration
      • CMDB Integration Setup

Self Service & Farm Templates

  • The Service Catalog
    • Creating Service Catalog Offerings
      • Creating from a Farm
      • Creating Manually
    • Customising Farm Templates
      • Simple Template Example
      • Enabling Options for End Users
      • Customising for Multi-Cloud
    • Publishing and Promoting Service Catalog Offerings
  • Self Service via the Service Catalog
    • Requesting Applications
    • Managing Applications
  • Advanced Farm Templates
    • AWS Example
    • Azure Example
    • VMware Example
    • GCE Example
    • Openstack Example
    • Service Catalog Advanced Configuration
      • Cloud Agnostic Template
      • Conditions and Allowed Values
      • Storage Configuration
      • Min and Max Server Counts

Organizational Management

  • Implementing your Organisation in Scalr
  • Account & Environment Configuration
    • Creating Accounts
    • Configuring Environments
    • Creating Environments
    • Managing Environments
  • Cost Centers and Projects
  • Access Control Lists
    • Understanding Access Control
    • Creating an ACL
  • Users and Teams
    • Configuring Users
      • Scalr Local Users
      • Externally Authenticated Users
    • Global Admins
    • Financial Admins
    • Configuring Teams
      • Scalr Local Teams
      • Externally Authenticated Teams
    • Adding Teams to Environments

Governance, Security and Compliance

  • Security and Compliance Overview
    • Policy Engine
    • Resource Quotas
    • Orchestration Rules
    • Role Based Access Control
    • Governance Through External Integrations
  • Policy Engine
    • Creating Policy Groups
    • Creating Policies
      • Policy Whitelist/Blacklist
      • Using Global Variable in Policies
    • Policy Tags
    • Linking Policy Groups to Environments
  • Policy Reference
    • Configuration Policies
    • Container Policies
    • Reclamation Policies
      • Lifetime
      • Allowed Hours
    • Cloud Service Gateway Policies
    • Cloud Generic Policies
    • AWS Policies
    • Azure Policies
    • Google Compute Engine Policies
    • Openstack Policies
    • VMware Policies
  • Resource Quotas
    • Definition and Scope
    • Creating Quotas
    • Applying Quotas
  • Scalr/Account/Environment Level Orchestration
    • Creating Orchestration Rules
      • Trigger Event
      • Target
      • Action
      • Advanced Configuration
  • Webhooks and Endpoints
    • Definition and Scope
    • Overview
    • Configuring Endpoints
    • Configuring Webhooks
    • Webhook Payloads
    • Webhook Security and Authentication
    • Webhook History
    • Highly Available Webhooks
    • Example Webhooks
  • Access Control Lists
    • Understanding Access Control
    • Creating an ACL
  • Approvals
    • Farm Status and Events
    • Approvals History

Cost Control & Visibility

  • Cost Management
    • Overview
    • Feature Preview
    • Currently Supported Cloud Service Providers
    • Cost Manager Dashboard
    • Enabling Tags
    • Price Books
    • Rightsizing
    • Kubernetes Cost Dashboard
      • Kubernetes Price Books
  • Cost Analytics
    • Definition and Scope
    • Cost Centers
    • Projects
    • Budgets
    • Reports
      • Periodic Reports
      • Cost Center and Budget Alerts
    • Markups
  • Garbage Collector
    • Using the Garbage Collector

Configuration Management

  • Scripts
    • Definition and Scope
    • Creating Scripts in Scalr
    • Linking a Git Script
      • Writing a Script
    • Executing Scripts
      • Using Scripts In Orchestration
      • Manually On Farms, Farm Roles, or Servers
      • Advanced Configuration
      • Promoting Scripts to Higher Scopes
      • Limit Script Execution
  • Global Variables
    • Definition and Scope
    • Creating Global Variables
      • Using Remote Lists
    • Using Global Variables in Scripts
    • Global Variable Interpolation
    • Using Global Variables in Policies
    • Examining Global Variables in Servers
    • Built-in Scalr Variables
      • Server Scope Built-In Variables
      • Server Scope Built-In Cost Variables
    • Scalr UI Default Global Variables
  • Chef Integration
    • Definition and Scope
    • Adding a Chef Server
    • Using Chef with Scalr
      • Role Scope
      • Farm Role Scope
    • Troubleshooting
  • Ansible Integration
    • Definition and Scope
    • Adding an Ansible Tower Server
    • Adding an Ansible Tower Group
    • Adding an Ansible Tower Bootstrap Configuration
    • Attaching Bootstrap Configurations to a Server
      • Role Scope
      • Farm Role Scope
  • Custom Events

Importing Cloud Infrastructure

  • Discovery Manager
    • Importing Overview
    • Import Servers with the UI
    • Import Servers with the API
    • Deploy Scalarizr
    • Discovering Containers
    • Migrate Servers from Farm Role to Farm Role
  • Kubernetes Clusters
    • Definition and Scope
    • Google GKE
      • GKE Kube-Config
      • Resources:
    • Amazon EKS
      • AWS Kube-Config
      • Resources:
    • Self - Managed Kubernetes Clusters
      • Resources:
    • Adding a Cluster to Scalr

Alternative Interfaces

  • Scalr API & CLI
    • API
      • Generate API Keys
      • API Explorer
    • CLI
      • Installing and Configuring the CLI
      • Using the CLI
      • CLI Examples
  • Cloud Service Gateway
    • Configuring Cloud Service Gateway
    • Using the Cloud Service Gateway
      • Client Configuration Details
    • Managing approvals for Cloud Service Gateway

Scalarizr agent

  • Scalarizr
    • Scalarizr Functionality
    • Monitoring Scalarizr
      • Servers Dashboard:
      • Server General Details:
      • Farm Dashboard:
    • Updating the Scalarizr Agent
      • Farm:
      • Farm Role:
      • Forcing an Update:
    • Scalarizr Logs
  • Scalarizr Administrative Interface
    • Firing Custom Events
    • Querying Environments
      • queryenv list-roles
      • queryenv list-global-variables
      • szradm queryenv get-server-user-data
      • szradm queryenv set-global-variable

Best Practices

  • Managing Images in Scalr
    • About Images and Scopes
    • Image Lifecycle Best-Practices
    • Updating a Widely Used Image
    • Approach 1: Offering a new version of an image
    • Approach 2: Replacing an existing image with a new version
    • Automating Image Management
    • Example Image publishing pipeline

Tutorials

  • Scalr Server Install - One Server
    • Prerequisites
    • Installation
    • Shared Roles
  • 3 Tier App Tutorial (cloud agnostic, orchestration automation)
    • Objective
    • Application Overview
    • Script Creation
    • Roles Required:
    • Farm Creation:
    • Farm Role Configuration
      • Select and configure the WebApp farm role:
      • Select and configure the MySQL farm role:
      • Select and configure the Nginx farm role:
    • Testing the Application

Release Notes

  • Release Notes
    • Scalr Release Notes
    • Docs Links
      • 7.15.0
      • 7.14.0
      • 7.13.0
      • 7.12.0
    • Scalarizr Release Notes
  • Announcements
    • Built-In Automation Deprecation
    • Hosted Scalr End Support of Features Notice (18-Mar-2019)
    • Suse Support
    • Ubuntu 18.04 Support
    • Ubuntu 12.04 Support
  • Scalr Labs

Reference Section

  • Support Cloud Platforms
  • Supported Server/Instance Operating Systems
  • Scalarizr Network Requirements
  • Scalarizr Functionality
  • Event Descriptions
    • Farm Life Cycle Events
    • Server Life Cycle Events
      • BeforeInstanceLaunch Event
      • HostInit Event
      • HostInitFailed Event
      • BeforeHostUp Event
      • HostUp Event
      • IPAddressChanged Event
      • EBSVolumeAttached Event
      • EBSVolumeMounted Event
      • BeforeHostTerminate Event
      • HostDown Event
      • RebootComplete Event
      • ResumeComplete Event
  • Supported Cloud Services and Features
    • AWS Features and Services
      • Spot Instances
      • S3 Buckets
      • CloudFront
      • Relational Database Service (RDS)
      • EC2 - Load Balancers
      • EC2 - Elastic IP’s
      • EC2 - Security Groups
      • EC2 - EBS Volumes
      • EC2 - EBS Snapshots
      • Elastic Map Reduce (EMR)
      • Elastic File System (EFS)
      • Route53
      • IAM - SSL Certificates
      • VPC’s and Subnets
      • Lambda
      • ECS
      • Glacier
      • API Gateway
      • SQS
      • SNS
      • SES
      • Redshift
      • Cognito Identity
      • Cognito User Pools
      • Device Farm
      • Mobile
      • Pinpoint
    • Azure Features and Services
      • Public IP’s
      • Resource Groups
      • Virtual Networks
      • Security Groups
      • Managed Disks
      • Web
      • Container Registry
      • Container Services
      • Insights
      • Database
      • Event Hubs
      • Stream Analytics
      • Machine Learning
      • SQL Server
    • Google Cloud Platform Features and Services
      • Persistent Disks
      • Snapshots
      • External IP’s
      • Cloud SQL
      • HTTPS Load Balancers
    • Openstack Features and Services
      • Volumes
      • Snapshots
      • Security Groups
      • Server Groups
    • VMware VSphere Features
Scalr
  • Docs »
  • Navigating the User Interface
  • Edit on GitHub

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.

Warning

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. SAV1 SAV2 SAV3

Note

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 REFRESH. For an optimal experience always use the list refresh button to refresh the list rather than your browsers page refresh option.

Scope Differences¶

Aside from functionality the only difference between the UI for each scope is the colour as shown in these examples of the Bookmark Bar.

Scope Colour
Scalr SB
Account AB
Environment EB

UI Overview¶

This screen shot shows an overview of the entire UI.

../_images/ui-overview.png

Dashboards¶

SCOPE_SCALR SCOPE_ACC SCOPE_ENV

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.

../_images/dashboard1.png

Dashboard Configuration¶

The following Dashboard configuration can be performed at all scopes.

Number of Columns

The number of columns displayed can be altered to suit.

SET –> COL

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.

ADD_1 ADD_2

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.

../_images/widget_head.png

Available Widgets¶

SCOPE_SCALR
Scalr Health
Services
First Steps
License
Inventory
SCOPE_ACC
New User Checklist
Get Your Organization On Scalr
Announcements
Environments in this Account
Inventory
SCOPE_ENV
Create New Farm
New User Checklist
Announcements
Active Policies
Resource Quotas
AWS Health Status
GCE Usage Monitor
VMware Usage Monitor
Last Errors
Server Alerts
Cost analytics
Inventory

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.

../_images/inventory.png

Main Menu¶

SCOPE_SCALR SCOPE_ACC SCOPE_ENV

The Main Menu gives you access to all the functionality that is available to you. The Main Menu is opened by clicking on MENU_ENV in the top left corner.

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”.

../_images/mm-filter.png

Bookmarks Bar¶

SCOPE_SCALR SCOPE_ACC SCOPE_ENV

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 PIN. Click the pin to add the item to the Bookmarks Bar permanently.

../_images/pin_1.png ../_images/pin_2.png

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.

../_images/settings_1.png
  • Remove bookmarks by clicking the “x” next to the name.
  • Re-order the bookmarks by dragging and dropping
  • Suppress the confirmation if desired.
../_images/settings_2.png

Click “Save” at the bottom of the screen when done.

Profile Menu¶

SCOPE_SCALR SCOPE_ACC SCOPE_ENV

../_images/settings_1.png

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.

Two-Factor Authentication¶

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 NEWWIN.

Environments Menu¶

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.

../_images/env_menu1.png

List Views¶

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.

../_images/list_1.png

Some lists will include Action and a Settings ASET 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 DROP button is a drop down list of all the actions than can be taken on the specific farm.

No items selected Items selected
A1 A2

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.

../_images/list_2.png

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.

../_images/list_farms.png ../_images/list_filtered.png
Next Previous

© Copyright 2018, scalr_team Revision 6299a893.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: latest
Versions
latest
7.15.0_working
Downloads
pdf
html
epub
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.