sfops
sfpSlackGithub
  • Overview
  • Features
  • Environments
    • Creating an Environment
    • Authenticating to Environments
    • Review Environments
      • Configuring Review Sandboxes
      • Creation and Allocation of Review Sandboxes
  • Project Workflows
    • sfops - Execute Issue Ops
    • sfops - On Pull Request Comments
    • sfops - Close Issues
    • sfops - Execute Every 30 mins
    • sfops - Daily Job Executor
    • sfops - Review Sandbox - Creator
    • sfops - On Push to Branch
    • sfops - Execute Releases to any env
    • sfops - Execute Releases
  • IssueOps
    • Access
      • Request elevated previlege in production
    • Release
      • Release a Domain
      • Hotfix Workflow
  • Changelog
    • November24
    • January25
  • DevCentral
    • Customising Menu
    • Extending using Custom Forms and Issue Ops Actions
  • self managed instances
    • Setup for self managed instances
      • 1. Create repositories
      • 2. Create a GitHub App
      • 3. Setting up sfops repository
      • 4. Trigger the workflows
      • 5. Setting up project repository
      • 6. Fetching upstream changes
        • 6.1 Manual Process for Updating sfops from Upstream
    • Update Instructions
      • Updating to v29.0.0
      • Updating to v30.3.1 and above
    • Workflow details
      • Sync Upstream Repository and Create Pull Request
  • Legal
    • Terms of Service for sfops
Powered by GitBook
On this page
  1. Environments
  2. Review Environments

Configuring Review Sandboxes

PreviousReview EnvironmentsNextCreation and Allocation of Review Sandboxes

Last updated 1 year ago

sfops provide you with a feature to create a pool of sandboxes to use as "Review Sandboxes". These sandboxes to the as mentioned in the flxbl environment management guide.

In your repository, you need to have a file similar to one below and the path configured in your project workflows for creating sandboxes (sfops-cron-ci-sandbox-create-v2.yml or your variaton).

// A sample review sandbox pool config file
[
  {
    "pool": "SALES",
    "count": 13,
    "branch":"main",
    "apexClassId": "01p8w0000009975BAA",
    "sourceSB": "q2upgshape",
    "usersToBeActivated": "master.ninja@flxbl.io,ninja.warrior@adiza.dev"
  },
  {
    "pool": "HOTFIX",
    "branch":"release",
    "count": 1,
    "apexClassId": "01p8w0000009975AAD",
    "sourceSB": "production",
     usersToBeActivated": "master.ninja@flxbl.io,ninja.warrior@adiza.dev"
  }
]

The <your-org>sfops-gh-actions/.github/workflows/sandbox-pool-creator.yml@main workflow accepts a JSON configuration file that defines settings and attributes of the sandbox pool. The properties accepted by the configuration file are shown in the table below.

pool

strimg

Name of the sandbox pool

count

int

Number of sandbox that should be attempted to allocate during one execution

branch

string

The branch which the pool should be assigned to

apexClassId

string

Id of an existing class in the source sandbox that need to be invoked after activation of the sandbox

sourceSB

string

Name of the sandbox that this sandbox has to be cloned from. If the sandbox has to be created from production, mention this attribute as 'production'

usersToBeActivated

string

Only activate the mentioned users in this sandbox and deactivate everyone else

You could have one or more of pools mentioned in a single configuration file and could have multiple configuration files. When you have more than one configuration files, ensure that you have replicated the equivalent github workflow and provided the right file path to your config file

Review sandboxes are dedicated to a single PR, if you would like to reuse review sandboxes (not recommended) due to shortage of licenses or due to issues with provisioning sandboxes, please set 'SFOPS_RETURN_REVIEW_BACK_TO_POOL' to true in your Actions/Variables

The latest schema for sandbox pool definition can be found

review category
here