diff options
author | danielsdeleo <dan@getchef.com> | 2015-03-28 08:39:32 -0700 |
---|---|---|
committer | danielsdeleo <dan@getchef.com> | 2015-03-28 08:39:32 -0700 |
commit | e3a797ff55bb271d7032d7e4ccd783e88a1d99d1 (patch) | |
tree | d69083a275916803b208cee1bee36951e625bd25 /DOC_CHANGES.md | |
parent | 4827c9d31e68eafdff8d865d40479a18e6382793 (diff) | |
download | chef-e3a797ff55bb271d7032d7e4ccd783e88a1d99d1.tar.gz |
Reset docs for 12.3 and doc --minimal-ohai flag
Diffstat (limited to 'DOC_CHANGES.md')
-rw-r--r-- | DOC_CHANGES.md | 88 |
1 files changed, 11 insertions, 77 deletions
diff --git a/DOC_CHANGES.md b/DOC_CHANGES.md index ceac435273..a3fae662df 100644 --- a/DOC_CHANGES.md +++ b/DOC_CHANGES.md @@ -6,80 +6,14 @@ Example Doc Change: Description of the required change. --> - -### knife ssh has --exit-on-error option -`knife ssh` now has an --exit-on-error option that will cause it to -fail immediately in the face of an SSH connection error. The default -behavior is move on to the next node. - -### DSC Resource - -The `dsc_resource` resource for Windows systems that allows cookbook authors to invoke [PowerShell Desired -State Configuration](http://technet.microsoft.com/en-us/library/dn249912.aspx) resources in Chef DSL. - -#### Prerequisites - -* **Windows Management Framework 5** February Preview -* **Local Configuration Manager** must be set to have a `RefreshMode` of `Disabled` - -#### Syntax - -```ruby -dsc_resource "description" do - resource "resource_name" - property :property_name, property_value - ... - property :property_name, property_value -end -``` - -#### Attributes - -- `resource`: The friendly name of the DSC resource - -- `property`: `:property_name`, `property_value` pair for each property that must be set for the DSC resource. -`property_name` must be of the `Symbol`. The following types are supported for `property_value`, along with -their conversion into Powershell: - -| Ruby Type | Powershell Type | -|-------------------------------------|-----------------| -| Fixnum | Integer | -| Float | Double | -| FalseClass | bool($false) | -| TrueClass | bool($true) | -| Chef::Util::Powershell:PSCredential | PSCredential | -| Hash | Hashtable | -| Array | Object[] | - -- `module_name` is the name of the module that the DSC resource comes from. If it is not provided, it will - be inferred. - -#### Actions - -|Action|Description| -|------|------------------------| -|`:run`| Invoke the DSC resource| - -#### Example - -```ruby -dsc_resource "demogroupremove" do - resource :group - property :groupname, 'demo1' - property :ensure, 'present' -end - -dsc_resource "useradd" do - resource :user - property :username, "Foobar1" - property :fullname, "Foobar1" - property :password, ps_credential("P@assword!") - property :ensure, 'present' -end - -dsc_resource "AddFoobar1ToUsers" do - resource :Group - property :GroupName, "demo1" - property :MembersToInclude, ["Foobar1"] -end -``` +### Chef Client, Solo, and Apply `--minimal-ohai` Flag + +Chef Client, Solo, and Apply all implement a `--minimal-ohai` flag. When +set, Chef only runs the bare minimum necessary ohai plugins required for +internal functionality. This reduces the run time of ohai and might +improve Chef performance by reducing the amount of data kept in memory. +Most users should NOT use this mode, however, because cookbooks that +rely on data collected by other ohai plugins will definitely be broken +when Chef is run in this mode. It may be possible for advanced users to +work around that by using the ohai resource to collect the "missing" +data during the compile phase. |