Logo
Scalr Docs Terraform Automation and Collaboration Software

Using Scalr

  • Introduction
    • What is Scalr?
    • Why use Scalr?
    • How do I get started?
  • VCS Providers
    • Github
    • Gitlab
    • Azure Devops Services
    • Bitbucket Cloud
    • Bitbucket Data Center
  • Provider Credentials
    • Configuring Credentials
      • AWS Credentials
        • Access Keys
        • IAM Role Delegation
      • Azure Credentials
      • Google Cloud Credentials
      • VMware Credentials
    • Using Provider Credentials
  • Workspaces
    • Introduction
    • VCS Integrated Workspace
      • Create Workspace
      • Set Terraform Variables
      • Set Shell Variables
      • Video
    • CLI Driven Workspace
      • Create API Token
      • Create Workspace
      • Set Terraform Variables
      • Set Shell Variables
      • Supported CLI Commands
      • Video
    • Module Registry Workspace
      • Create Workspace
      • Set Terraform Variables
      • Set Shell Variables
      • Video
    • Workspace Settings
      • Custom Hooks
        • Built-In Variables
        • Hook Examples
      • Container Image Info
    • Runs
      • Runs Queue
  • Policy as Code
    • Using OPA in Scalr
    • Creating Policy Groups
    • Policy Group Checks
    • OPA Previews
      • Viewing Previews on Workspaces
      • Viewing Previews on New Runs
    • More Resources
    • Video
  • Private Module Registry
    • Publishing Modules
      • Module-Per-Repo
      • Sub-Modules (Mono Repo)
    • Deployable Modules
    • Module Source Types
      • Modules from Scalr
      • Modules from Git
      • Modules from Paths
  • Variables
    • Terraform Variables
    • Shell Variables
      • Built-In Variables
      • Setting Shell Variables
      • Example: Account scope
      • Example: Environment scope
      • Example: Workspace scope
  • Self Hosted Agent Pools
    • Configuring Agent Pools
    • Managing Agent Pools
      • Run the Agent as Root
      • Adding a Proxy
    • Coming Soon
  • Migrating to Scalr
    • API Token
    • Stop Runs
    • Set the Remote Backend
    • Migrate the State
    • Set Terraform Variables
    • Video
  • Sharing Workspace State
    • Example
  • Webhooks
    • Endpoint Configuration
    • Webhook Configuration
    • Deliveries
    • Zapier Integration for Slack
    • Example Webhook Server Code
  • Cost Estimation
    • Enabling Cost Estimation
    • View Cost Estimation
    • Cost Estimation Reference
      • AWS:
      • GCP:
  • Identity and Access Management
    • Terminology
    • IAM Summary
    • Configuring IAM
      • Teams
      • Inviting Users
      • Deleting Users
      • Built-in Roles
      • Custom Roles
      • Access Policies
        • Account Access Policies
        • Environment Access Policies
        • Workspace Access Policies
    • Examples
    • Single Sign-On
      • Configuration
      • Okta Example
      • Azure AD SSO Example
      • Users and Teams with SSO
    • Service Accounts
  • Hierarchical Model
    • Accounts
      • Shared Objects
      • Assigned Objects
    • Environments
    • Video

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
      • Access Policies
        • The AccessPolicy resource
        • List Access Policies
        • Create an Access Policy
        • Delete Access Policy
        • Get an Access Policy
        • Update an Access Policy
      • Access Tokens
        • The AccessToken resource
        • Delete an Access Token
        • Get an Access Token
        • Update an Access Token
        • List Agent Pool Access Tokens
        • Create an Agent Pool Access Token
      • Accounts_users
        • The User resource
        • List Account to User relationships
      • Agent Pools
        • The AgentPool resource
        • List Agent Pools
        • Create an Agent Pool
        • Delete an Agent Pool
        • Get an Agent Pool
        • Update an Agent Pool
      • Agents
        • The Agent resource
        • List Agents
        • Delete an Agent
        • Get an Agent
      • 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
      • Modules
        • The ModuleVersion resource
        • The Module resource
        • List Module Versions
        • Get a Module Version
        • Resync a Module Version
        • List Modules
        • Publish a Module
        • Unpublish a Module
        • Get a Module
        • Resync a Module
      • Permissions
        • The Permission resource
        • List Permissions
        • Get a Permission
      • Plans
        • The Plan resource
        • Get a Plan
        • JSON Output
        • Plan Log
        • Sanitized JSON Output
      • Policy Checks
        • The PolicyCheck resource
        • Get a Policy Check
        • Override Policy
        • Policy Check Log
        • List Policy Checks
      • Policy Groups
        • The Policy resource
        • The PolicyGroup resource
        • Get a Policy
        • List Policy Groups
        • Create a Policy Group
        • Delete a Policy Group
        • Get a Policy Group
        • Update a Policy Group
      • Roles
        • The Role resource
        • List Roles
        • Create a Role
        • Delete a Role
        • Get a Role
        • Update a Role
      • 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
      • Service_accounts
        • The ServiceAccount resource
        • List Service Accounts
        • Create a Service Account
        • Delete a Service Account
        • Get a Service Account
        • Update a Service Account
      • State Versions
        • The StateVersion resource
        • List Workspace’s State Versions
        • Get a State Version
        • Download State Version
        • Get Workspace’s Current State Version
      • Teams
        • The Team resource
        • List Teams
        • Create a Team
        • Delete a Team
        • Get a Team
        • Update a Team
      • Users
        • The User resource
        • Invite a User to the Account
        • Remove a User from the Account
        • List Users
        • Create a User
        • Delete a User
        • Get a User
        • Update a User
      • Variables
        • The Variable resource
        • List Variables
        • Create a Variable
        • Delete a Variable
        • Get a Variable
        • Update a Variable
      • Vcs Providers
        • The VcsProvider resource
        • List VCS Providers
        • Create a VCS Provider
        • Delete a VCS Provider
        • Get a VCS Provider
        • Update a VCS Provider
      • 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 Shell Variables
    • Usage
    • Example
    • Data Sources
      • scalr_access_policy Data Source
        • Example Usage
        • Argument Reference
        • Attribute Reference
      • scalr_agent_pool Data Source
        • Example Usage
        • Argument Reference
        • Attribute Reference
      • 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_module_version Data Source
        • Example Usage
        • Argument Reference
        • Attribute Reference
      • scalr_role Data Source
        • Example Usage
        • Argument Reference
        • Attribute Reference
      • scalr_vcs_provider Data Source
        • Example Usage
        • Argument Reference
        • Attribute Reference
      • 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_access_policy Resource
        • Example Usage
        • Argument Reference
        • Attribute Reference
      • scalr_agent_pool Resource
        • Example Usage
        • Argument Reference
        • Attribute Reference
        • Import
      • scalr_agent_pool_token Resource
        • Example Usage
        • Argument Reference
        • Attribute Reference
        • Import
      • scalr_endpoint Resource
        • Example Usage
        • Argument Reference
        • Attribute Reference
        • Useful snippets
      • scalr_environment Resource
        • Example Usage
        • Argument Reference
        • Attributes
      • scalr_module Resource
        • Example Usage
        • Argument Reference
        • Attribute Reference
        • Import
      • scalr_role Resource
        • Example Usage
        • Argument Reference
        • Attribute Reference
        • Import
      • scalr_variable Resource
        • Example Usage
        • Argument Reference
        • Attribute Reference
        • Import
      • scalr_vcs_provider 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
    • Managing Terraform and OPA Versions
    • Extra Configuration
      • Custom Docker Image
        • Pull From the Registry
        • Build an Image in Scalr
      • Private Docker Registry Config
      • Disk quota
        • Configuration of the xfs volume
      • 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?
    • How do I call a private module in Scalr?
      • 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?
    • 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?
    • What IPs should I whitelist for scalr.io if needed?
    • What is a Run?
    • Is there a credential helper?
TACO
  • »
  • FAQ

FAQ¶

Our FAQ articles will answer common questions. Each article is 1-2 minute read.

  • How do I configure VCS automation?
  • How do I migrate existing state to Scalr?
  • How do I call a private module in Scalr?
  • How do I use provider credentials in Scalr?
  • How do I apply policy to CLI runs?
  • How do I get data and state from other workspaces?
  • What IPs should I whitelist for scalr.io if needed?
  • What is a Run?
  • Is there a credential helper?
Next Previous

© Copyright 2021, scalr_team Revision dc682b41.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: latest
Versions
latest
Downloads
html
On Read the Docs
Project Home
Builds
Free document hosting provided by Read the Docs.