Developing Salt

• Overview
• Salt Client
  • Overview
• Salt Master
  • Overview
  • Moving Pieces
  • Publisher
  • EventPublisher
  • MWorker
  • ReqServer
  • Job Flow
• Salt Minion
  • Overview
  • Event System
  • Minion Job Flow
• A Note on ClearFuncs vs. AESFuncs
• Changelog
  • How do I add a changelog entry
  • How to generate the changelog
• 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
• Deprecating Code
  • Silence Deprecation Warnings
• Python 2 Deprecation FAQ
  • Why are we deprecating Python 2?
  • Was this announced/decided before making the change?
  • Can I contribute Python 2 code?
  • What if my OS does not include Python 3 packages? Or, how do I upgrade from Salt on Python 2 to Salt on Python 3?
  • Will you support a Python 3 master with an older Python 2 minion?
  • Will you support Python 2 master with a new Python 3 minion?
  • How does this impact Salt-SSH support?
  • What is your plan for removing Python 2 code?
  • Will Salt continue to package for Python 2?
• Installing Salt for development
  • Running a self-contained development version
  • Installing Salt from the Python Package Index
  • Editing and previewing the documentation
  • Running unit and integration tests
  • Issue and Pull Request Labeling System
• GitHub Labels and Milestones
  • Milestones
  • Labels
• Logging Internals
• Package Providers
  • Package Functions
  • Package Repo Functions
  • Low-Package Functions
• Pull Requests
• Pull Request Requirements
  • All PR requirements
  • Bug Fix PR requirements
  • Feature PR requirements
  • Exceptions to all requirements
• Pull Request CI/CD test suite
  • Optional OS additions
  • Optional test additions
• Release Notes
  • How do I edit the release notes
  • How to generate the release notes
• Reporting Bugs
• Salt Extensions
  • How do I deprecate a Salt module to a Salt extension
• Salt Topology
  • Servers
  • PUB/SUB
  • Return
• Developing Salt Tutorial
  • Fork
  • Clone
  • Fetch
  • Branch
  • Edit
  • Commit
  • Push
  • Merge
  • Resources
• Modular Systems
  • Developing New Modules
  • Configuration Options
  • Loading Modules
  • Module Types
• Salt Extend
  • Command line usage
  • Choosing a template
  • Adding templates
  • API
• Salt's Test Suite
  • Nox
  • System Dependencies
  • Test Directory Structure
  • Running The Tests
  • Automated Test Runs
  • Writing Tests
• Integration Tests
  • Preparing to Write Integration Tests
  • Best Practices
  • Integration Classes
  • Examples
  • Integration Test Files
  • Destructive vs Non-Destructive Tests
  • Cloud Provider Tests
  • Adding New Directories
• Writing Unit Tests
  • Introduction
  • Preparing to Write a Unit Test
  • Best Practices
  • Evaluating Truth
  • Tests Using Mock Objects
  • Modifying __salt__ In Place
  • A Simple Example
  • A More Complete Example
  • A Complex Example
• SaltStack Git Policy
  • New Code Entry
  • Release Branching
• Salt Conventions
  • Writing Salt documentation
  • Salt Formulas
  • SaltStack Packaging Guide
  • Salt Release Process
  • Salt Coding Style
• Salt code and internals
  • Contents
• Salt Community Projects
  • Hubblestack
  • alkali
  • buoyant
  • Salt Sandbox
  • Salt Vagrant Demo
• Salt's Test Suite: An Introduction
  • Getting Set Up For Tests
  • Test Directory Structure
  • Running the Test Suite
  • Writing Tests for Salt
  • Checking for Log Messages
  • Test Groups
  • Additional Testing Documentation