Salto

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

Fetching an env for the first time

📘

What's fetch?

Fetch is perhaps Salto's most important operation. It connects to all the services in your selected env via their APIs, downloads their current configuration state, and updates your NaCl files accordingly. For a deeper explanation, read more here.

Fetching

  • In the operations panel click Fetch
  • Fetch's duration varies greatly, depending on the size of your configuration, from a couple of minutes to 20+ minutes. This is a good time to refill your :coffee:
  • The operations panel should indicate that fetch is in progress
  • When done, the operations panel returns to its actionable state, and in the operations log you should see your successful fetch
    • Clicking the completed operation will show you the fetched configuration content
    • Since this is the first fetch for this env it should contain A LOT of details
    • Future fetches should be more readable, containing much fewer details

👍

You've completed your first env fetch!

You can now explore your configuration in NaCl form for the first time! It's exciting, we know. However, don't forget to continue through this getting started tutorial, with a few very important steps left.

Pushing to Git

:arrow-right-hook: If you haven't connected Git for now, you can skip this section.

📘

What's Git push?

Git tracks changes to your configuration files in units called "commits", where each commit can contain multiple changes across multiple files. Commits are then pushed to your Git server, e.g. GitHub.

Git push in Salto's editor gathers all changes that haven't been pushed yet, bundles them all into a single commit, lets you edit the commit message title and body, and immediately pushes it to Git.

Learn more about Git in Salto here

  • In the operations panel, in the Git section, click the top-right button (that looks like a bullet list)
  • A dialog should open, showing the history of your commits, as well as the number of uncommitted changes you may have in your workspace. After an env's first fetch you should expect many uncommitted changes, in the hundreds an even thousands
  • Click Push to begin the process of pushing all these changes to Git (this may take a few seconds to load)
  • You should see the Git Push preview screen
    • You can browse files in the editor to see how they have changed. In this first fetch it's quite boring since everything was just created anew. Future pushes should have more interesting bite-sized differences to explore
  • To continue, make sure to fill in your commit message, e.g. for this first fetch perhaps just write the title First fetch of Dev (replace Dev with your env's name)
  • Click Push in the operations panel to confirm and push to Git. This may take several seconds to complete
  • Click Done and your operations panel will return to its default state

👍

You've completed your first Git push!

As mentioned, this push contained your env's entire configuration, so it wasn't very readable. In the next steps we'll be making small changes and pushing them, so expect a much more readable preview.

Updated 6 months ago



Fetching an env for the first time


Suggested Edits are limited on API Reference Pages

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