latest
Using Scalr
Introduction
How to use Scalr
CLI Remote Backend
VCS Integration
Migrating to Scalr
Workspaces
The Scalr UI
Menu Button
Switching Accounts/Environments
Getting Started
Navigate the UI
First Steps
Cloud Credentials
VCS Providers
Grant Access
Environments
Workspaces
Identity and Access Management
Terminology
IAM Summary
Configuring IAM
Teams
Inviting Users
Deleting Users
Built-in Roles
Access Policies - Account
Access Policies - Environment
Examples
What’s coming in future releases of IAM
Terraform CLI with Scalr
API Token
Backend Terraform Configuration
Set Input Variables
Supported CLI Commands
VCS Providers
VCS Provider Configuration
Github
Gitlab
Azure Devops Services
Bitbucket
VCS Integration - Deployment Pipelines
Create Workspace
Set Input Variables
Dry Runs
Full Runs
Migrating to Scalr
API Token
Stop Runs
Set the Remote Backend
Migrate the State
Set Input Variables
Cloud Credentials
Configuring Credentials
AWS Credentials
Access Keys
IAM Role Delegation
Azure Credentials
Google Cloud Credentials
VMware Credentials
Using Cloud Credentials
Governance with OPA
What is OPA?
How is OPA Implemented in Scalr?
Creating Policy Groups
Policy Group Checks
OPA Pull Request Previews
New Runs
Existing Workspaces
OPA Examples
Modules in Scalr
Scalr Module Registry
Module Repositories
Micro-Repo
Mono-Repo
Publishing Modules
Example Module Call from Registry
Modules from Git
Example module call from Git
Modules from Paths
Example for CLI configuration
Self Service - Template Registry
Registering a Template
Template Registry Request
Input Controls
Scalr Policies
Policy Reference
Common Policies
Amazon Web Services
Microsoft Azure
Google Cloud Platform
VMWare
Webhooks
Overview
Endpoint Configuration
Webhook Configuration
Deliveries
Sharing Workspace State
Example
Cost Estimation
Enabling Cost Estimation
View Cost Estimation
Cost Estimation Reference
AWS:
GCP:
API / Provider
Scalr API
Authentication
API Versioning and Path
API Profiles
API Feature Deprecation
scalr.io (SaaS)
On-Prem Scalr
API Format
JSON API Responses and Inputs
Method Parameters
Pagination Parameters
Example Usage
API Profile Specifications
Preview
Applies
The Apply resource
Get an Apply
Apply Log
Configuration Versions
The ConfigurationVersion resource
List Configuration Versions
Create a Configuration Version
Get a Configuration Version
Download Configuration Version
Cost Estimates
The CostEstimate resource
Get a Cost Estimate
Cost Estimate Log
Endpoints
The Endpoint resource
List Endpoints
Create an Endpoint
Delete an Endpoint
Get an Endpoint
Update Endpoint
Environments
The Environment resource
List Environments
Create an Environment
Delete an Environment
Get an Environment
Update Environment
Event Definitions
The EventDefinition resource
List Event Definitions
Plans
The Plan resource
Get a Plan
Plan Log
Policy Checks
The PolicyCheck resource
Get a Policy Check
Override Policy
Policy Check Log
List Policy Checks
Runs
The Run resource
List Runs
Create a Run
Get a Run
Apply a Run
Cancel a Run
Discard a Run
Download a Policy Input
State Versions
The StateVersion resource
List Workspace’s State Versions
Get a State Version
Download State Version
Get Workspace’s Current State Version
Variables
The Variable resource
List Variables
Create a Variable
Delete a Variable
Get a Variable
Update a Variable
Webhooks
The Webhook resource
List Webhooks
Create Webhook
Delete a Webhook
Get a Webhook
Update Webhook
Workspaces
The Workspace resource
List Workspaces
Create a Workspace
Delete a Workspace
Get a Workspace
Update a Workspace
Unlock a Workspace
Scalr Terraform Provider
Overview
Authentication
Authentication with Environment Variables
Scalr Provider Installation
Terraform 0.12.x Scalr Provider Installation
Local Installation
Remote Backend Installation
Terraform 0.13.x Scalr Provider Installation
Terraform Configuration
Local Installation
Remote Backend Installation
Example
Data Sources
scalr_current_run Data Source
Example Usage
Argument Reference
Attribute Reference
scalr_endpoint Data Source
Example Usage
Argument Reference
Attribute Reference
scalr_environment Data Source
Example Usage
Arguments
Attributes
scalr_webhook Data Source
Example Usage
Argument Reference
Attribute Reference
scalr_workspace Data Source
Example Usage
Argument Reference
Attribute Reference
scalr_workspace_ids Data Source
Example Usage
Argument Reference
Attribute Reference
Resources
scalr_endpoint Resource
Example Usage
Argument Reference
Attribute Reference
Useful snippets
scalr_environment Resource
Example Usage
Argument Reference
Attributes
scalr_variable Resource
Example Usage
Argument Reference
Attribute Reference
Import
scalr_webhook resource
Example Usage
Argument Reference
Attributes
scalr_workspace Resource
Example Usage
Argument Reference
Attribute Reference
Import
Reference
Self Hosted Scalr
Production Installation
Architecture
Prerequisites
Cloud specific instructions
Production Install - AWS
Production Install - Azure
Production Install - Google
Production Install - Private Cloud
POC Install
Prerequisites
Installation
Upgrading Self-Hosted Scalr
Extra Configuration
Disk quota
Configuration of the xfs volume
Backup of data
Configuration of the disk quota
IAM Role Delegation Configuration
External Authentication
SAML Integration
LDAP Integration
Enable Email Integration
Configuring Email
FAQ
How do I configure VCS automation?
How do I migrate existing state to Scalr IaCP?
How do I call a private module in Scalr IaCP?
Option 1: Modules and Terraform configuration in the same VCS system
Option 2 : Modules from other repositories
Option 3 : Relative Paths
How do I use provider credentials in Scalr IaCP?
How do I apply policy to CLI runs?
Configure the Terraform configuration with a Remote Backend
Linking Policies to Environments
How do I get data and state from other workspaces?
How do I upgrade or change the number of users on my account?
Upgrade
Change Number of Users
What IPs should I whitelist for scalr.io if needed?
IaCP
Docs
»
Scalr API
»
Preview
Preview
¶
Applies
The Apply resource
Get an Apply
Apply Log
Configuration Versions
The ConfigurationVersion resource
List Configuration Versions
Create a Configuration Version
Get a Configuration Version
Download Configuration Version
Cost Estimates
The CostEstimate resource
Get a Cost Estimate
Cost Estimate Log
Endpoints
The Endpoint resource
List Endpoints
Create an Endpoint
Delete an Endpoint
Get an Endpoint
Update Endpoint
Environments
The Environment resource
List Environments
Create an Environment
Delete an Environment
Get an Environment
Update Environment
Event Definitions
The EventDefinition resource
List Event Definitions
Plans
The Plan resource
Get a Plan
Plan Log
Policy Checks
The PolicyCheck resource
Get a Policy Check
Override Policy
Policy Check Log
List Policy Checks
Runs
The Run resource
List Runs
Create a Run
Get a Run
Apply a Run
Cancel a Run
Discard a Run
Download a Policy Input
State Versions
The StateVersion resource
List Workspace’s State Versions
Get a State Version
Download State Version
Get Workspace’s Current State Version
Variables
The Variable resource
List Variables
Create a Variable
Delete a Variable
Get a Variable
Update a Variable
Webhooks
The Webhook resource
List Webhooks
Create Webhook
Delete a Webhook
Get a Webhook
Update Webhook
Workspaces
The Workspace resource
List Workspaces
Create a Workspace
Delete a Workspace
Get a Workspace
Update a Workspace
Unlock a Workspace
Read the Docs
v: latest
Versions
latest
Downloads
html
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.