Merge pull request #27116 from jacobhammons/release-docs-2015.5

Update latest to 2015.8, 2015.5 is now previous
This commit is contained in:
Justin Findlay 2015-09-15 01:34:27 -06:00
commit 088b1dbb3e
11 changed files with 146 additions and 37 deletions

View file

@ -21,12 +21,12 @@
{% set script_files = [
'_static/js/core.min.js',
'_static/js/webhelp.min_v1.4.1.js',
'_static/js/webhelp.min_v1.4.2.js',
] %}
{% set css_files = [
'_static/css/core.min.css',
'_static/css/webhelp.min_v1.4.1.css',
'_static/css/webhelp.min_v1.4.2.css',
] %}
{%- macro relbar() %}
@ -160,6 +160,12 @@
</div>
{% endif %}
{% if build_type == "inactive" and on_saltstack %}
<div id="dev-notification">
<div class="alert alert-warning dev-notification-text releaselinks" role="alert"><i class="glyphicon glyphicon-cog"></i> You are viewing docs from a branch that is no longer active. You might want to view docs for the <a data-container="body" data-toggle="tooltip" data-placement="bottom" title="Docs for the latest stable release" href="/en/latest/">{{ latest_release }}</a> release instead.</div>
</div>
{% endif %}
{%- block document %}
<div class="body-content">
{% block body %} {% endblock %}
@ -192,8 +198,11 @@
{% elif build_type == "previous" %}
<p>You are viewing docs for the previous stable release, {{ previous_release }}. Switch to docs for the latest stable release, <a data-container="body" data-toggle="tooltip" data-placement="bottom" title="Docs for the latest stable release" href="/en/latest/">{{ latest_release }}</a>, or to a recent doc build from the <a data-container="body" data-toggle="tooltip" data-placement="bottom" title="Latest docs from the develop branch" href="/en/develop/">develop</a> branch.</p>
{% elif build_type == "inactive" %}
<p>You are viewing docs for an inactive release, {{ previous_release }}. Switch to docs for the latest stable release, <a data-container="body" data-toggle="tooltip" data-placement="bottom" title="Docs for the latest stable release" href="/en/latest/">{{ latest_release }}</a>, or to a recent doc build from the <a data-container="body" data-toggle="tooltip" data-placement="bottom" title="Latest docs from the develop branch" href="/en/develop/">develop</a> branch.</p>
{% elif build_type == "develop" %}
<p>You are viewing docs built from a recent snapshot of the develop branch. Switch to docs for the latest stable release, <a data-container="body" data-toggle="tooltip" data-placement="bottom" title="Docs for the latest stable release" href="/en/latest/">{{ latest_release }}</a>, or to docs for the previous stable release, <a data-container="body" data-toggle="tooltip" data-placement="bottom" title="Docs for the previous stable release" href="/en/{{ previous_release_dir }}/">{{ previous_release }}</a>.</p>
<p>You are viewing docs built from a recent snapshot of the develop branch. Switch to docs for the latest stable release, <a data-container="body" data-toggle="tooltip" data-placement="bottom" title="Docs for the latest stable release" href="/en/latest/">{{ latest_release }}</a>.</p>
{% endif %}
<br>
@ -203,12 +212,9 @@
<div class="col-sm-6">
<a href="http://saltstack.com/saltstack-enterprise-4-0-now-with-gui/" target="_blank"><img class="nolightbox nav-banner" src="{{ pathto('_static/images/saltStack_enterprise_350x125.jpg', 1) }}"/></a>
<a href="http://saltstack.com/events/" target="_blank"><img class="nolightbox nav-banner center" src="{{ pathto('_static/images/saltStack_events_300x300.jpg', 1) }}"/></a>
<br/><br/>
<p><b>SaltStack Training</b></p>
<p><a href="http://www.saltstack.com/training/">Now offering remote attendee training!</a></p>
</div>
</div>
{% endif %}
@ -224,9 +230,9 @@
<a class="ss-logo" href="http://saltstack.com"><img width="250" height="63" class="nolightbox center" src="{{ pathto('_static/images/saltstack_logo.svg', 1) }}"></a>
{% if on_saltstack %}
<div class="versions {{ build_type }}">
<div class="releaselinks versions {{ build_type }}">
<a class="btn btn-secondary{% if build_type == "previous" %} active{% endif %}" id="previous"{% if build_type == "previous" %} title="View release notes"{% else %} title="Switch to docs for the previous stable release"{% endif %} data-container="body" data-toggle="tooltip" data-placement="bottom" href="/en/{{ previous_release_dir }}/">{{ previous_release }}{% if build_type == "previous" %} <i class="glyphicon glyphicon-ok"></i>{%- endif %}</a>
<a class="btn btn-secondary{% if build_type == "previous" or build_type == "inactive" %} active{% endif %}" id="previous"{% if build_type == "previous" or build_type == "inactive" %} title="View release notes"{% else %} title="Switch to docs for the previous stable release"{% endif %} data-container="body" data-toggle="tooltip" data-placement="bottom" href="/en/{{ previous_release_dir }}/">{{ previous_release }}{% if build_type == "previous" or build_type == "inactive" %} <i class="glyphicon glyphicon-ok"></i>{%- endif %}</a>
<a class="btn btn-secondary{% if build_type == "latest" %} active{% endif %}" id="latest"{% if build_type == "latest" %} title="View release notes"{% else %} title="Switch to docs for the latest stable release"{% endif %} data-container="body" data-toggle="tooltip" data-placement="bottom" href="/en/latest/">{{ latest_release }}{% if build_type == "latest" %} <i class="glyphicon glyphicon-ok"></i>{% endif %}</a>

View file

@ -21,11 +21,11 @@ img.center{display:block;margin:auto}
.list-group-item{border:none;padding-left:25px}
.list-group-item a{color:#333;display:list-item}
h1,h2,h3,h4,h5,h6,.h1,.h2,.h3,.h4,.h5,.h6{text-transform:uppercase}
h1,.h1,h1 > code.docutils.literal{color:#48b4fb;font-size:40px;margin-top:10px;margin-bottom:30px}
h2,.h2,h2 > code.docutils.literal{color:#48b4fb;font-size:23px}
h3,.h3,h3 > code.docutils.literal{font-size:18px}
h4,.h4,h4 > code.docutils.literal{font-size:16px}
h5,.h5,h5 > code.docutils.literal{font-size:16px;font-style:italic}
h1,.h1{color:#48b4fb;font-size:40px;margin-top:10px;margin-bottom:30px}
h2,.h2{color:#48b4fb;font-size:23px}
h3,.h3{font-size:18px}
h4,.h4{font-size:16px}
h5,.h5{font-size:16px;font-style:italic}
.subhead{color:#C0392B;font-size:16px;text-transform:uppercase}
.reference h3{font-size:16pt;line-height:1.9;color:#D75400;font-weight:300}
.head3 h2{font-size:21px;color:#C0392B}
@ -144,7 +144,8 @@ ul.nav.collapsed li{padding:0 0 15px 10px;margin:0}
.open>.dropdown-menu{width:100%}
#lnav-title{font-weight:300;font-size:16pt;text-align:center}
pre{border-top-width:4px;padding-top:18px}
code{font-family:Monaco,Menlo,Consolas,"Courier New",monospace;font-size:12px;color:#333;-webkit-border-radius:3px;-moz-border-radius:3px;border-radius:3px;white-space:nowrap;background-color:rgba(0,0,0,.1)}
code{font-family:Monaco,Menlo,Consolas,"Courier New",monospace;color:#333;-webkit-border-radius:3px;-moz-border-radius:3px;border-radius:3px;white-space:nowrap;background-color:rgba(0,0,0,.1)}
p code{font-size:12px}
code.xref{color:#4070a0}
code.descclassname{background-color:transparent;border:none}
code.descname{background-color:transparent;font-weight:700;font-size:1.5em}

Binary file not shown.

Before

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

View file

@ -115,7 +115,7 @@ $( document ).ready(function() {
});
/*version page selector*/
$( 'div.versions' ).on('click', 'a', function (e) {
$( 'div.releaselinks' ).on('click', 'a', function (e) {
e.preventDefault();
var clickedVer = $(this).attr("href");
var $currentVer = $( 'div.versions' ).find( 'a.active' ).first();
@ -188,4 +188,4 @@ function resizeend() {
function last(list) {
return list[list.length - 1];
}
}

View file

@ -155,23 +155,25 @@ project = 'Salt'
copyright = '2015 SaltStack, Inc.'
version = salt.version.__version__
latest_release = '2015.5.5' # latest release
previous_release = '2014.7.6' # latest release from previous branch
previous_release_dir = '2014.7' # path on web server for previous branch
build_type = 'latest' # latest, previous, develop
latest_release = '2015.8.0' # latest release
previous_release = '2015.5.5' # latest release from previous branch
previous_release_dir = '2015.5' # path on web server for previous branch
build_type = 'previous' # latest, previous, develop, inactive
# set release to 'version' for develop so sha is used
# - otherwise -
# set release to 'latest_release' or 'previous_release'
release = latest_release # version, latest_release, previous_release
release = previous_release # version, latest_release, previous_release
# Set google custom search engine
if release == latest_release:
search_cx = '004624818632696854117:yfmprrbw3pk'
search_cx = '004624818632696854117:yfmprrbw3pk' # latest
elif release.startswith('2014.7'):
search_cx = '004624818632696854117:thhslradbru'
search_cx = '004624818632696854117:thhslradbru' # 2014.7
elif release.startswith('2015.5'):
search_cx = '004624818632696854117:ovogwef29do' # 2015.5
else:
search_cx = '004624818632696854117:haj7bjntf4s' # develop
@ -222,7 +224,7 @@ rst_prolog = """\
<p>x86: <a href="https://repo.saltstack.com/windows/Salt-Minion-{release}-x86-Setup.exe"><strong>Salt-Minion-{release}-x86-Setup.exe</strong></a>
| <a href="https://repo.saltstack.com/windows/Salt-Minion-{release}-x86-Setup.exe.md5"><strong>md5</strong></a></p>
<p>AMD64: <a href="https://repo.saltstack.com/windows/Salt-Minion-{release}-AMD64-Setup.exe"><strong>Salt-Minion-{release}-AMD64-Setup.exe</strong></a>
<p>AMD64: <a href="https://repo.saltstack.com/windows/Salt-Minion-{release}-AMD64-Setup.exe"><strong>Salt-Minion-{release}-AMD64-Setup.exe</strong></a>
| <a href="https://repo.saltstack.com/windows/Salt-Minion-{release}-AMD64-Setup.exe.md5"><strong>md5</strong></a></p>
""".format(release=release)

View file

@ -1,3 +1,5 @@
.. _faq:
Frequently Asked Questions
==========================
@ -289,3 +291,18 @@ More information about salting the Salt master can be found in the salt-formula
for salt itself:
https://github.com/saltstack-formulas/salt-formula
.. _faq-grain-security:
Is Targeting using Grain Data Secure?
=====================================
Because grains can be set by users that have access to the minion configuration
files on the local system, grains are considered less secure than other
identifiers in Salt. Use caution when targeting sensitive operations or setting
pillar values based on grain data.
When possible, you should target sensitive operations and data using the Minion
ID. If the Minion ID of a system changes, the Salt Minion's public key must be
re-accepted by an administrator on the Salt Master, making it less vulnerable
to impersonation attacks.

View file

@ -154,15 +154,6 @@ The ``__virtual__`` function is used to return either a
False is returned then the module is not loaded, if a string is returned then
the module is loaded with the name of the string.
.. note::
Optionally, modules may additionally return a list of reasons that a module could
not be loaded. For example, if a dependency for 'my_mod' was not met, a
__virtual__ function could do as follows:
return False, ['My Module must be installed before this module can be
used.']
This means that the package manager modules can be presented as the ``pkg`` module
regardless of what the actual module is named.
@ -181,6 +172,16 @@ function. Some examples:
Modules which return a string from ``__virtual__`` that is already used by a module that
ships with Salt will _override_ the stock module.
Returning Error Information from ``__virtual__``
------------------------------------------------
Optionally, modules may additionally return a list of reasons that a module could
not be loaded. For example, if a dependency for 'my_mod' was not met, a
__virtual__ function could do as follows:
return False, ['My Module must be installed before this module can be
used.']
Documentation
=============

View file

@ -60,6 +60,87 @@ installer:
Salt-Minion-0.17.0-Setup-amd64.exe /S /master=yoursaltmaster /minion-name=yourminionname
Running the Salt Minion on Windows as an Unprivileged User
==========================================================
Notes:
- These instructions were tested with Windows Server 2008 R2
- They are generalizable to any version of Windows that supports a salt-minion
A. Create the Unprivileged User that the Salt Minion will Run As
----------------------------------------------------------------
1. Click "Start", "Control Panel", "User Accounts"
2. Click "Add or remove user accounts"
3. Click "Create new account"
4. Enter "salt-user" (or a name of your preference) in the "New account name" field
5. Select the "Standard user" radio button
6. Click the "Create Account" button
7. Click on the newly created user account
8. Click the "Create a password" link
9. In the "New password" and "Confirm new password" fields, provide a password (e.g "SuperSecretMinionPassword4Me!")
10. In the "Type a password hint" field, provide appropriate text (e.g. "My Salt Password")
11. Click the "Create password" button
12. Close the "Change an Account" window
B. Add the New User to the Access Control List for the Salt Folder
------------------------------------------------------------------
1. In a File Explorer window, browse to the path where Salt is installed (the default path is C:\Salt)
2. Right-click on the "Salt" folder and select "Properties"
3. Click on the "Security" tab
4. Click the "Edit" button
5. Click the "Add" button
6. Type the name of your designated Salt user and click the "OK" button
7. Check the box to "Allow" the "Modify" permission
8. Click the "OK" button
9. Click the "OK" button to close the "Salt Properties" window
C. Update the Windows Service User for the "salt-minion" Service
----------------------------------------------------------------
1. Click "Start", "Administrative Tools", "Services"
2. In the list of Services, Right-Click on "salt-minion" and select "Properties"
3. Click the "Log On" tab
4. Click the "This account" radio button
5. Provide the account credentials created in section A
6. Click the "OK" button
7. Click the "OK" button to the prompt confirming that the user "has been granted the Log On As A Service right"
8. Click the "OK" button to the prompt confirming that "The new logon name will not take effect until you stop and restart the service"
9. Right-Click on "salt-minion" and select "Stop"
10. Right-Click on "salt-minion" and select "Start"
Setting up a Windows build environment
======================================

View file

@ -5,10 +5,10 @@ Release notes
See the :doc:`version numbers</topics/releases/version_numbers>` page for more
information about the version numbering scheme.
Latest Stable Release
Latest Branch Release
=====================
|current_release_doc|
|current_release_doc|
Previous Releases
=================

View file

@ -405,7 +405,8 @@ def sync_utils(saltenv=None, refresh=True):
def sync_all(saltenv=None, refresh=True):
'''
Sync down all of the dynamic modules from the file server for a specific
environment
environment. This function synchronizes custom modules, states, beacons,
grains, returners, outputters, renderers, and utils.
refresh : True
Also refresh the execution modules available to the minion.