Skip to content

Commit f5f2a45

Browse files
authored
Update resource docs for 18.7 (#4400)
* Update resource docs for 18.7 Signed-off-by: Ian Maddaus <[email protected]> * Update data/infra/resources/apt_repository.yaml Signed-off-by: Ian Maddaus <[email protected]> --------- Signed-off-by: Ian Maddaus <[email protected]>
1 parent 66dca97 commit f5f2a45

File tree

3 files changed

+52
-23
lines changed

3 files changed

+52
-23
lines changed

data/infra/resources/apt_repository.yaml

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -19,21 +19,22 @@ syntax_full_code_block: |-
1919
key String, Array, false # default value: []
2020
key_proxy String, false
2121
keyserver String, false # default value: "keyserver.ubuntu.com"
22+
options String, Array # default value: []
2223
repo_name String # default value: 'name' unless specified
24+
signed_by String, true, false # default value: true
2325
trusted true, false # default value: false
2426
uri String
25-
options String, Array # default value: []
2627
action Symbol # defaults to :add if not specified
2728
end
28-
syntax_properties_list:
29+
syntax_properties_list:
2930
syntax_full_properties_list:
3031
- "`apt_repository` is the resource."
3132
- "`name` is the name given to the resource block."
3233
- "`action` identifies which steps Chef Infra Client will take to bring the node into
3334
the desired state."
3435
- "`arch`, `cache_rebuild`, `components`, `cookbook`, `deb_src`, `distribution`, `key`,
35-
`key_proxy`, `keyserver`, `repo_name`, `trusted`, and `uri` are the properties available
36-
to this resource."
36+
`key_proxy`, `keyserver`, `options`, `repo_name`, `signed_by`, `trusted`, and `uri`
37+
are the properties available to this resource."
3738
actions_list:
3839
:nothing:
3940
shortcode: resources_common_actions_nothing.md
@@ -99,6 +100,12 @@ properties_list:
99100
default_value: keyserver.ubuntu.com
100101
description_list:
101102
- markdown: The GPG keyserver where the key for the repo should be retrieved.
103+
- property: options
104+
ruby_type: String, Array
105+
required: false
106+
default_value: "[]"
107+
description_list:
108+
- markdown: Additional options to set for the repository
102109
- property: repo_name
103110
ruby_type: String
104111
required: false
@@ -107,24 +114,28 @@ properties_list:
107114
description_list:
108115
- markdown: An optional property to set the repository name if it differs from the
109116
resource block's name. The value of this setting must not contain spaces.
117+
- property: signed_by
118+
ruby_type: String, true, false
119+
required: false
120+
default_value: 'true'
121+
description_list:
122+
- markdown: If set to true, Signed-By authenticates with the value of the key property.
123+
If set to a string that's a file path or fingerprint, Signed-By authenticates
124+
with that file or fingerprint.
110125
- property: trusted
111126
ruby_type: true, false
112127
required: false
113128
default_value: 'false'
114129
description_list:
115130
- markdown: Determines whether you should treat all packages from this repository
116131
as authenticated regardless of signature.
117-
- property: options
118-
ruby_type: String, Array
119-
required: false
120-
default_value: "[]"
121-
description_list:
122-
- markdown: Additional options to set for the repository.
123132
- property: uri
124133
ruby_type: String
125134
required: false
126135
description_list:
127136
- markdown: The base of the Debian distribution.
137+
target_mode:
138+
support: full
128139
examples: |
129140
**Add repository with basic settings**:
130141

data/infra/resources/homebrew_cask.yaml

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ syntax_full_code_block: |-
1212
homebrew_cask 'name' do
1313
cask_name String # default value: 'name' unless specified
1414
homebrew_path String
15-
install_cask true, false # default value: true
1615
options String
1716
owner String, Integer # default value: "Calculated default username"
1817
action Symbol # defaults to :install if not specified
@@ -23,7 +22,7 @@ syntax_full_properties_list:
2322
- "`name` is the name given to the resource block."
2423
- "`action` identifies which steps Chef Infra Client will take to bring the node into
2524
the desired state."
26-
- "`cask_name`, `homebrew_path`, `install_cask`, `options`, and `owner` are the properties
25+
- "`cask_name`, `homebrew_path`, `options`, and `owner` are the properties
2726
available to this resource."
2827
actions_list:
2928
:nothing:
@@ -45,12 +44,6 @@ properties_list:
4544
required: false
4645
description_list:
4746
- markdown: The path to the homebrew binary.
48-
- property: install_cask
49-
ruby_type: true, false
50-
required: false
51-
default_value: 'true'
52-
description_list:
53-
- markdown: Automatically install the Homebrew cask tap, if necessary.
5447
- property: options
5548
ruby_type: String
5649
required: false

data/infra/resources/registry_key.yaml

Lines changed: 30 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,14 @@ syntax_description: "A **registry_key** resource block creates and deletes regis
2828
\ :create\nend\n```"
2929
syntax_full_code_block: |-
3030
registry_key 'name' do
31-
architecture Symbol # default value: :machine
32-
key String # default value: 'name' unless specified
33-
recursive true, false # default value: false
34-
values Hash, Array # default value: []
35-
action Symbol # defaults to :create if not specified
31+
architecture Symbol # default value: :machine
32+
key String # default value: 'name' unless specified
33+
only_record_changes true, false # default value: true
34+
recursive true, false # default value: false
35+
values Hash, Array # default value: []
36+
action Symbol # defaults to :create if not specified
3637
end
38+
syntax_properties_list:
3739
syntax_full_properties_list:
3840
- '`registry_key` is the resource'
3941
- '`name` is the name of the resource block'
@@ -130,6 +132,14 @@ properties_list:
130132
`HKEY_CURRENT_CONFIG`, `HKCC`, `HKEY_CLASSES_ROOT`, `HKCR`,
131133
132134
`HKEY_USERS`, `HKU`, `HKEY_CURRENT_USER`, and `HKCU`.'
135+
- property: only_record_changes
136+
ruby_type: true, false
137+
required: false
138+
default_value: 'true'
139+
new_in: '18.7'
140+
description_list:
141+
- markdown: Suppress reporting of the current value of sibling values in a registry
142+
key. Setting this to false may result in a large number of values reported.
133143
- property: recursive
134144
ruby_type: true, false
135145
required: false
@@ -181,6 +191,20 @@ examples: |
181191
end
182192
```
183193
194+
**Suppress reporting the sibling values of the values being updated in a registry key**
195+
196+
```ruby
197+
registry 'HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\CONTROL\Session Manager' do
198+
values [{
199+
name: 'ProtectionMode',
200+
type: :dword,
201+
data: 1
202+
}]
203+
only_record_changes true
204+
action :create
205+
end
206+
```
207+
184208
**Create a registry key with binary data: "\x01\x02\x03"**:
185209
186210
```ruby
@@ -190,6 +214,7 @@ examples: |
190214
:type => :binary,
191215
:data => [0, 1, 2].map(&:chr).join
192216
}]
217+
193218
action :create
194219
end
195220
```

0 commit comments

Comments
 (0)