Navigation
modules
next
|
« SaltStack.org
|
Documentation home
Full Table of Contents
ΒΆ
Introduction to Salt
Distributed remote execution
Simplicity
Parallel execution
Building on proven technology
Python client interface
Fast, flexible, scalable
Open
Installation
Dependencies
Optional Dependencies
Platform-specific installation instructions
Arch Linux
Debian & Ubuntu
Fedora & CentOS / Enterprise Linux
FreeBSD
Gentoo
Windows
Configuring Salt
Running Salt
Manage Salt public keys
Targeting
Matching the
minion
id
Globbing
Regular Expressions
Lists
Grains
Grains in the Minion Config
Writing Grains
Node groups
Compound matchers
Remote execution tutorial
Order your minions around
target
function
arguments
How Do I Use Salt States?
It is All Just Data
Default Data - YAML
Adding Configs and Users
Moving Beyond a Single SLS
Extending Included SLS Data
Understanding the Render System
Getting to Know the Default - yaml_jinja
Introducing the Python Renderer
States tutorial, part 1
Setting up the Salt State Tree
Preparing the Top File
Create an
sls
module
Install the package
Next steps
States tutorial, part 2
Call multiple States
Expand the SLS module
Require other states
Next steps
States tutorial, part 3
Templating SLS modules
Using Grains in SLS modules
Calling Salt modules from templates
Advanced SLS module syntax
Include
declaration
Extend
declaration
Name
declaration
Names
declaration
Continue learning
Opening the Firewall up for Salt
iptables
pf.conf
Boostrapping Salt on Linux EC2 with Cloud-Init
Used With Boto
Additional Notes
Pillar of Salt
Declaring the Master Pillar
Footnotes
Refreshing Pillar Data
Targeting with Pillar
Job Management
The Minion proc System
Functions in the saltutil Module
The jobs Runner
active
lookup_jid
list_jobs
Troubleshooting
Running in the Foreground
What Ports do the Master and Minion Need Open?
Using salt-call
Too many open files
Salt Master Stops Responding
Red Hat Enterprise Linux 5
Common YAML Gotchas
YAML Idiosyncrasies
Spaces vs Tabs
Indentation
Nested Dicts (key=value)
Integers are Parsed as Integers
YAML does not like "Double Short Decs"
Community
Mailing List
IRC
Follow on Github
The Red45 Blog
Example Salt States
Follow on ohloh
Developing Salt
Posting patches to the mailing list
Setting a Github pull request
Contributions Welcome!
Introduction to Extending Salt
Client API
Adding Loadable Plugins
Minion Execution Modules
Grains
States
Renderers
Returners
Runners
Modules
Easy Modules to write
Cross Calling Modules
Preloaded Modules Data
Grains Data
Module Configuration
Printout Configuration
Virtual Modules
Documentation
Adding Documentation to Salt Modules
How Functions are Read
Objects Loaded Into the Salt Minion
Objects NOT Loaded into the Salt Minion
Examples of Salt Modules
Full list of builtin modules
salt.modules.pkg
salt.modules.sys
salt.modules.apache
salt.modules.apt
salt.modules.archive
salt.modules.butterkvm
salt.modules.cluster
salt.modules.cmd
salt.modules.cp
salt.modules.cron
salt.modules.data
salt.modules.debconfmod
salt.modules.disk
salt.modules.django
salt.modules.ebuild
salt.modules.file
salt.modules.freebsdkmod
salt.modules.freebsdpkg
salt.modules.freebsdservice
salt.modules.gem
salt.modules.gentoo_service
salt.modules.git
salt.modules.grains
salt.modules.groupadd
salt.modules.hg
salt.modules.hosts
salt.modules.kmod
salt.modules.kvm_hyper
salt.modules.linux_sysctl
salt.modules.mdadm
salt.modules.moosefs
salt.modules.mount
salt.modules.mysql
salt.modules.network
salt.modules.nginx
salt.modules.pacman
salt.modules.pillar
salt.modules.pip
salt.modules.ps
salt.modules.publish
salt.modules.puppet
salt.modules.pw_group
salt.modules.pw_user
salt.modules.rh_ip
salt.modules.rh_service
salt.modules.rvm
salt.modules.saltutil
salt.modules.selinux
salt.modules.service
salt.modules.shadow
salt.modules.solr
Apache Solr Salt Module
salt.modules.ssh
salt.modules.state
salt.modules.status
salt.modules.systemd
salt.modules.test
salt.modules.tomcat
salt.modules.upstart
salt.modules.useradd
salt.modules.virt
salt.modules.virtualenv
salt.modules.win_disk
salt.modules.win_file
salt.modules.win_network
salt.modules.win_service
salt.modules.win_shadow
salt.modules.win_useradd
salt.modules.yumpkg
salt.modules.yumpkg5
salt.modules.zypper
Returners
Using Returners
Writing a Returner
Examples
Full list of builtin returners
salt.returners.local
salt.returners.cassandra_return
salt.returners.mongo_return
salt.returners.redis_return
Extending External SLS Data
The Extend Declaration
The Requisite "in" Statement
Rules to Extend By
Failhard Global Option
State Level Failhard
Global Failhard
Highstate data structure definitions
The Salt State Tree
Include declaration
Module reference
ID declaration
Extend declaration
State declaration
Requisite declaration
Requisite reference
Function declaration
Function arg declaration
Name declaration
Names declaration
Large example
State Enforcement
State management
Understanding the Salt State System Components
Salt SLS System
Renderer System
Ordering States
Requisite Statements
Multiple Requisites
The Require Requisite
The Watch Requisite
Watch and the Watcher Function
The Order Option
Arbitrary Module Redirects
Requisites
Requisite and Requisite in types
Require
Watch
Use
The Top File
Environments
Other Ways of Targeting Minions
State Modules
States are - Easy to Write!
Using Custom State Modules
Cross Calling Modules
Return Data
Watcher Function
Mod_init Interface
Full list of builtin states
salt.states.alias
Aliases File Management
salt.states.cmd
Command Executions
salt.states.cron
Cron Management
salt.states.file
File Management
salt.states.gem
Management of rubygems
salt.states.group
Group Management
salt.states.host
Hosts File Management
salt.states.kmod
Kernel Module Management
salt.states.mount
Mount Management
salt.states.mysql_database
MySQL Database Management
salt.states.mysql_grants
MySQL Grant Management
salt.states.mysql_user
MySQL User Management
salt.states.network
Network Management
salt.states.pip
Management of python packages
salt.states.pkg
Package Management
salt.states.postgres_database
Postgres Database Management
salt.states.rvm
Management of ruby installations and gemsets with RVM
salt.states.service
Service Management
salt.states.ssh_auth
SSH Authorized Key Management
salt.states.sysctl
Kernel Sysctl Management
salt.states.user
User Management
salt.states.virtualenv
Renderers
Multiple Renderers
Writing Renderers
Examples
Full list of builtin renderers
salt.renderers.json_jinja
salt.renderers.json_mako
salt.renderers.yaml_jinja
salt.renderers.yaml_mako
salt.renderers.py
Salt Runners
Writing Salt Runners
Examples
Peer Communication
Configuration
Salt Syndic
Configuring the Syndic
Running the Syndic
Python client API
Using the LocalClient API
Compound Command Execution With the Salt API
Salt File Server
The cp Module
Environments
get_file
File Server Client API
FileClient Class
File Server Configuration
Environments
Directory Overlay
Local File Server
Dynamic Module Distribution
Sync Via States
Sync Via the saltutil Module
Configuration file examples
Example master configuration file
Example minion configuration file
Configuring the Salt Master
Primary Master Configuration
interface
publish_port
user
worker_threads
ret_port
root_dir
pki_dir
cachedir
keep_jobs
sock_dir
Master Security Settings
open_mode
auto_accept
Master Module Management
runner_dirs
cython_enable
Master State System Settings
state_top
external_nodes
renderer
failhard
test
Master File Server Settings
file_roots
hash_type
file_buffer_size
Pillar Configuration
pillar_roots
ext_pillar
Syndic Server Settings
order_masters
syndic_master
Peer Publish Settings
peer
Node Groups
Master Logging Settings
log_file
log_level
log_granular_levels
Configuring the Salt Minion
Minion Primary Configuration
master
master_port
user
pki_dir
id
sub_timeout
cachedir
cache_jobs
acceptance_wait_time
Minion Module Management
disable_modules
disable_returners
module_dirs
returner_dirs
states_dirs
render_dirs
cython_enable
State Management Settings
renderer
state_verbose
autoload_dynamic_modules
environment
Security Settings
open_mode
Thread Settings
Minion Logging Settings
log_file
log_level
log_granular_levels
Command Line Reference
Using the Salt Command
Defining the Target Minions
More Powerful Targets
Calling the Function
Compound Command Execution
salt
Synopsis
Description
Options
See also
salt-master
Synopsis
Description
Options
See also
salt-minion
Synopsis
Description
Options
See also
salt-key
Synopsis
Description
Options
salt-cp
Synopsis
Description
Options
See also
salt-call
Synopsis
Options
See also
salt-run
Synopsis
Description
Options
See also
salt-syndic
Synopsis
Description
Options
See also
Abstract on Salt Authentication and Encryption
Message Formatting
PubKey Handshake
Regular Communication
Source Files Implimenting Components
Conclusion
Release notes and upgrade instructions
Salt 0.6.0 release notes
Salt 0.7.0 release notes
Salt 0.8.0 release notes
Salt-cp -
Cython minion modules -
Dynamic Returners -
Configurable Minion Modules -
Advanced Minion Threading:
Salt 0.8.7 release notes
Salt 0.8.8 release notes
Salt 0.8.9 Release Notes
Download!
New Features
New Modules
Salt 0.9.0 Release Notes
Download!
New Features
New Modules
Salt 0.9.2 Release Notes
Download!
New Features
Notable Bug Fixes
Salt 0.9.3 Release Notes
Download!
New Features
Module and State Additions
Salt 0.9.4 Release Notes
Download!
New Features
Salt 0.9.5 Release Notes
Community
Major Features
Packaging Updates
Refinement
Salt 0.9.6 Release Notes
New Features
Salt 0.9.7 Release Notes
Major Features
Salt 0.9.8 Release Notes
Upgrade Considerations
Major Features
In Progress Development
Salt 0.9.9 Release Notes
Major Features
New Tests
Project Versions
latest
v0.9.9
v0.9.8
v0.9.7
v0.9.6
v0.9.5
v0.9.4
v0.9.3
v0.9.2
v0.9.1
RTD Search
Full-text doc search.
Next topic
Introduction to Salt
Quick search
Enter search terms or a module, class or function name.
Navigation
modules
next
|
« SaltStack.org
|
Documentation home