mirror of
https://github.com/saltstack/salt.git
synced 2025-04-16 09:40:20 +00:00
81 lines
3.2 KiB
Markdown
81 lines
3.2 KiB
Markdown
|
# How to build the msi
|
||
|
|
|
||
|
|
## Build client requirements
|
||
|
|
|
||
|
|
The build client is where the msi installer is built.
|
||
|
|
|
||
|
|
You need
|
||
|
|
- 64bit Windows 10
|
||
|
|
- Git repositories `salt`, `salt-windows-nsis` and `salt-windows-msi`
|
||
|
|
- .Net 3.5 SDK (for WiX)<sup>*</sup>
|
||
|
|
- [Wix 3](http://wixtoolset.org/releases/)<sup>**</sup>
|
||
|
|
- [Build tools 2015](https://www.microsoft.com/en-US/download/confirmation.aspx?id=48159)<sup>**</sup>
|
||
|
|
|
||
|
|
Notes:
|
||
|
|
- <sup>*</sup> `build.cmd` will open `optionalfeatures` if necessary.
|
||
|
|
- <sup>**</sup> `build.cmd` will download them to `.\_cache.dir` and install if necessary.
|
||
|
|
|
||
|
|
### Step 1: build the Nullsoft (NSIS) exe installer or use the mockup
|
||
|
|
|
||
|
|
- Build the Nullsoft (NSIS) exe installer
|
||
|
|
|
||
|
|
- Or execute `test-copy_mock_files_to_salt_repo.cmd` for only testing configuration
|
||
|
|
|
||
|
|
### Step 2: build the msi installer
|
||
|
|
|
||
|
|
Execute
|
||
|
|
|
||
|
|
build.cmd
|
||
|
|
|
||
|
|
### Remark on transaction safety
|
||
|
|
|
||
|
|
- Wix is transaction safe: either the product is installed or the prior state is restored/rolled back.
|
||
|
|
- C# is not.
|
||
|
|
|
||
|
|
### Directory structure
|
||
|
|
|
||
|
|
- Product.wxs: main file.
|
||
|
|
- (EXPERIMENTAL) salt-minion Windows Service
|
||
|
|
- requires [saltminionservice](https://github.com/saltstack/salt/blob/167cdb344732a6b85e6421115dd21956b71ba25a/salt/utils/saltminionservice.py) or [winservice](https://github.com/saltstack/salt/blob/3fb24929c6ebc3bfbe2a06554367f8b7ea980f5e/salt/utils/winservice.py) [Removed](https://github.com/saltstack/salt/commit/8c01aacd9b4d6be2e8cf991e3309e2a378737ea0)
|
||
|
|
- CustomAction01/: custom actions in C#
|
||
|
|
- *-discovered-files.wxs: TEMPORARY FILE
|
||
|
|
|
||
|
|
### Naming conventions
|
||
|
|
|
||
|
|
- **Immediate** custom actions serve initialization (before the install transaction starts) and must not change the system.
|
||
|
|
- **Deferred** custom action may change the system but run in a "sandbox".
|
||
|
|
|
||
|
|
Postfix | Example | Meaning
|
||
|
|
-------- | ---------------------------------- | -------
|
||
|
|
`_IMCAC` | `ReadConfig_IMCAC` | Immediate custom action written in C#
|
||
|
|
`_DECAC` | `WriteConfig_DECAC` | Deferred custom action written in C#
|
||
|
|
`_CADH` | `WriteConfig_CADH` | Custom action data helper (only for deferred custom action)
|
||
|
|
|
||
|
|
"Custom action data helper" send properties to the deferreed actions in the sandbox.
|
||
|
|
|
||
|
|
### Other Notes
|
||
|
|
msi conditions for install, uninstall, upgrade:
|
||
|
|
- https://stackoverflow.com/a/17608049
|
||
|
|
|
||
|
|
|
||
|
|
Install sequences documentation:
|
||
|
|
|
||
|
|
- [standard-actions-reference](https://docs.microsoft.com/en-us/windows/win32/msi/standard-actions-reference)
|
||
|
|
- [suggested-installuisequence](https://docs.microsoft.com/en-us/windows/win32/msi/suggested-installuisequence)
|
||
|
|
- [suggested-installexecutesequence](https://docs.microsoft.com/en-us/windows/win32/msi/suggested-installexecutesequence)
|
||
|
|
- [other docs](https://www.advancedinstaller.com/user-guide/standard-actions.html)
|
||
|
|
|
||
|
|
The Windows installer restricts the maximum values of the [ProductVersion property](https://docs.microsoft.com/en-us/windows/win32/msi/productversion):
|
||
|
|
|
||
|
|
- major.minor.build
|
||
|
|
- `255.255.65535`
|
||
|
|
|
||
|
|
Therefore we generate an "internal version":
|
||
|
|
- Salt 3002.1 becomes `30.02.1`
|
||
|
|
|
||
|
|
|
||
|
|
[Which Python version uses which MS VC CRT version](https://wiki.python.org/moin/WindowsCompilers)
|
||
|
|
|
||
|
|
- Python 2.7 = VC CRT 9.0 = VS 2008
|
||
|
|
- Python 3.6 = VC CRT 14.0 = VS 2017
|