diff --git a/data/infra/resources/apt_repository.yaml b/data/infra/resources/apt_repository.yaml index 856ef62fc1..bf318076b6 100644 --- a/data/infra/resources/apt_repository.yaml +++ b/data/infra/resources/apt_repository.yaml @@ -19,21 +19,22 @@ syntax_full_code_block: |- key String, Array, false # default value: [] key_proxy String, false keyserver String, false # default value: "keyserver.ubuntu.com" + options String, Array # default value: [] repo_name String # default value: 'name' unless specified + signed_by String, true, false # default value: true trusted true, false # default value: false uri String - options String, Array # default value: [] action Symbol # defaults to :add if not specified end -syntax_properties_list: +syntax_properties_list: syntax_full_properties_list: - "`apt_repository` is the resource." - "`name` is the name given to the resource block." - "`action` identifies which steps Chef Infra Client will take to bring the node into the desired state." - "`arch`, `cache_rebuild`, `components`, `cookbook`, `deb_src`, `distribution`, `key`, - `key_proxy`, `keyserver`, `repo_name`, `trusted`, and `uri` are the properties available - to this resource." + `key_proxy`, `keyserver`, `options`, `repo_name`, `signed_by`, `trusted`, and `uri` + are the properties available to this resource." actions_list: :nothing: shortcode: resources_common_actions_nothing.md @@ -99,6 +100,12 @@ properties_list: default_value: keyserver.ubuntu.com description_list: - markdown: The GPG keyserver where the key for the repo should be retrieved. +- property: options + ruby_type: String, Array + required: false + default_value: "[]" + description_list: + - markdown: Additional options to set for the repository - property: repo_name ruby_type: String required: false @@ -107,6 +114,14 @@ properties_list: description_list: - markdown: An optional property to set the repository name if it differs from the resource block's name. The value of this setting must not contain spaces. +- property: signed_by + ruby_type: String, true, false + required: false + default_value: 'true' + description_list: + - markdown: If set to true, Signed-By authenticates with the value of the key property. + If set to a string that's a file path or fingerprint, Signed-By authenticates + with that file or fingerprint. - property: trusted ruby_type: true, false required: false @@ -114,17 +129,13 @@ properties_list: description_list: - markdown: Determines whether you should treat all packages from this repository as authenticated regardless of signature. -- property: options - ruby_type: String, Array - required: false - default_value: "[]" - description_list: - - markdown: Additional options to set for the repository. - property: uri ruby_type: String required: false description_list: - markdown: The base of the Debian distribution. +target_mode: + support: full examples: | **Add repository with basic settings**: diff --git a/data/infra/resources/homebrew_cask.yaml b/data/infra/resources/homebrew_cask.yaml index 530c469c0f..f3c686fd80 100644 --- a/data/infra/resources/homebrew_cask.yaml +++ b/data/infra/resources/homebrew_cask.yaml @@ -12,7 +12,6 @@ syntax_full_code_block: |- homebrew_cask 'name' do cask_name String # default value: 'name' unless specified homebrew_path String - install_cask true, false # default value: true options String owner String, Integer # default value: "Calculated default username" action Symbol # defaults to :install if not specified @@ -23,7 +22,7 @@ syntax_full_properties_list: - "`name` is the name given to the resource block." - "`action` identifies which steps Chef Infra Client will take to bring the node into the desired state." -- "`cask_name`, `homebrew_path`, `install_cask`, `options`, and `owner` are the properties +- "`cask_name`, `homebrew_path`, `options`, and `owner` are the properties available to this resource." actions_list: :nothing: @@ -45,12 +44,6 @@ properties_list: required: false description_list: - markdown: The path to the homebrew binary. -- property: install_cask - ruby_type: true, false - required: false - default_value: 'true' - description_list: - - markdown: Automatically install the Homebrew cask tap, if necessary. - property: options ruby_type: String required: false diff --git a/data/infra/resources/registry_key.yaml b/data/infra/resources/registry_key.yaml index acb3d94323..3f375572f7 100644 --- a/data/infra/resources/registry_key.yaml +++ b/data/infra/resources/registry_key.yaml @@ -28,12 +28,14 @@ syntax_description: "A **registry_key** resource block creates and deletes regis \ :create\nend\n```" syntax_full_code_block: |- registry_key 'name' do - architecture Symbol # default value: :machine - key String # default value: 'name' unless specified - recursive true, false # default value: false - values Hash, Array # default value: [] - action Symbol # defaults to :create if not specified + architecture Symbol # default value: :machine + key String # default value: 'name' unless specified + only_record_changes true, false # default value: true + recursive true, false # default value: false + values Hash, Array # default value: [] + action Symbol # defaults to :create if not specified end +syntax_properties_list: syntax_full_properties_list: - '`registry_key` is the resource' - '`name` is the name of the resource block' @@ -130,6 +132,14 @@ properties_list: `HKEY_CURRENT_CONFIG`, `HKCC`, `HKEY_CLASSES_ROOT`, `HKCR`, `HKEY_USERS`, `HKU`, `HKEY_CURRENT_USER`, and `HKCU`.' +- property: only_record_changes + ruby_type: true, false + required: false + default_value: 'true' + new_in: '18.7' + description_list: + - markdown: Suppress reporting of the current value of sibling values in a registry + key. Setting this to false may result in a large number of values reported. - property: recursive ruby_type: true, false required: false @@ -181,6 +191,20 @@ examples: | end ``` + **Suppress reporting the sibling values of the values being updated in a registry key** + + ```ruby + registry 'HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\CONTROL\Session Manager' do + values [{ + name: 'ProtectionMode', + type: :dword, + data: 1 + }] + only_record_changes true + action :create + end + ``` + **Create a registry key with binary data: "\x01\x02\x03"**: ```ruby @@ -190,6 +214,7 @@ examples: | :type => :binary, :data => [0, 1, 2].map(&:chr).join }] + action :create end ```