Skip to content

Commit d7732ff

Browse files
author
Delivery Server
committed
Merged change e5546bf4-ff87-47cf-a758-94d878b6cce0
From review branch _reviews/master/jscott/updatedscresourcelinks/4 into master Signed-off-by: jscott <[email protected]>
2 parents 4a22675 + 386dc74 commit d7732ff

20 files changed

+197
-106
lines changed

chef_master/source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
=====================================================
2-
All about |chef|
2+
All about |chef|
33
=====================================================
44

55
.. include:: ../../includes_chef/includes_chef_index.rst

chef_master/source/install_delivery_aws.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -333,7 +333,7 @@ To verify provisioning (from inside the ``delivery-cluster`` directory), do the
333333
334334
$ rake info:list_core_services
335335
336-
#. Navigate to your CHEF_SERVER_URL, and then login with ``delivery:delivery``.
336+
#. Navigate to your CHEF_SERVER_URL, and then login with ``delivery:delivery``. Use ``rake info:delivery_creds`` to get the password.
337337
#. Click on **Nodes**. You’ll see your |chef delivery| server, your build nodes, and nodes for any other optional features that you installed.
338338
#. Get the credentials and URL with the following command:
339339

@@ -346,13 +346,13 @@ To verify provisioning (from inside the ``delivery-cluster`` directory), do the
346346

347347
.. code-block:: bash
348348
349-
$ knife node status
349+
$ knife node list
350350
351351
All build nodes should report available.
352352

353353
Configure Delivery
354354
=====================================================
355-
In |chef delivery| there are multiple levels of organization: enterprises, organizations, and projects. The provisioning step created the initial enterprise you specified in your environment file as the first ``name`` option. Enterprises are designed to provide units of multi-tenancy with separate sets of organizations and users. Next, set up |chef delivery| by adding users and organizations.
355+
In |chef delivery| there are multiple levels of organization: enterprises, organizations, and projects, where enterprise contain one (or more) organizations and organizations contain one (or more) projects. The provisioning step created the initial enterprise you specified in your environment file as the first ``name`` option. Enterprises are designed to provide units of multi-tenancy with separate sets of organizations and users. Next, set up |chef delivery| by adding users and organizations.
356356

357357
.. note:: |chef delivery| by default hosts a git server that you interact with through the delivery CLI commands. Additionally, you can integrate GitHub Enterprise or GitHub.com.
358358

includes_resources/includes_resource_12-3_remote_file_attributes.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,4 +156,4 @@ This resource has the following properties:
156156

157157
|verify_file|
158158

159-
.. include:: ../../includes_resources_common/includes_resources_common_attribute_verify.rst
159+
.. include:: ../../includes_resources/includes_resource_remote_file_attributes_verify.rst

includes_resources/includes_resource_cookbook_file_attributes.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,6 @@ This resource has the following properties:
114114

115115
|verify_file|
116116

117-
.. include:: ../../includes_resources_common/includes_resources_common_attribute_verify.rst
117+
.. include:: ../../includes_resources/includes_resource_cookbook_file_attributes_verify.rst
118118

119119
.. note:: .. include:: ../../includes_notes/includes_notes_resource_properties_use_owner_and_right.rst
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
.. The contents of this file are included in multiple topics.
2+
.. This file should not be changed in a way that hinders its ability to appear in multiple documentation sets.
3+
4+
A block is arbitrary |ruby| defined within the resource block by using the ``verify`` property. When a block is ``true``, the |chef client| will continue to update the file as appropriate.
5+
6+
For example, this should return ``true``:
7+
8+
.. code-block:: ruby
9+
10+
cookbook_file '/tmp/baz' do
11+
verify { 1 == 1 }
12+
end
13+
14+
This should return ``true``:
15+
16+
.. code-block:: ruby
17+
18+
cookbook_file '/etc/nginx.conf' do
19+
verify 'nginx -t -c %{path}'
20+
end
21+
22+
.. warning:: For releases of the |chef client| prior to 12.5 (|chef client| 12.4 and earlier) the correct syntax is:
23+
24+
.. code-block:: ruby
25+
26+
cookbook_file '/etc/nginx.conf' do
27+
verify 'nginx -t -c %{file}'
28+
end
29+
30+
See |github| issues https://github.com/chef/chef/issues/3232 and https://github.com/chef/chef/pull/3693 for more information about these differences.
31+
32+
This should return ``true``:
33+
34+
.. code-block:: ruby
35+
36+
cookbook_file '/tmp/bar' do
37+
verify { 1 == 1}
38+
end
39+
40+
And this should return ``true``:
41+
42+
.. code-block:: ruby
43+
44+
cookbook_file '/tmp/foo' do
45+
verify do |path|
46+
true
47+
end
48+
end
49+
50+
Whereas, this should return ``false``:
51+
52+
.. code-block:: ruby
53+
54+
cookbook_file '/tmp/turtle' do
55+
verify '/usr/bin/false'
56+
end
57+
58+
If a string or a block return ``false``, the |chef client| run will stop and an error is returned.

includes_resources/includes_resource_dsc_resource_features.rst

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,30 +10,30 @@ For built-in |windows powershell_dsc_short| resources, use the following values:
1010
* - Value
1111
- Description
1212
* - ``:archive``
13-
- Use to to `unpack archive (.zip) files <http://technet.microsoft.com/en-us/library/dn249917.aspx>`_.
13+
- Use to to `unpack archive (.zip) files <https://msdn.microsoft.com/en-us/powershell/dsc/archiveresource>`_.
1414
* - ``:environment``
15-
- Use to to `manage system environment variables <http://technet.microsoft.com/en-us/library/dn282121.aspx>`_.
15+
- Use to to `manage system environment variables <https://msdn.microsoft.com/en-us/powershell/dsc/environmentresource>`_.
1616
* - ``:file``
17-
- Use to to `manage files and directories <http://technet.microsoft.com/en-us/library/dn282129.aspx>`_.
17+
- Use to to `manage files and directories <https://msdn.microsoft.com/en-us/powershell/dsc/fileresource>`_.
1818
* - ``:group``
19-
- Use to to `manage local groups <http://technet.microsoft.com/en-us/library/dn282124.aspx>`_.
19+
- Use to to `manage local groups <https://msdn.microsoft.com/en-us/powershell/dsc/groupresource>`_.
2020
* - ``:log``
21-
- Use to to `log configuration messages <http://technet.microsoft.com/en-us/library/dn282117.aspx>`_.
21+
- Use to to `log configuration messages <https://msdn.microsoft.com/en-us/powershell/dsc/logresource>`_.
2222
* - ``:package``
23-
- Use to to `install and manage packages <http://technet.microsoft.com/en-us/library/dn282132.aspx>`_.
23+
- Use to to `install and manage packages <https://msdn.microsoft.com/en-us/powershell/dsc/packageresource>`_.
2424
* - ``:registry``
25-
- Use to to `manage registry keys and registry key values <http://technet.microsoft.com/en-us/library/dn282133.aspx>`_.
25+
- Use to to `manage registry keys and registry key values <https://msdn.microsoft.com/en-us/powershell/dsc/registryresource>`_.
2626
* - ``:script``
27-
- Use to to `run Powershell script blocks <http://technet.microsoft.com/en-us/library/dn282130.aspx>`_.
27+
- Use to to `run Powershell script blocks <https://msdn.microsoft.com/en-us/powershell/dsc/registryresource>`_.
2828
* - ``:service``
29-
- Use to to `manage services <http://technet.microsoft.com/en-us/library/dn282120.aspx>`_.
29+
- Use to to `manage services <https://msdn.microsoft.com/en-us/powershell/dsc/registryresource>`_.
3030
* - ``:user``
31-
- Use to to `manage local user accounts <http://technet.microsoft.com/en-us/library/dn282118.aspx>`_.
31+
- Use to to `manage local user accounts <https://msdn.microsoft.com/en-us/powershell/dsc/userresource>`_.
3232
* - ``:windowsfeature``
33-
- Use to to `add or remove Windows features and roles <http://technet.microsoft.com/en-us/library/dn282127.aspx>`_.
33+
- Use to to `add or remove Windows features and roles <https://msdn.microsoft.com/en-us/powershell/dsc/windowsfeatureresource>`_.
3434
* - ``:windowsoptionalfeature``
3535
- Use to configure |windows| optional features.
3636
* - ``:windowsprocess``
37-
- Use to to `configure Windows processes <http://technet.microsoft.com/en-us/library/dn282123.aspx>`_.
37+
- Use to to `configure Windows processes <https://msdn.microsoft.com/en-us/powershell/dsc/windowsprocessresource>`_.
3838

39-
Any |windows powershell_dsc_short| resource may be used in a |chef| recipe. For example, the |windows powershell_dsc_resource_kit| contains resources for `configuring Active Directory components <http://gallery.technet.microsoft.com/scriptcenter/xActiveDirectory-f2d573f3>`_, such as ``xADDomain``, ``xADDomainController``, and ``xADUser``. Assuming that these resources are available to the |chef client|, the corresponding values for the ``resource_name`` attribute would be: ``:xADDomain``, ``:xADDomainController``, and ``xADUser``.
39+
Any |windows powershell_dsc_short| resource may be used in a |chef| recipe. For example, the |windows powershell_dsc_resource_kit| contains resources for `configuring Active Directory components <http://www.powershellgallery.com/packages/xActiveDirectory/2.8.0.0>`_, such as ``xADDomain``, ``xADDomainController``, and ``xADUser``. Assuming that these resources are available to the |chef client|, the corresponding values for the ``resource_name`` attribute would be: ``:xADDomain``, ``:xADDomainController``, and ``xADUser``.

includes_resources/includes_resource_file_attributes.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,5 +119,5 @@ This resource has the following properties:
119119

120120
|verify_file|
121121

122-
.. include:: ../../includes_resources_common/includes_resources_common_attribute_verify.rst
122+
.. include:: ../../includes_resources/includes_resource_file_attributes_attribute_verify.rst
123123

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
.. The contents of this file are included in multiple topics.
2+
.. This file should not be changed in a way that hinders its ability to appear in multiple documentation sets.
3+
4+
A block is arbitrary |ruby| defined within the resource block by using the ``verify`` property. When a block is ``true``, the |chef client| will continue to update the file as appropriate.
5+
6+
For example, this should return ``true``:
7+
8+
.. code-block:: ruby
9+
10+
file '/tmp/baz' do
11+
verify { 1 == 1 }
12+
end
13+
14+
This should return ``true``:
15+
16+
.. code-block:: ruby
17+
18+
file '/etc/nginx.conf' do
19+
verify 'nginx -t -c %{path}'
20+
end
21+
22+
.. warning:: For releases of the |chef client| prior to 12.5 (|chef client| 12.4 and earlier) the correct syntax is:
23+
24+
.. code-block:: ruby
25+
26+
file '/etc/nginx.conf' do
27+
verify 'nginx -t -c %{file}'
28+
end
29+
30+
See |github| issues https://github.com/chef/chef/issues/3232 and https://github.com/chef/chef/pull/3693 for more information about these differences.
31+
32+
This should return ``true``:
33+
34+
.. code-block:: ruby
35+
36+
file '/tmp/bar' do
37+
verify { 1 == 1}
38+
end
39+
40+
And this should return ``true``:
41+
42+
.. code-block:: ruby
43+
44+
file '/tmp/foo' do
45+
verify do |path|
46+
true
47+
end
48+
end
49+
50+
Whereas, this should return ``false``:
51+
52+
.. code-block:: ruby
53+
54+
file '/tmp/turtle' do
55+
verify '/usr/bin/false'
56+
end
57+
58+
If a string or a block return ``false``, the |chef client| run will stop and an error is returned.

includes_resources/includes_resource_remote_file_attributes.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,4 +155,4 @@ This resource has the following properties:
155155

156156
|verify_file|
157157

158-
.. include:: ../../includes_resources_common/includes_resources_common_attribute_verify.rst
158+
.. include:: ../../includes_resources/includes_resource_remote_file_attributes_verify.rst
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
.. The contents of this file are included in multiple topics.
2+
.. This file should not be changed in a way that hinders its ability to appear in multiple documentation sets.
3+
4+
A block is arbitrary |ruby| defined within the resource block by using the ``verify`` property. When a block is ``true``, the |chef client| will continue to update the file as appropriate.
5+
6+
For example, this should return ``true``:
7+
8+
.. code-block:: ruby
9+
10+
remote_file '/tmp/baz' do
11+
verify { 1 == 1 }
12+
end
13+
14+
This should return ``true``:
15+
16+
.. code-block:: ruby
17+
18+
remote_file '/etc/nginx.conf' do
19+
verify 'nginx -t -c %{path}'
20+
end
21+
22+
.. warning:: For releases of the |chef client| prior to 12.5 (|chef client| 12.4 and earlier) the correct syntax is:
23+
24+
.. code-block:: ruby
25+
26+
remote_file '/etc/nginx.conf' do
27+
verify 'nginx -t -c %{file}'
28+
end
29+
30+
See |github| issues https://github.com/chef/chef/issues/3232 and https://github.com/chef/chef/pull/3693 for more information about these differences.
31+
32+
This should return ``true``:
33+
34+
.. code-block:: ruby
35+
36+
remote_file '/tmp/bar' do
37+
verify { 1 == 1}
38+
end
39+
40+
And this should return ``true``:
41+
42+
.. code-block:: ruby
43+
44+
remote_file '/tmp/foo' do
45+
verify do |path|
46+
true
47+
end
48+
end
49+
50+
Whereas, this should return ``false``:
51+
52+
.. code-block:: ruby
53+
54+
remote_file '/tmp/turtle' do
55+
verify '/usr/bin/false'
56+
end
57+
58+
If a string or a block return ``false``, the |chef client| run will stop and an error is returned.

0 commit comments

Comments
 (0)