Logo
Scalr Docs Terraform Automation and Collaboration Software

Using Scalr

  • Introduction
    • What is Scalr?
    • Why use Scalr?
    • How do I get started?
  • Structuring Scalr
    • Accounts
      • Shared Objects
      • Assigned Objects
    • Environments
    • Video
  • VCS Providers
    • Github
    • Github Enterprise
    • 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
    • Other Methods
  • Provider Configurations
    • Overview
    • Configuration Types
      • AWS
        • Service Trusted Entities
        • Scalr Account Trusted Entity
        • Temporary Credentials
        • Account Trusted Entity
      • Azure
      • Google
      • Scalr
      • Custom Providers
    • Examples
      • Workspaces with Multiple Configs
    • Supported Modules
  • 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
      • Auto-Queue Runs
      • Custom Hooks
        • Built-In Variables
        • Hook Examples
      • Container Image Info
      • Run Triggers
      • Run Scheduler
      • Run Timeout
      • State Rollback
      • .terraformignore
    • Runs
      • Runs Queue
      • Target Resources
      • Schedule a Run
  • Reports
    • Terraform Versions
  • Identity and Access Management
    • IAM Summary
    • Roles
      • System Roles
      • Custom Roles
    • Access Policies
    • Role & Access Policy Examples
    • Adding Teams & Users
      • Teams
      • Inviting Users
    • Single Sign-On
      • Configuration
      • Okta Example
      • Azure AD SSO Example
      • Users and Teams with SSO
      • Break Glass Users
    • Service Accounts
  • Policy as Code
    • Using OPA in Scalr
    • Using Variables in OPA
    • 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
  • Integrations
    • Datadog
    • Slack
  • 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

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
    • OpenAPI Spec
  • 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
        • Create an Access Token
        • Delete an Access Token
        • Get an Access Token
        • Update an Access Token
        • List Agent Pool Access Tokens
        • Create an Agent Pool Access Token
      • Account_blob_settings
        • The AccountBlobSettings resource
        • Delete Blob Settings
        • Get Blob Settings
        • Update Blob Settings
        • Replace Blob Settings
      • Accounts
        • The Account resource
        • No docstring
        • Get an Account
        • Update Account
        • No docstring
      • 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 breakdown JSON output
        • 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
        • Delete environment’s tags
        • List environment’s tags
        • Replace environment’s tags
        • Add tags to the environment
      • Event Definitions
        • The EventDefinition resource
        • List Event Definitions
      • Modules
        • The Module resource
        • The ModuleVersion 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
      • Ping
        • Ping
      • Plans
        • The Plan resource
        • Get a Plan
        • JSON Output
        • Plan Log
        • Sanitized JSON Output
      • Policies
        • The Policy resource
        • Get a Policy
      • Policy Checks
        • The PolicyCheck resource
        • Get a Policy Check
        • Override Policy
        • Policy Check Log
        • List Policy Checks
      • Policy Group Environments
        • The PolicyGroup resource
        • Update policy group environments relationships
        • Create policy group environments relationships
        • Delete policy group’s environment relationship
      • Policy Groups
        • The PolicyGroup resource
        • List Policy Groups
        • Create a Policy Group
        • Delete a Policy Group
        • Get a Policy Group
        • Update a Policy Group
      • Provider Configuration Links
        • The ProviderConfigurationLink resource
        • Delete a Provider configuration workspace link
        • Get a Provider configuration link
        • Update a Provider configuration link
        • List Provider configuration workspace links
        • Attach a Provider configuration to the workspace
      • Provider Configuration Params
        • The ProviderConfigurationParameter resource
        • Delete a Provider configuration parameter
        • Get a Provider configuration parameter
        • Update a Provider configuration parameter
        • List Provider configuration parameters for specific provider configurations
        • Create a Provider configuration parameter
      • Provider Configurations
        • The ProviderConfiguration resource
        • List Provider configurations
        • Create a Provider configuration
        • Delete a Provider configuration
        • Get a Provider configuration
        • Update a Provider configuration
      • Remote State Consumers
        • The Workspace resource
        • Delete remote state consumers
        • List remote state consumers
        • Replace remote state consumers
        • Add remote state consumers
      • Roles
        • The Role resource
        • List Roles
        • Create a Role
        • Delete a Role
        • Get a Role
        • Update a Role
      • Run Triggers
        • The RunTrigger resource
        • Create a Run Trigger.
        • Delete a Run Trigger
        • Get a Run Trigger
      • Runs
        • The Run resource
        • List Runs
        • Create a Run
        • List Runs Queue
        • Get a Run
        • Apply a Run
        • Cancel a Run
        • Discard a Run
        • Force 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
      • Tags
        • The Tag resource
        • List Tags
        • Create a Tag
        • Delete a Tag
        • Get a Tag
        • Update a Tag
      • Teams
        • The Team resource
        • List Teams
        • Create a Team
        • Delete a Team
        • Get a Team
        • Update a Team
      • Usage Statistics
        • The UsageStatistic resource
        • List Scalr Usage Statistics
      • 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
        • Lock a Workspace
        • Resync a Workspace
        • Set scheduled runs for the workspace
        • Unlock a Workspace
        • Delete workspace’s tags
        • List workspace’s tags
        • Replace workspace’s tags
        • Add tags to the workspace
  • Scalr Terraform Provider
    • Overview
    • Authentication
      • Authentication with Shell Variables
      • Authentication when Managing Scalr Objects
    • Usage
    • Example
    • Data Sources
      • Data Source scalr_access_policy
        • Example Usage
        • Argument Reference
        • Attribute Reference
      • Data Source scalr_agent_pool
        • Example Usage
        • Argument Reference
        • Attribute Reference
      • Data Source scalr_current_run
        • Example Usage
        • Argument Reference
        • Attribute Reference
      • Data Source scalr_endpoint
        • Example Usage
        • Argument Reference
        • Attribute Reference
      • Data Source scalr_environment
        • Example Usage
        • Arguments
        • Attributes
      • Data Source scalr_iam_team
        • Example Usage
        • Argument Reference
        • Attribute Reference
      • Data Source scalr_iam_user
        • Example Usage
        • Argument Reference
        • Attribute Reference
      • Data Source scalr_module_version
        • Example Usage
        • Argument Reference
        • Attribute Reference
      • Data Source scalr_policy_group
        • Example Usage
        • Argument Reference
        • Attribute Reference
      • Data Source scalr_provider_configuration
        • Example Usage
        • Argument Reference
        • Attribute Reference
      • Data Source scalr_provider_configurations
        • Example Usage
        • Argument Reference
        • Attribute Reference
      • Data Source scalr_role
        • Example Usage
        • Argument Reference
        • Attribute Reference
      • Data Source scalr_tag
        • Example Usage
        • Arguments
        • Attributes
      • Data Source scalr_variable
        • Example Usage
        • Argument Reference
        • Attribute Reference
      • Data Source scalr_variables
        • Example Usage
        • Argument Reference
        • Attribute Reference
      • Data Source scalr_vcs_provider
        • Example Usage
        • Argument Reference
        • Attribute Reference
      • Data Source scalr_webhook
        • Example Usage
        • Argument Reference
        • Attribute Reference
      • Data Source scalr_workspace
        • Example Usage
        • Argument Reference
        • Attribute Reference
      • Data Source scalr_workspace_ids
        • Example Usage
        • Argument Reference
        • Attribute Reference
    • Resources
      • Resource scalr_access_policy
        • Example Usage
        • Argument Reference
        • Attribute Reference
      • Resource scalr_account_allowed_ips
        • Example Usage
        • Argument Reference
        • Attribute Reference
        • Import
      • Resource scalr_agent_pool
        • Example Usage
        • Argument Reference
        • Attribute Reference
        • Import
      • Resource scalr_agent_pool_token
        • Example Usage
        • Argument Reference
        • Attribute Reference
        • Import
      • Resource scalr_endpoint
        • Example Usage
        • Argument Reference
        • Attribute Reference
        • Useful snippets
      • Resource scalr_environment
        • Example Usage
        • Argument Reference
        • Attributes
      • Resource scalr_iam_team
        • Example Usage
        • Argument Reference
        • Attribute Reference
        • Import
      • Resource scalr_module
        • Example Usage
        • Argument Reference
        • Attribute Reference
        • Import
      • Resource scalr_policy_group
        • Example Usage
        • Argument Reference
        • Attribute Reference
        • Import
      • Resource scalr_policy_group_linkage
        • Example Usage
        • Argument Reference
        • Attribute Reference
        • Import
      • Resource scalr_provider_configuration
        • Basic Usage
        • Argument Reference
        • Attribute Reference
      • Resource scalr_role
        • Example Usage
        • Argument Reference
        • Attribute Reference
        • Import
      • Resource scalr_run_trigger
        • Example Usage
        • Argument Reference
        • Attribute Reference
        • Import
      • Resource scalr_tag
        • Example Usage
        • Argument Reference
        • Attributes
      • Resource scalr_variable
        • Example Usage
        • Argument Reference
        • Attribute Reference
        • Import
      • Resource scalr_vcs_provider
        • Example Usage
        • Argument Reference
        • Attribute Reference
        • Import
      • Resource scalr_webhook
        • Example Usage
        • Argument Reference
        • Attributes
      • Resource scalr_workspace
        • Example Usage
        • Argument Reference
        • Attribute Reference
        • Import
      • Resource scalr_workspace_run_schedule
        • Example Usage
        • Argument Reference
        • Attribute Reference

Tutorials

  • Tutorials
    • VCS (Gitops) Driven Workspace
      • Getting Started
      • Adding Github credentials to Scalr
      • Create Workspace
      • Test Run
    • CLI Workspace
      • Getting Started
      • User or Service Account
      • Create Workspace
      • Test Run
    • Getting Started - Scalr Provider
      • Getting Started
      • Create a Service Account
      • Create a Management Environment
      • Set the Service Account Token
      • Provider Tutorials
        • Provider Configurations
    • Authenticate to Git with SSH Keys
      • Prerequisites
      • Steps

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, OPA and Infracost Versions
    • Extra Configuration
      • Custom Docker Image
        • Pull From the Registry
        • Build an Image in Scalr
      • Self Signed Certificates
        • Scalr Agent
        • Terraform Containers
      • 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
    • Infracost Installation
  • FAQ
    • Whitelisting
      • What IPs need to be whitelisted for Scalr access?
      • Can my Scalr account be limited to specific IPs?
    • How is my Terraform state stored
    • Are Provider Credentials required in Scalr?
      • Provider Credentials Outside of Scalr
    • How do I migrate or update Terraform state in Scalr?
      • Updating or Manipulating State
    • What are Scalr Environments?
    • Why do I need the Scalr hierarchy?
    • 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 get data and state from other workspaces?
    • What is a run?
    • Is there a credential helper?
    • How do I fix a Github Auth Issue?
TACO
  • »
  • Self Hosted Scalr »
  • Extra Configuration

Extra Configuration¶

This section provides guidance on extra configuration options for a self-hosted Scalr.

  • Custom Docker Image
    • Pull From the Registry
    • Build an Image in Scalr
  • Self Signed Certificates
    • Scalr Agent
    • Terraform Containers
  • Private Docker Registry Config
  • Disk quota
    • Configuration of the xfs volume
  • IAM Role Delegation Configuration
  • External Authentication
    • SAML Integration
      • SAML Example : Okta
      • SAML Example : Azure AD SSO
      • Users and Teams with SAML
    • LDAP Integration
      • Integration with Scalr
      • Configuration
      • Users and Teams with LDAP
  • Enable Email Integration
    • Configuring Email
Next Previous

© Copyright 2022, Scalr Inc Revision 3ec44d7d.

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.