chef 12.22.1 → 12.22.3

data/distro/common/markdown/man8/chef-server.mkd

@@ -1,120 +1,120 @@
-chef-server(8) - Start the Chef Server merb application slice.
-========================================
-
-## SYNOPSIS
-
-__chef-server__ _(options)_
-
-  * `-u`, `--user USER`:
-    This  flag  is  for having chef-server-webui run as a user other than the
-    one currently logged in. Note: if you set this you must also provide a
-    --group option for it to take effect.
-  * `-G`, `--group GROUP`:
-    This flag is for having chef-server-webui run as a group other than the
-    one currently logged in. Note: if you set this you  must also provide a
-    --user option for it to take effect.
-  * `-d`, `--daemonize`:
-    This will run a single chef-server-webui in the background.
-  * `-N`, `--no-daemonize`:
-    This will allow you to run a cluster in console mode.
-  * `-c`, `--cluster-nodes NUM_MERBS`:
-    Number of merb daemons to run for chef-server-webui.
-  * `-I`, `--init-file FILE`:
-    File to use for initialization on load, defaults to config/init.rb.
-  * `-p`, `--port PORTNUM`:
-    Port to run chef-server-webui on, defaults to 4040. Additional nodes (-c)
-    listen on incrementing port numbers.
-  * `-o`, `--socket-file FILE`:
-    Socket  file  to  run  chef-server-webui on, defaults to
-    [Merb.root]/log/merb.sock. This is for web servers, like thin, that use
-    sockets. Specify this *only* if you *must*.
-  * `-s`, `--socket SOCKNUM`:
-    Socket number to run chef-server-webui on, defaults to 0.
-  * `-n`, `--name NAME`:
-    Set the name of the application. This is used in the process title and
-    log file names.
-  * `-P`, `--pid PIDFILE`:
-    PID file, defaults to [Merb.root]/log/merb.main.pid for the master
-    process and[Merb.root]/log/merb.[port number].pid for  worker processes.
-    For clusters, use %s to specify where in the file chef-server-webui
-    should place the port number. For instance: -P myapp.%s.pid.
-  * `-h`, `--host HOSTNAME`:
-    Host to bind to (default is 0.0.0.0).
-  * `-m`, `--merb-root PATH_TO_APP_ROOT`:
-    The path to the Merb.root for the app you want to run
-    (default is current working directory).
-  * `-a`, `--adapter ADAPTER`:
-    The rack adapter to use to run chef-server-webui (default is mongrel)
-    [mongrel, emongrel, thin, ebb, fastcgi, webrick].
-  * `-R`, `--rackup FILE`:
-    Load an alternate Rack config file (default is config/rack.rb).
-  * `-i`, `--irb-console`:
-    This flag will start chef-server-webui in irb console mode. All your models
-    and other classes will be available for you in an irb session.
-  * `-S`, `--sandbox`:
-    This flag will enable a sandboxed irb console. If your ORM supports
-    transactions, all edits will be rolled back on exit.
-  * `-l`, `--log-level LEVEL`:
-    Log levels can be set to any of these options:
-    debug < info < warn < error < fatal (default is info).
-  * `-L`, `--log LOGFILE`:
-    A string representing the logfile to use. Defaults to
-    [Merb.root]/log/merb.[main].log for the master process and
-    [Merb.root]/log/merb[port number].logfor worker processes.
-  * `-e`, `--environment STRING`:
-    Environment to run Merb under [development, production, testing]
-    (default is development).
-  * `-r`, `--script-runner ['RUBY CODE'| FULL_SCRIPT_PATH]`:
-    Command-line option to run scripts and/or code in the chef-server-webui
-    app.
-  * `-K`, `-graceful PORT or all`:
-    Gracefully kill chef-server-webui proceses by port number.
-    Use chef-server -K all to gracefully kill all merbs.
-  * `-k`, `--kill PORT`:
-    Force kill one merb worker by port number. This will cause the worker
-    to be respawned.
-  * `--fast-deploy`:
-    Reload the code, but not yourinit.rb or gems.
-  * `-X`, `--mutex on/off`:
-    This flag is for turning the mutex lock on and off.
-  * `-D`, `--debugger`:
-    Run chef-server-webui using rDebug.
-  * `-V`, `--verbose`:
-    Print extra information.
-  * `-C`, `--console-trap`:
-    Enter an irb console on ^C.
-  * `-?`, `-H`, `--help`:
-    Show this help message.
-
-## DESCRIPTION
-
-The Chef Server provides a central point for the distribution of Cookbooks,
-management and authentication of Nodes, and the use of Search. It provides
-a REST API.
-
-The API service is what clients use to interact with the server to manage
-node configuration in Chef. By default, the service is started on port 4000
-as a Merb application slice running with the thin server adapter.
-
-The two methods of interaction with the API for humans are the command-line
-tool Knife and the Management Console. The Chef Client library is used for
-interacting with the API for client nodes.
-
-## SEE ALSO
-
-__chef-client__(8)
-__chef-server-webui__(8)
-__knife__(1)
-
-Full documentation for Chef and chef-server is located on docs site, http://docs.chef.io/.
-
-## AUTHOR
-
-Chef was written by Adam Jacob <adam@ospcode.com> of Opscode
-(http://www.opscode.com),  with contributions from the community.  This
-manual page was written by Joshua Timberman  <joshua@opscode.com>  with
-help2man.  Permission  is  granted  to copy, distribute and / or modify
-this document under the terms of the Apache 2.0 License.
-
-On Debian systems, the complete text of the Apache 2.0 License  can  be
-found in /usr/share/common-licenses/Apache-2.0.
+chef-server(8) - Start the Chef Server merb application slice.
+========================================
+
+## SYNOPSIS
+
+__chef-server__ _(options)_
+
+  * `-u`, `--user USER`:
+    This  flag  is  for having chef-server-webui run as a user other than the
+    one currently logged in. Note: if you set this you must also provide a
+    --group option for it to take effect.
+  * `-G`, `--group GROUP`:
+    This flag is for having chef-server-webui run as a group other than the
+    one currently logged in. Note: if you set this you  must also provide a
+    --user option for it to take effect.
+  * `-d`, `--daemonize`:
+    This will run a single chef-server-webui in the background.
+  * `-N`, `--no-daemonize`:
+    This will allow you to run a cluster in console mode.
+  * `-c`, `--cluster-nodes NUM_MERBS`:
+    Number of merb daemons to run for chef-server-webui.
+  * `-I`, `--init-file FILE`:
+    File to use for initialization on load, defaults to config/init.rb.
+  * `-p`, `--port PORTNUM`:
+    Port to run chef-server-webui on, defaults to 4040. Additional nodes (-c)
+    listen on incrementing port numbers.
+  * `-o`, `--socket-file FILE`:
+    Socket  file  to  run  chef-server-webui on, defaults to
+    [Merb.root]/log/merb.sock. This is for web servers, like thin, that use
+    sockets. Specify this *only* if you *must*.
+  * `-s`, `--socket SOCKNUM`:
+    Socket number to run chef-server-webui on, defaults to 0.
+  * `-n`, `--name NAME`:
+    Set the name of the application. This is used in the process title and
+    log file names.
+  * `-P`, `--pid PIDFILE`:
+    PID file, defaults to [Merb.root]/log/merb.main.pid for the master
+    process and[Merb.root]/log/merb.[port number].pid for  worker processes.
+    For clusters, use %s to specify where in the file chef-server-webui
+    should place the port number. For instance: -P myapp.%s.pid.
+  * `-h`, `--host HOSTNAME`:
+    Host to bind to (default is 0.0.0.0).
+  * `-m`, `--merb-root PATH_TO_APP_ROOT`:
+    The path to the Merb.root for the app you want to run
+    (default is current working directory).
+  * `-a`, `--adapter ADAPTER`:
+    The rack adapter to use to run chef-server-webui (default is mongrel)
+    [mongrel, emongrel, thin, ebb, fastcgi, webrick].
+  * `-R`, `--rackup FILE`:
+    Load an alternate Rack config file (default is config/rack.rb).
+  * `-i`, `--irb-console`:
+    This flag will start chef-server-webui in irb console mode. All your models
+    and other classes will be available for you in an irb session.
+  * `-S`, `--sandbox`:
+    This flag will enable a sandboxed irb console. If your ORM supports
+    transactions, all edits will be rolled back on exit.
+  * `-l`, `--log-level LEVEL`:
+    Log levels can be set to any of these options:
+    debug < info < warn < error < fatal (default is info).
+  * `-L`, `--log LOGFILE`:
+    A string representing the logfile to use. Defaults to
+    [Merb.root]/log/merb.[main].log for the master process and
+    [Merb.root]/log/merb[port number].logfor worker processes.
+  * `-e`, `--environment STRING`:
+    Environment to run Merb under [development, production, testing]
+    (default is development).
+  * `-r`, `--script-runner ['RUBY CODE'| FULL_SCRIPT_PATH]`:
+    Command-line option to run scripts and/or code in the chef-server-webui
+    app.
+  * `-K`, `-graceful PORT or all`:
+    Gracefully kill chef-server-webui proceses by port number.
+    Use chef-server -K all to gracefully kill all merbs.
+  * `-k`, `--kill PORT`:
+    Force kill one merb worker by port number. This will cause the worker
+    to be respawned.
+  * `--fast-deploy`:
+    Reload the code, but not yourinit.rb or gems.
+  * `-X`, `--mutex on/off`:
+    This flag is for turning the mutex lock on and off.
+  * `-D`, `--debugger`:
+    Run chef-server-webui using rDebug.
+  * `-V`, `--verbose`:
+    Print extra information.
+  * `-C`, `--console-trap`:
+    Enter an irb console on ^C.
+  * `-?`, `-H`, `--help`:
+    Show this help message.
+
+## DESCRIPTION
+
+The Chef Server provides a central point for the distribution of Cookbooks,
+management and authentication of Nodes, and the use of Search. It provides
+a REST API.
+
+The API service is what clients use to interact with the server to manage
+node configuration in Chef. By default, the service is started on port 4000
+as a Merb application slice running with the thin server adapter.
+
+The two methods of interaction with the API for humans are the command-line
+tool Knife and the Management Console. The Chef Client library is used for
+interacting with the API for client nodes.
+
+## SEE ALSO
+
+__chef-client__(8)
+__chef-server-webui__(8)
+__knife__(1)
+
+Full documentation for Chef and chef-server is located on docs site, http://docs.chef.io/.
+
+## AUTHOR
+
+Chef was written by Adam Jacob <adam@ospcode.com> of Opscode
+(http://www.opscode.com),  with contributions from the community.  This
+manual page was written by Joshua Timberman  <joshua@opscode.com>  with
+help2man.  Permission  is  granted  to copy, distribute and / or modify
+this document under the terms of the Apache 2.0 License.
+
+On Debian systems, the complete text of the Apache 2.0 License  can  be
+found in /usr/share/common-licenses/Apache-2.0.

data/distro/common/markdown/man8/chef-solo.mkd

@@ -1,107 +1,107 @@
-chef-solo(8) -- Runs chef in solo mode against a specified cookbook location.
-========================================
-
-## SYNOPSIS
-
-__chef-solo__ _(options)_
-
-  * `-c`, `--config CONFIG`:
-    The configuration file to use
-  * `-d`, `--daemonize`:
-    Daemonize the process
-  * `-g`, `--group GROUP`:
-    Group to set privilege to
-  * `-i`, `--interval SECONDS`:
-    Run chef-client periodically, in seconds
-  * `-j`, `--json-attributes JSON_ATTRIBS`:
-    Load attributes from a JSON file or URL
-  * `-l`, `--log_level LEVEL`:
-    Set the log level (debug, info, warn, error, fatal)
-  * `-L`, `--logfile LOGLOCATION`:
-    Set the log file location, defaults to STDOUT - recommended for
-    daemonizing
-  * `-N`, `--node-name NODE_NAME`:
-    The node name for this client
-  * `-r`, `--recipe-url RECIPE_URL`:
-    Pull  down  a  remote  gzipped  tarball of recipes and untar it to the
-    cookbook cache.
-  * `-s`, `--splay SECONDS`:
-    The splay time for running at intervals, in seconds
-  * `-u`, `--user USER`:
-    User to set privilege to
-  * `-v`, `--version`:
-    Show chef version
-  * `-h`, `--help`:
-    Show this message
-
-## DESCRIPTION
-
-Chef Solo allows you to run Chef Cookbooks in the absence of a Chef Server.
-To do this, the complete cookbook needs to be present on disk.
-
-By default Chef Solo will look in /etc/chef/solo.rb for its configuration.
-This configuration file has two required variables: file_cache_path and
-cookbook_path.
-
-For example:
-    file_cache_path "/var/chef-solo"
-    cookbook_path "/var/chef-solo/cookbooks"
-
-For your own systems, you can change this to reflect any directory you like,
-but you'll need to specify absolute paths and the cookbook_path directory
-should be a subdirectory of the file_cache_path.
-
-You can also specify cookbook_path as an array, passing multiple locations
-to search for cookbooks.
-
-For example:
-    file_cache_path "/var/chef-solo"
-    cookbook_path ["/var/chef-solo/cookbooks", "/var/chef-solo/site-cookbooks"]
-
-Note that earlier entries are now overridden by later ones.
-
-Since chef-solo doesn't have any interaction with a Chef Server, you'll need
-to specify node-specifc attributes in a JSON file. This can be located on the
-target system itself, or it can be stored on a remote server such as S3, or a
-web server on your network.
-
-Within the JSON file, you'll also specify the recipes that Chef should run in
-the "run_list". An example JSON file, which sets a resolv.conf:
-
-    {
-      "resolver": {
-        "nameservers": [ "10.0.0.1" ],
-        "search":"int.example.com"
-      },
-      "run_list": [ "recipe[resolver]" ]
-    }
-
-Then you can run chef-solo with -j to specify the JSON file. It will look for
-cookbooks in the cookbook_path configured in the configuration file, and apply
-attributes and use the run_list from the JSON file specified.
-
-You can use -c to specify the path to the configuration file (if you don't want
-chef-solo to use the default). You can also specify -r for a cookbook tarball.
-
-For example:
-    chef-solo -c ~/solo.rb -j ~/node.json  -r http://www.example.com/chef-solo.tar.gz
-
-In the above case, chef-solo would extract the tarball to your specified
-cookbook_path, use ~/solo.rb as the configuration file, and apply attributes
-and use the run_list from ~/node.json.
-
-## SEE ALSO
-
-Full documentation for Chef and  chef-solo  is  located  on  the  Chef  docs site,
-http://docs.chef.io/.
-
-## AUTHOR
-
-Chef was written by Adam Jacob <adam@ospcode.com> of Opscode
-(http://www.opscode.com),  with contributions from the community.  This
-manual page was written by Joshua Timberman  <joshua@opscode.com>  with
-help2man.  Permission  is  granted  to copy, distribute and / or modify
-this document under the terms of the Apache 2.0 License.
-
-On Debian systems, the complete text of the Apache 2.0 License  can  be
-found in /usr/share/common-licenses/Apache-2.0.
+chef-solo(8) -- Runs chef in solo mode against a specified cookbook location.
+========================================
+
+## SYNOPSIS
+
+__chef-solo__ _(options)_
+
+  * `-c`, `--config CONFIG`:
+    The configuration file to use
+  * `-d`, `--daemonize`:
+    Daemonize the process
+  * `-g`, `--group GROUP`:
+    Group to set privilege to
+  * `-i`, `--interval SECONDS`:
+    Run chef-client periodically, in seconds
+  * `-j`, `--json-attributes JSON_ATTRIBS`:
+    Load attributes from a JSON file or URL
+  * `-l`, `--log_level LEVEL`:
+    Set the log level (debug, info, warn, error, fatal)
+  * `-L`, `--logfile LOGLOCATION`:
+    Set the log file location, defaults to STDOUT - recommended for
+    daemonizing
+  * `-N`, `--node-name NODE_NAME`:
+    The node name for this client
+  * `-r`, `--recipe-url RECIPE_URL`:
+    Pull  down  a  remote  gzipped  tarball of recipes and untar it to the
+    cookbook cache.
+  * `-s`, `--splay SECONDS`:
+    The splay time for running at intervals, in seconds
+  * `-u`, `--user USER`:
+    User to set privilege to
+  * `-v`, `--version`:
+    Show chef version
+  * `-h`, `--help`:
+    Show this message
+
+## DESCRIPTION
+
+Chef Solo allows you to run Chef Cookbooks in the absence of a Chef Server.
+To do this, the complete cookbook needs to be present on disk.
+
+By default Chef Solo will look in /etc/chef/solo.rb for its configuration.
+This configuration file has two required variables: file_cache_path and
+cookbook_path.
+
+For example:
+    file_cache_path "/var/chef-solo"
+    cookbook_path "/var/chef-solo/cookbooks"
+
+For your own systems, you can change this to reflect any directory you like,
+but you'll need to specify absolute paths and the cookbook_path directory
+should be a subdirectory of the file_cache_path.
+
+You can also specify cookbook_path as an array, passing multiple locations
+to search for cookbooks.
+
+For example:
+    file_cache_path "/var/chef-solo"
+    cookbook_path ["/var/chef-solo/cookbooks", "/var/chef-solo/site-cookbooks"]
+
+Note that earlier entries are now overridden by later ones.
+
+Since chef-solo doesn't have any interaction with a Chef Server, you'll need
+to specify node-specifc attributes in a JSON file. This can be located on the
+target system itself, or it can be stored on a remote server such as S3, or a
+web server on your network.
+
+Within the JSON file, you'll also specify the recipes that Chef should run in
+the "run_list". An example JSON file, which sets a resolv.conf:
+
+    {
+      "resolver": {
+        "nameservers": [ "10.0.0.1" ],
+        "search":"int.example.com"
+      },
+      "run_list": [ "recipe[resolver]" ]
+    }
+
+Then you can run chef-solo with -j to specify the JSON file. It will look for
+cookbooks in the cookbook_path configured in the configuration file, and apply
+attributes and use the run_list from the JSON file specified.
+
+You can use -c to specify the path to the configuration file (if you don't want
+chef-solo to use the default). You can also specify -r for a cookbook tarball.
+
+For example:
+    chef-solo -c ~/solo.rb -j ~/node.json  -r http://www.example.com/chef-solo.tar.gz
+
+In the above case, chef-solo would extract the tarball to your specified
+cookbook_path, use ~/solo.rb as the configuration file, and apply attributes
+and use the run_list from ~/node.json.
+
+## SEE ALSO
+
+Full documentation for Chef and  chef-solo  is  located  on  the  Chef  docs site,
+http://docs.chef.io/.
+
+## AUTHOR
+
+Chef was written by Adam Jacob <adam@ospcode.com> of Opscode
+(http://www.opscode.com),  with contributions from the community.  This
+manual page was written by Joshua Timberman  <joshua@opscode.com>  with
+help2man.  Permission  is  granted  to copy, distribute and / or modify
+this document under the terms of the Apache 2.0 License.
+
+On Debian systems, the complete text of the Apache 2.0 License  can  be
+found in /usr/share/common-licenses/Apache-2.0.