Tip

This is the Scalr CMP documentation. Click here for the Scalr for Terraform documentation.

Scalr Documentation

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
  • Scalr Server Install
  • Scalr Server HA Replication
  • Scalr Server Maintenance
  • Scalarizr Installation
  • Advanced Configurations
• Extensions
  • Enable LDAP Authentication
  • Enable SAML Authentication
  • Enable Email Integration
  • Enable Advanced Logging

Cloud Configuration and Services

• Cloud Configuration and Credentials
  • Connecting Scalr to AWS
    • Configure AWS for Scalr
    • Configure Instance Connection Policy
    • 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 Instance Connection Policy
    • Adding GCP Credentials to Scalr
    • Enable Billing
  • Connecting Scalr to Microsoft Azure
    • Configure Azure for Scalr
    • Configure Instance Connection Policy
    • Adding Azure Credentials to Scalr
    • Enable Billing
  • Connecting Scalr to OpenStack
    • Configuring OpenStack for Scalr
    • 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
    • Cloud Provider Tabs
    • 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
    • Chef Policy Files
  • 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
  • Testing the Application

Release Notes

• Release Notes
  • Scalr Release Notes
  • Docs Links
  • 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
• Hosted Scalr End Support of Features Notice (18-Mar-2019)
  • Features impacted:
  • Deprecation Schedule:
• 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
• Supported Cloud Services and Features
  • AWS Features and Services
  • Azure Features and Services
  • Google Cloud Platform Features and Services
  • Openstack Features and Services
  • VMware VSphere Features