saltstack/salt
1
0
Fork 0
mirror of https://github.com/saltstack/salt.git synced 2025-04-17 10:10:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Added note regarding missing spm exe on Debian/Ubuntu

Browse source 
Minor fixes to spm docs
This commit is contained in:
Jacob Hammons 2015-10-21 22:34:45 -06:00
parent 8e08f39381
commit cfadda0c0c
3 changed files with 27 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/ref/cli/spm.rst
View file

@ -4,7 +4,7 @@
``spm``
=======
Salt Package Manager
:ref:`Salt Package Manager <spm>`
Synopsis
========

6
doc/topics/releases/2015.8.0.rst
View file

@ -39,6 +39,12 @@ SPM (Salt Package Manager)
Allows Salt formulas to be packaged for ease of deployment. See :ref:`spm <spm>`.
.. note::
The spm executable was not included in the Debian or Ubuntu packages for the
2015.8.0 or the 2015.8.1 releases. This executable will be included in an
upcoming release. As a workaround, copy the SPM script from the salt library
installation into ``/usr/local/bin`` or your local equivalent.
Specify a Single Environment for Top Files
==========================================

27
doc/topics/spm/index.rst
View file

@ -3,7 +3,7 @@
====================
Salt Package Manager
====================
The Salt Package Manager, or SPM, allows Salt formulas to be packaged, for ease
The Salt Package Manager, or :ref:`SPM <spm-cli>`, allows Salt formulas to be packaged, for ease
of deployment. The design of SPM was influenced by other existing packaging
systems including RPM, Yum, and Pacman.
@ -15,7 +15,7 @@ packages is often a Git repository, such as those found at the
``saltstack-formulas`` organization on GitHub.
FORMULA
-----------
-------
In addition to the formula itself, a ``FORMULA`` file must exist which
describes the package. An example of this file is:
@ -60,6 +60,10 @@ For instance, if this version was released in June 2015, the package version
should be ``201506``. If multiple released are made in a month, the ``releasee``
field should be used.
minimum_version
~~~~~~~~~~~~~~~
Minimum recommended version of Salt to use this formula. Not currently enforced.
release
~~~~~~~
This field refers primarily to a release of a version, but also to multiple
@ -71,6 +75,7 @@ summary
A one-line description of the package.
description
~~~~~~~~~~~
A more detailed description of the package which can contain more than one line.
Optional Fields
@ -94,7 +99,15 @@ are already treated specially, such as ``pillar.example`` and ``_modules/``.
dependencies
~~~~~~~~~~~~
A list of packages which must be installed before this package can function.
A list of packages which must be installed before this package can function. If
a matching package is found in an SPM repository, the dependency is installed
automatically.
recommended
~~~~~~~~~~~
A list of optional packages that are recommended to be installed with the
package. This list is displayed in an informational message
when the package is installed to SPM.
Building a Package
------------------
@ -167,11 +180,11 @@ To install from a repository, use the ``spm install`` command:
spm install apache
To install from a local file, use the ``spm local_install`` command:
To install from a local file, use the ``spm local install`` command:
.. code-block:: bash
spm local_install /srv/spm/apache-201506-1.spm
spm local install /srv/spm/apache-201506-1.spm
Currently, SPM does not check to see if files are already in place before
installing them. That means that existing files will be overwritten without
@ -243,8 +256,8 @@ By default, package files are installed using the ``local`` module. This module
applies files to the local filesystem, on the machine that the package is
installed on.
Please see the SPM Development Guide for information on creating new modules
for package file management.
Please see the :ref:`SPM Development Guide <spm-development>` for information
on creating new modules for package file management.
SPM Configuration