rmm-chef 0.10.0.rc.0

data/distro/common/markdown/man8/chef-expander-cluster.mkd

@@ -0,0 +1,82 @@
+chef-expander-cluster(8) -- fetches messages from RabbitMQ, processes, and loads into chef-solr
+========================================
+
+## SYNOPSIS
+
+__chef-expander-cluster__ _(options)_
+
+  * `-c`, `--config CONFIG_FILE`:
+    a configuration file to use
+  * `-i`, `--index INDEX`:
+    the slot this node will occupy in the ring
+  * `-n`, `--node-count NUMBER`:
+    the number of nodes in the ring
+  * `-l`, `--log-level LOG_LEVEL`:
+    set the log level
+  * `-L`, `--logfile LOG_LOCATION`:
+    Logfile to use
+  * `-d`, `--daemonize`:
+    fork into the background
+  * `-P`, `--pid PIDFILE`:
+    PID file
+  * `-h`, `--help`:
+    show help message
+  * `-v`, `--version`:
+    show the version and exit
+
+## DESCRIPTION
+
+Chef Expander fetches messages from RabbitMQ, processes them into the
+correct format to be loaded into Solr and loads them into Solr.
+
+__Running Chef Expander__
+
+Chef Expander is designed for clustered operation, though small
+installations will only need one worker process. To run Chef
+Expander with one worker process, run chef-expander-cluster -n 1.
+You will then have a master and worker process, which looks like
+this in ps:
+
+    your-shell> ps aux|grep expander
+    you   52110   0.1  0.7  2515476  62748 s003  S+    3:49PM   0:00.80 chef-expander worker #1 (vnodes 0-1023)
+    you   52108   0.1  0.5  2492880  41696 s003  S+    3:49PM   0:00.91 ruby bin/chef-expander-cluster -n 1
+
+Workers are single threaded and therefore cannot use more than 100%
+of a single CPU. If you find that your queues are getting backlogged,
+increase the number of workers
+
+__Design__
+
+Chef Expander uses 1024 queues (called vnodes in some places) to allow
+you to scale the number of Chef Expander workers to meet the needs of
+your infrastructure. When objects are saved in the API server, they are
+added to queues based on their database IDs. These queues can be assigned
+to different Chef Expander workers to distribute the load of processing
+the index updates.
+
+__Chef Expander Operation and Troubleshooting__
+
+Chef Expander includes chef-expanderctl, a management program that allows
+you to get status information or change the logging verbosity (without
+restarting).
+
+See __chef-expanderctl__(8) for details.
+
+## SEE ALSO
+
+__chef-expanderctl__(8)
+__chef-solr__(8)
+
+Full documentation for Chef and chef-server is located on the Chef
+wiki, http://wiki.opscode.com/display/chef/Home.
+
+## 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 created by Nuo Yan <nuo@opscode.com>. 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-expanderctl.mkd

@@ -0,0 +1,58 @@
+chef-expanderctl(8) -- management program for chef-expander
+========================================
+
+## SYNOPSIS
+
+__chef-expanderctl__ _COMMAND_
+
+__Commands:__
+
+  * `help`:
+    Show help message
+  * `queue-depth`:
+    display the aggregate queue backlog
+  * `queue-status`:
+    show the backlog and consumer count for each vnode queue
+  * `node-status`:
+    show the status of the nodes in the cluster
+  * `log-level`:
+    sets the log level of all nodes in the cluster
+
+## DESCRIPTION
+
+Chef-expanderctl is a management program that allows
+you to get status information or change the logging
+verbosity (without restarting). chef-expanderctl has
+the following commands:
+
+* __chef-expanderctl help__
+prints usage.
+* __chef-expanderctl queue-depth__
+Shows the total number of messages in the queues.
+* __chef-expanderctl queue-status__
+Show the number of messages in each queue. This is mainly of use when
+debugging a Chef Expander cluster.
+* __chef-expanderctl log-level LEVEL__
+Sets the log level on a running Chef Expander or cluster.
+If you suspect that a worker process is stuck, as long as you are using
+clustered operation, you can simply kill the worker process and it will
+be restarted by the master process.
+
+## SEE ALSO
+
+__chef-expander-cluster__(8)
+__chef-solr__(8)
+
+Full documentation for Chef and chef-server is located on the Chef
+wiki, http://wiki.opscode.com/display/chef/Home.
+
+## 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 created by Nuo Yan <nuo@opscode.com>. 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-server-webui.mkd

@@ -0,0 +1,121 @@
+chef-server-webui(8) -- Start the Chef Server merb application slice providing Web User Interface (Management Console).
+========================================
+
+## SYNOPSIS
+
+__chef-server-webui__ _(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 WebUI (Management Console) is a Merb application slice.
+The default listen port is 4040.
+
+The Management Console is Chef Server's web interface. Nodes, roles,
+cookbooks, data bags, and API clients can be managed through the Management
+Console. Search can also be done on the console.
+
+In order to start using the Management Console, you need to first create
+a user or change the default password on the "admin" user.
+
+The default credentials are:
+
+- `Username`: admin
+- `Password`: p@ssw0rd1
+
+## SEE ALSO
+
+Full documentation for Chef and chef-server-webui (Management Console)
+is located on the Chef wiki, http://wiki.opscode.com/display/chef/Home.
+
+## 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 for the Debian project (but may be used by others). 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-server.mkd

@@ -0,0 +1,121 @@
+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 the Chef
+wiki, http://wiki.opscode.com/display/chef/Home.
+
+## 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

@@ -0,0 +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  wiki,
+http://wiki.opscode.com/display/chef/Home.
+
+## 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.