Windows¶

Prerequisite Software¶

To do this the easy way you only need to install Git for Windows.

Create the Build Environment¶

1. Clone the Salt-Windows-Dev repo from github.

   Open a command line and type:

   git clone https://github.com/saltstack/salt-windows-dev
   

2. Build the Python Environment

   Go into the salt-windows-dev directory. Right-click the file named dev_env.ps1 and select Run with PowerShell

   If you get an error, you may need to change the execution policy.

   Open a powershell window and type the following:

   Set-ExecutionPolicy RemoteSigned
   

   This will download and install Python with all the dependencies needed to develop and build salt.

3. Build the Salt Environment

   Right-click on the file named dev_env_salt.ps1 and select Run with Powershell

   This will clone salt into C:\Salt-Dev\salt and set it to the 2015.5 branch. You could optionally run the command from a powershell window with a -Version switch to pull a different version. For example:

   dev_env_salt.ps1 -Version '2014.7'
   

   To view a list of available branches and tags, open a command prompt in your C:Salt-Devsalt directory and type:

   git branch -a
   git tag -n
   

Prerequisite Software¶

Install the following software:

1. Git for Windows
2. Nullsoft Installer

Download the Prerequisite zip file for your CPU architecture from the SaltStack download site:

• Salt32.zip
• Salt64.zip

These files contain all sofware required to build and develop salt. Unzip the contents of the file to C:\Salt-Dev\temp.

Create the Build Environment¶

1. Build the Python Environment

   • Install Python:

     Browse to the C:\Salt-Dev\temp directory and find the Python installation file for your CPU Architecture under the corresponding subfolder. Double-click the file to install python.

     Make sure the following are in your PATH environment variable:

     C:\Python27
     C:\Python27\Scripts
     

   • Install Pip

     Open a command prompt and navigate to C:\Salt-Dev\temp Run the following command:

     python get-pip.py
     

   • Easy Install compiled binaries.

     M2Crypto, PyCrypto, and PyWin32 need to be installed using Easy Install. Open a command prompt and navigate to C:\Salt-Dev\temp\<cpuarch>. Run the following commands:

     easy_install -Z <M2Crypto file name>
     easy_install -Z <PyCrypto file name>
     easy_install -Z <PyWin32 file name>
     

     Note

     You can type the first part of the file name and then press the tab key to auto-complete the name of the file.

   • Pip Install Additional Prerequisites

     All remaining prerequisites need to be pip installed. These prerequisites are as follow:

     • MarkupSafe
     • Jinja
     • MsgPack
     • PSUtil
     • PyYAML
     • PyZMQ
     • WMI
     • Requests
     • Certifi

     Open a command prompt and navigate to C:\Salt-Dev\temp. Run the following commands:

     pip install <cpuarch>\<MarkupSafe file name>
     pip install <Jinja file name>
     pip install <cpuarch>\<MsgPack file name>
     pip install <cpuarch>\<psutil file name>
     pip install <cpuarch>\<PyYAML file name>
     pip install <cpuarch>\<pyzmq file name>
     pip install <WMI file name>
     pip install <requests file name>
     pip install <certifi file name>
     

2. Build the Salt Environment

   • Clone Salt

     Open a command prompt and navigate to C:\Salt-Dev. Run the following command to clone salt:

     git clone https://github.com/saltstack/salt
     

   • Checkout Branch

     Checkout the branch or tag of salt you want to work on or build. Open a command prompt and navigate to C:\Salt-Dev\salt. Get a list of available tags and branches by running the following commands:

     git fetch --all
     
     To view a list of available branches:
     git branch -a
     
     To view a list of availabel tags:
     git tag -n
     

     Checkout the branch or tag by typing the following command:

     git checkout <branch/tag name>
     

   • Clean the Environment

     When switching between branches residual files can be left behind that will interfere with the functionality of salt. Therefore, after you check out the branch you want to work on, type the following commands to clean the salt environment: