Skip to content
This repository has been archived by the owner on May 10, 2018. It is now read-only.

Commit

Permalink
edits to resources per github issue 177
Browse files Browse the repository at this point in the history
  • Loading branch information
jamescott committed Oct 10, 2013
1 parent 4bfcb8b commit 98c2716
Show file tree
Hide file tree
Showing 11 changed files with 13 additions and 13 deletions.
4 changes: 2 additions & 2 deletions includes_cookbooks/includes_cookbooks_resource_platform.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ The following resources are core resources:
- .. include:: ../../includes_resources/includes_resource_package_easy_install.rst
* - `env <http://docs.opscode.com/resource_env.html>`_
- .. include:: ../../includes_resources/includes_resource_env.rst
* - `erlang_call <http://docs.opscode.com/resource_erlang_call.html>`_
* - `erl_call <http://docs.opscode.com/resource_erlang_call.html>`_
- .. include:: ../../includes_resources/includes_resource_erlang_call.rst
* - `execute <http://docs.opscode.com/resource_execute.html>`_
- .. include:: ../../includes_resources/includes_resource_execute.rst
Expand Down Expand Up @@ -97,7 +97,7 @@ The following resources are core resources:
- .. include:: ../../includes_resources/includes_resource_script.rst
* - `service <http://docs.opscode.com/resource_service.html>`_
- .. include:: ../../includes_resources/includes_resource_service.rst
* - `smartos_package <http://docs.opscode.com/resource_smartos_package.html>`_
* - `smart_o_s_package <http://docs.opscode.com/resource_smartos_package.html>`_
- .. include:: ../../includes_resources/includes_resource_package_smartos.rst
* - `solaris_package <http://docs.opscode.com/resource_solaris_package.html>`_
- .. include:: ../../includes_resources/includes_resource_package_solaris.rst
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ The following resources are core resources:
- .. include:: ../../includes_resources/includes_resource_package_easy_install.rst
* - `env <http://docs.opscode.com/release/11-4/resource_env.html>`_
- .. include:: ../../includes_resources/includes_resource_env.rst
* - `erlang_call <http://docs.opscode.com/release/11-4/resource_erlang_call.html>`_
* - `erl_call <http://docs.opscode.com/release/11-4/resource_erlang_call.html>`_
- .. include:: ../../includes_resources/includes_resource_erlang_call.rst
* - `execute <http://docs.opscode.com/release/11-4/resource_execute.html>`_
- .. include:: ../../includes_resources/includes_resource_execute.rst
Expand Down Expand Up @@ -97,7 +97,7 @@ The following resources are core resources:
- .. include:: ../../includes_resources/includes_resource_script.rst
* - `service <http://docs.opscode.com/release/11-4/resource_service.html>`_
- .. include:: ../../includes_resources/includes_resource_service.rst
* - `smartos_package <http://docs.opscode.com/release/11-4/resource_smartos_package.html>`_
* - `smart_o_s_package <http://docs.opscode.com/release/11-4/resource_smartos_package.html>`_
- .. include:: ../../includes_resources/includes_resource_package_smartos.rst
* - `solaris_package <http://docs.opscode.com/release/11-4/resource_solaris_package.html>`_
- .. include:: ../../includes_resources/includes_resource_package_solaris.rst
Expand Down
2 changes: 1 addition & 1 deletion includes_cookbooks/includes_cookbooks_resource_syntax.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@ For example, a resource that is used to install a |tar gz| package for version 1
Every resource has its own set of actions and parameters. Many parameters have default values. Some parameters are available to all resources; these are sometimes referred to as "meta parameters" and they are commonly used to send notifications to other resources or to set up conditional execution rules. All actions have a default value. Only non-default behaviors of actions and parameters need to be specified.

.. note:: the attribute keyword associated with resources in the LWRP DSL is not the same as the 'attributes' that make up node objects
.. note:: The attribute keyword associated with resources in the LWRP DSL is not the same as the 'attributes' that make up node objects
2 changes: 1 addition & 1 deletion includes_resources/includes_resource_batch.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. The contents of this file are included in multiple topics.
.. This file should not be changed in a way that hinders its ability to appear in multiple documentation sets.
The |resource batch| resource for the |windows| platform that is used to execute a batch script using the |windows cmd exe| interpreter, much like how the |resource script| and |resource script|-based resources---|resource script_bash|, |resource script_csh|, |resource script_perl|, |resource script_python|, and |resource script_ruby|---are used. The |resource batch| is specific to the |windows| platform and |windows cmd exe| interpreter. This resource creates and executes a temporary file (similar to how the |resource script| resource behaves), rather than running the command inline. This resource includes actions (``:run`` and ``:nothing``) and attributes (``creates``, ``cwd``, ``environment``, ``group``, ``path``, ``timeout``, and ``user``) that are inherited from from the |resource execute| resource. Commands that are executed with this resource are (by their nature) not idempotent, as they are typically unique to the environment in which they are run. Use the ``not_if`` and ``only_if`` meta parameters to guard the use of this resource for idempotence.
The |resource batch| resource for the |windows| platform is used to execute a batch script using the |windows cmd exe| interpreter. The |resource batch| creates and executes a temporary file (similar to how the |resource script| resource behaves), rather than running the command inline. This resource inherited actions (``:run`` and ``:nothing``) and attributes (``creates``, ``cwd``, ``environment``, ``group``, ``path``, ``timeout``, and ``user``) from the |resource execute| resource. Commands that are executed with this resource are (by their nature) not idempotent, as they are typically unique to the environment in which they are run. Use the ``not_if`` and ``only_if`` meta parameters to guard the use of this resource for idempotence.
2 changes: 1 addition & 1 deletion includes_resources/includes_resource_breakpoint.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
.. This file should not be changed in a way that hinders its ability to appear in multiple documentation sets.
The |resource breakpoint| resource is used to add breakpoints to recipes in the same way as any other resource. When the |chef client| is run in |chef shell| mode, those breakpoints can be used to debug recipes. Breakpoints are ignored by the |chef client| during an actual |chef client| run. In general, breakpoints are used most often in a non-production environment, for the purpose of debugging recipes. After those recipes are debugged and the desired behavior has been tested, the breakpoints are typically removed from the recipes before uploading the cookbooks to a production environment (even if the |chef client| ignores then when building the resource collection during an official |chef client| run).
The |resource breakpoint| resource is used to add breakpoints to recipes in the same way as any other resource. When the |chef client| is run in |chef shell| mode, those breakpoints can be used to debug recipes. Breakpoints are ignored by the |chef client| during an actual |chef client| run. In general, breakpoints are used most often in a non-production environment, for the purpose of debugging recipes. After those recipes are debugged and the desired behavior has been tested, the breakpoints are typically removed from the recipes before uploading the cookbooks to a production environment (even if the |chef client| ignores them when building the resource collection during an official |chef client| run).

2 changes: 1 addition & 1 deletion includes_resources/includes_resource_ohai.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. The contents of this file are included in multiple topics.
.. This file should not be changed in a way that hinders its ability to appear in multiple documentation sets.
The |resource ohai| resource is used to re-load the |ohai| configuration on a node, which allows recipes that change system attributes (like adding a user) to refer to those attributes later on during the |chef client| run.
The |resource ohai| resource is used to reload the |ohai| configuration on a node, which allows recipes that change system attributes (like adding a user) to refer to those attributes later on during the |chef client| run.
2 changes: 1 addition & 1 deletion includes_resources/includes_resource_package_yum.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. The contents of this file are included in multiple topics.
.. This file should not be changed in a way that hinders its ability to appear in multiple documentation sets.
The |resource yum_package| resource is used install, upgrade, and remove packages with |yum| for the |redhat| and |centos| platforms. The |resource yum_package| resource is able to resolve ``provides`` data for packages much like |yum| can do when it is run from the command line. This allows a variety of options for installing packages, like minimum versions, virtual provides, and library names.
The |resource yum_package| resource is used to install, upgrade, and remove packages with |yum| for the |redhat| and |centos| platforms. The |resource yum_package| resource is able to resolve ``provides`` data for packages much like |yum| can do when it is run from the command line. This allows a variety of options for installing packages, like minimum versions, virtual provides, and library names.
2 changes: 1 addition & 1 deletion includes_resources/includes_resource_powershell_script.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. The contents of this file are included in multiple topics.
.. This file should not be changed in a way that hinders its ability to appear in multiple documentation sets.
The |resource powershell_script| resource is a resource for the |windows| platform that is used to execute a script using the |windows powershell| interpreter, much like how the |resource script| and |resource script|-based resources---|resource script_bash|, |resource script_csh|, |resource script_perl|, |resource script_python|, and |resource script_ruby|---are used. The |resource powershell_script| is specific to the |windows| platform and |windows powershell| interpreter. This resource creates and executes a temporary file (similar to how the |resource script| resource behaves), rather than running the command inline. This resource includes actions (``:run`` and ``:nothing``; ) and attributes (``creates``, ``cwd``, ``environment``, ``group``, ``path``, ``timeout``, and ``user``) that are inherited from from the |resource execute| resource. Commands that are executed with this resource are (by their nature) not idempotent, as they are typically unique to the environment in which they are run. Use the ``not_if`` and ``only_if`` meta parameters to guard the use of this resource for idempotence.
The |resource powershell_script| resource is a resource for the |windows| platform that is used to execute a script using the |windows powershell| interpreter, much like how the |resource script| and |resource script|-based resources---|resource script_bash|, |resource script_csh|, |resource script_perl|, |resource script_python|, and |resource script_ruby|---are used. The |resource powershell_script| is specific to the |windows| platform and |windows powershell| interpreter. This resource creates and executes a temporary file (similar to how the |resource script| resource behaves), rather than running the command inline. This resource includes actions (``:run`` and ``:nothing``; ) and attributes (``creates``, ``cwd``, ``environment``, ``group``, ``path``, ``timeout``, and ``user``) that are inherited from the |resource execute| resource. Commands that are executed with this resource are (by their nature) not idempotent, as they are typically unique to the environment in which they are run. Use the ``not_if`` and ``only_if`` meta parameters to guard the use of this resource for idempotence.
2 changes: 1 addition & 1 deletion includes_resources/includes_resource_registry_key.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
The |resource registry_key| resource is used to create and delete registry keys in |windows|.

64-bit versions of |windows| have a 32-bit compatibility layer in the registry that reflects and re-directs certain keys (and their sub-keys) into specific locations. By default, the registry functionality will default to the machine architecture of the system that is being configured. The |chef client| can access any reflected or re-directed registry key. The |chef client| can write to any 64-bit registry location. (This behavior is not affected by the |chef client| running as a 32-bit application.) For more information, see: |url msdn_registry_key|.
64-bit versions of |windows| have a 32-bit compatibility layer in the registry that reflects and redirects certain keys (and their sub-keys) into specific locations. By default, the registry functionality will default to the machine architecture of the system that is being configured. The |chef client| can access any reflected or redirected registry key. The |chef client| can write to any 64-bit registry location. (This behavior is not affected by the |chef client| running as a 32-bit application.) For more information, see: |url msdn_registry_key|.
2 changes: 1 addition & 1 deletion includes_resources/includes_resource_script.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
The |resource script| resource is used to execute scripts using the specified interpreter (|bash|, |csh|, |perl|, |python|, or |ruby|) and includes all of the actions and attributes that are available to the |resource execute| resource.

.. note:: The |resource script| script resource is different from the |resource ruby_block| resource because |ruby| code that is run with this resource is created as a temporary file and executed like other script resources, rather than run inline. Commands that are executed with this resource are (by their nature) not idempotent, as they are typically unique to the environment in which they are run. Use the ``not_if`` and ``only_if`` meta parameters to guard the use of this resource for idempotence.
.. note:: The |resource script| resource is different from the |resource ruby_block| resource because |ruby| code that is run with this resource is created as a temporary file and executed like other script resources, rather than run inline. Commands that are executed with this resource are (by their nature) not idempotent, as they are typically unique to the environment in which they are run. Use the ``not_if`` and ``only_if`` meta parameters to guard the use of this resource for idempotence.
2 changes: 1 addition & 1 deletion includes_resources/includes_resource_script_bash.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. The contents of this file are included in multiple topics.
.. This file should not be changed in a way that hinders its ability to appear in multiple documentation sets.
The |resource script_bash| resource is used to execute scripts using the |bash| interpreter and includes all of the actions and attributes that are available to the |resource execute| resource.s
The |resource script_bash| resource is used to execute scripts using the |bash| interpreter and includes all of the actions and attributes that are available to the |resource execute| resource.

.. note:: The |resource script_bash| script resource (which is based on the |resource script| resource) is different from the |resource ruby_block| resource because |ruby| code that is run with this resource is created as a temporary file and executed like other script resources, rather than run inline. Commands that are executed with this resource are (by their nature) not idempotent, as they are typically unique to the environment in which they are run. Use the ``not_if`` and ``only_if`` meta parameters to guard the use of this resource for idempotence.

0 comments on commit 98c2716

Please sign in to comment.