Salt Table of Contents#

• Salt Project
  • About Salt
  • About our sponsors
  • Download and install Salt
  • Technical support
  • Salt Project documentation
  • Security advisories
  • Join our community
  • License
• Introduction to Salt
  • The 30 second summary
  • Simplicity
  • Parallel execution
  • Builds on proven technology
  • Python client interface
  • Fast, flexible, scalable
  • Open
• Salt system architecture
  • Overview
  • What is Salt?
  • The Salt system architecture
• Contributing to Salt: A Guide for Contributors
  • Choosing the Right Branch for Your Pull Request
  • Setting Up Your Salt Development Environment
  • Salt issues
  • Hacking away
  • Troubleshooting
• Salt Project maintenance policies
  • Issue management
  • Pull request management
  • Salt Enhancement Proposals (SEP) process
• Installation
• Configuring Salt
  • Configuring Salt
  • Configuring the Salt Master
  • Configuring the Salt Minion
  • Configuring the Salt Proxy Minion
  • Delta proxy minions
  • Configuration file examples
  • Minion Blackout Configuration
  • Access Control System
  • Job Management
  • Managing the Job Cache
  • Storing Job Results in an External System
  • Logging
  • External Logging Handlers
  • Salt File Server
  • Git Fileserver Backend Walkthrough
  • MinionFS Backend Walkthrough
  • Salt Package Manager
  • Storing Data in Other Databases
  • Running the Salt Master/Minion as an Unprivileged User
  • Using cron with Salt
  • Use cron to initiate a highstate
  • Hardening Salt
  • Security disclosure policy
  • Salt Channels
  • Salt Transport
  • Master Tops System
  • Renderers
• Using Salt
  • Grains
  • Storing Static Data in the Pillar
  • Targeting Minions
  • The Salt Mine
  • Runners
  • Salt Engines
  • What is YAML and How To Use It
  • Understanding Jinja
  • Tutorials Index
  • Troubleshooting
  • Frequently Asked Questions
  • Salt Best Practices
• Remote Execution
  • Remote execution tutorial
  • Running Commands on Salt Minions
  • Writing Execution Modules
  • Returners
  • Executors
• Configuration Management
  • How Do I Use Salt States?
  • States tutorial, part 1 - Basic Usage
  • States tutorial, part 2 - More Complex States, Requisites
  • States tutorial, part 3 - Templating, Includes, Extends
  • States tutorial, part 4
  • State System Reference
• Return Codes
  • Retcode Passthrough
• Utility Modules - Code Reuse in Custom Modules
• Events & Reactor
  • Event System
  • Beacons
  • Reactor System
• Distributed Tracing (OpenTelemetry)
  • Configuration
  • Hops covered
  • Running a quick demo
  • Fork handling
  • Payload overhead
• Metrics (OpenTelemetry)
  • Configuration
  • Instrument inventory
  • Label cardinality
  • Running a quick demo
  • Fork handling
  • Payload and CPU overhead
• Orchestration
  • Orchestrate Runner
• Solaris
  • Solaris-specific Behaviour
• Salt SSH
  • Getting Started
  • Salt SSH Roster
  • Deploy ssh key for salt-ssh
  • Calling Salt SSH
  • States Via Salt SSH
  • Targeting with Salt SSH
  • Configuring Salt SSH
  • Running Salt SSH as non-root user
  • Define CLI Options with Saltfile
  • Advanced options with salt-ssh
  • Debugging salt-ssh
  • Different Python Versions
• Thorium Complex Reactor
  • Starting the Thorium Engine
  • Thorium Modules
  • Writing Thorium Formulas
  • The Thorium Register
  • Concrete Thorium Patterns
• Salt Cloud
  • Configuration
  • Configuration Inheritance
  • QuickStart
  • Using Salt Cloud
  • Core Configuration
  • Windows Configuration
  • Cloud Provider Specifics
  • Miscellaneous Options
  • Troubleshooting Steps
  • Extending Salt Cloud
  • Using Salt Cloud from Salt
  • Feature Comparison
  • Tutorials
• Salt Proxy Minion
  • New in 2017.7.0
  • New in 2016.11.0
  • New in 2016.3
  • New in 2015.8.2
  • New in 2015.8
  • Getting Started
  • The __proxyenabled__ directive
  • SSH Proxymodules
• Salt Resources
  • Why resources?
  • When to reach for a resource (and when not to)
  • Comparison with proxy minions and salt-ssh
  • Mental model
  • Documentation map
• Network Automation
  • New in Carbon (2016.11)
  • NAPALM
  • JUNOS
• Salt Virt
  • Salt Virt Tutorial
  • The Salt Virt Runner
  • Based on Live State Data
  • Deploy from Network or Disk
• Onedir Packaging
  • Relenv onedir packaging
  • Docker Containers
  • Package Grain
  • How to build onedir only
  • How to build rpm packages
  • How to build deb packages
  • How to build MacOS packages
  • How to build Windows packages
  • How to access python binary
  • Testing the packages
• Command Line Reference
  • salt-api
  • salt-call
  • salt
  • salt-cloud
  • salt-cp
  • salt-extend
  • salt-key
  • salt-master
  • salt-minion
  • salt-proxy
  • salt-run
  • salt-ssh
  • salt-syndic
  • spm
• Pillars
• Master Tops
• Salt Module Reference
  • auth modules
  • beacon modules
  • cache modules
  • cloud modules
  • engine modules
  • execution modules
  • executors modules
  • fileserver modules
  • grains modules
  • netapi modules
  • output modules
  • pillar modules
  • proxy modules
  • queue modules
  • renderer modules
  • returner modules
  • roster modules
  • runner modules
  • sdb modules
  • serializer modules
  • state modules
  • thorium modules
  • token modules
  • master tops modules
  • wheel modules
• APIs
  • Python client API
  • netapi modules
• Architecture
  • High Availability Features in Salt
  • Salt Syndic
  • Using Salt at scale
  • Master Cluster
  • Multi Master Tutorial
  • Multi-Master-PKI Tutorial With Failover
• Minion Data Cache
  • Pluggable Data Cache
  • Configuring the Minion Data Cache
• Performance
  • Memory-Mapped Cache Backend
  • Tunable Worker Pools
• Slots
  • Execution functions
  • Example Usage
  • Execution module returns as file contents or data
• Windows
  • Multi-minion setup on Windows
  • Windows Package Manager
  • Windows-specific Behaviour
• Developing Salt
  • Overview
  • Salt Client
  • Salt Master
  • Salt Minion
  • A Note on ClearFuncs vs. AESFuncs
  • Changelog
  • Contributing to Salt: A Guide for Contributors
  • Deprecating Code
  • Python 2 Deprecation FAQ
  • Installing Salt for development
  • GitHub Labels and Milestones
  • Logging Internals
  • Package Providers
  • Pull Requests
  • Pull Request Requirements
  • Pull Request CI/CD test suite
  • Release Notes
  • Reporting Bugs
  • Salt Extensions
  • Salt Topology
  • Developing Salt Tutorial
  • Modular Systems
  • Salt Extend
  • Salt's Test Suite
  • Integration Tests
  • Writing Unit Tests
  • SaltStack Git Policy
  • Salt Conventions
  • Salt code and internals
  • Salt Community Projects
  • Salt's Test Suite: An Introduction
• Release notes
  • Upcoming release
  • Previous releases
• Venafi Tools for Salt
  • Introduction
  • Runner Functions
  • Transfer certificate to a minion
• Glossary