Salto Documentation

Welcome to the Salto docs!

You'll find comprehensive guides and documentation to help you start working with Salto as quickly as possible, as well as deep dive into Salto topics and ideas you find interesting.

Let's get started!

Get Started


Introduction to envs

Env is short for environment. As defined on Wikipedia:

[...] a computer system in which [...] software [...] is deployed and executed. In simple cases, such as developing and immediately executing a program on the same machine, there may be a single environment, but in industrial use the development environment (where changes are originally made) and production environment (what end users use) are separated; often with several stages in between. This structured release management process allows phased deployment (rollout), testing, and rollback in case of problems.

Software developers aspire for each env to be as similar to production as possible, and a critical aspect is having all the different components and services present (with exceptions where it's too costly). Similarly, each Salto env should ideally consist of all the services that take part in your production environment. This makes development, testing and delivery more predictable and reliable.

A Salto env is a set of service connections (e.g. Salesforce, NetSuite). Each service connection links to a specific account or instance of that service (e.g. a specific sandbox account). Salto operations, like fetch or deploy, always run in the context of an env.

Envs in detail

An env consists of:

  • Its name, e.g. "Dev"
  • A set of service connections (see below)

A service connection consists of:

  • Its type, e.g. salesforce, netsuite, ..
  • Its credentials protocol (see below)

A credentials protocol is your decision how Salto should manage access to each service, with two options available:

  • Share Credentials
    Salto accesses such services using a single set of credentials for all team members. This protocol is appropriate for services with a single shared API key, like HubSpot
  • Per-Member Login
    Salto accesses such services using each member's individual credentials. This protocol should be used wherever possible, as it enables better auditing and security controls

Configuring envs

Envs need only be configured once, and then can be used in any number of workspaces in your Salto organization. For the env configuration flow, see Configuring your first environment.

Using envs

Linking an env to your workspace

In order to be able to fetch and deploy an env in your workspace, you must link them together via the operations panel in your workspace. For the linking flow, see Linking an env to your workspace.

Running operations (fetchfetch - Syncs your workspace's NaCl files with the current env's services' state, deploydeploy - Deploys the current NaCl files config to the target env's services)

  • Once an env is linked to your workspace, you can run Salto's fetch and deploy on it
  • You must first fetch an env before you can do anything else like explore its configuration or deploy changes
  • Salto workspaces support working with multiple environments, so it's important to keep in mind what is your current env, which is the env currently selected in the envs dropdown control in the operations panel
  • To learn more about multiple envs, see Multi-env workspaces

Updated 3 months ago


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.