summaryrefslogtreecommitdiff
path: root/RELEASE_NOTES.md
diff options
context:
space:
mode:
authorTim Smith <tsmith84@gmail.com>2020-02-03 12:29:12 -0800
committerTim Smith <tsmith84@gmail.com>2020-02-03 12:29:12 -0800
commit1e55b1f6926d353889e6eb4efbc4affb9458a8db (patch)
treea4024db8f7faee92f7048a5e09287a6dc1d46da0 /RELEASE_NOTES.md
parentf7f809f85b5c67962d770cf5ef05f19b9f69cc0a (diff)
downloadchef-1e55b1f6926d353889e6eb4efbc4affb9458a8db.tar.gz
Add an introduced field to sysctl and expand testing
Break the content generation out into its own method so we can test it. Signed-off-by: Tim Smith <tsmith@chef.io>
Diffstat (limited to 'RELEASE_NOTES.md')
-rw-r--r--RELEASE_NOTES.md69
1 files changed, 36 insertions, 33 deletions
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
index 9fc5a17bdb..e1a634addd 100644
--- a/RELEASE_NOTES.md
+++ b/RELEASE_NOTES.md
@@ -1,5 +1,41 @@
This file holds "in progress" release notes for the current release under development and is intended for consumption by the Chef Documentation team. Please see <https://docs.chef.io/release_notes.html> for the official Chef release notes.
+# UNRELEASED
+
+### sysctl now accepts a comments parameter
+
+The `sysctl` resource has been updated to allow the inclusion of descriptive comments. Comments may be passed as an array or as a string. Any comments provided are prefixed with '#' signs and precede the `sysctl` setting in generated files.
+
+An example:
+
+```ruby
+sysctl 'vm.swappiness' do
+ value 10
+ comment [
+ "define how aggressively the kernel will swap memory pages.",
+ "Higher values will increase aggressiveness",
+ "lower values decrease the amount of swap.",
+ "A value of 0 instructs the kernel not to initiate swap",
+ "until the amount of free and file-backed pages is less",
+ "than the high water mark in a zone.",
+ "The default value is 60."
+ ]
+end
+```
+
+which results in `/etc/sysctl.d/99-chef-vm.swappiness.conf` as follows:
+
+```
+# define how aggressively the kernel will swap memory pages.
+# Higher values will increase aggressiveness
+# lower values decrease the amount of swap.
+# A value of 0 instructs the kernel not to initiate swap
+# until the amount of free and file-backed pages is less
+# than the high water mark in a zone.
+# The default value is 60.
+vm.swappiness = 10
+```
+
# Chef Infra Client 15.7
## Updated Resources
@@ -568,39 +604,6 @@ Our underlying SSH implementation has been updated to support the new ed25519 SS
Chef Solo's `--delete-entire-chef-repo` option has been extended to work in Local Mode as well. Be warned that this flag does exactly what it states, and when used incorrectly, can result in loss of work.
-### sysctl now accepts a comments parameter
-
-The `sysctl` resource has been updated to allow the inclusion of descriptive comments. Comments may be passed as an array or a string. Any comments provided are prefixed with '#' signs and precede the `sysctl` setting in generated files.
-
-An example:
-
-```
-sysctl 'vm.swappiness' do
- value 10
- comment [
- "define how aggressively the kernel will swap memory pages.",
- "Higher values will increase aggressiveness",
- "lower values decrease the amount of swap.",
- "A value of 0 instructs the kernel not to initiate swap",
- "until the amount of free and file-backed pages is less",
- "than the high water mark in a zone.",
- "The default value is 60."
- ]
-end
-```
-
-which results in `/etc/sysctl.d/99-chef-vm.swappiness.conf` as follows
-```
-# define how aggressively the kernel will swap memory pages.
-# Higher values will increase aggressiveness
-# lower values decrease the amount of swap.
-# A value of 0 instructs the kernel not to initiate swap
-# until the amount of free and file-backed pages is less
-# than the high water mark in a zone.
-# The default value is 60.
-vm.swappiness = 10
-```
-
## New Resources
### archive_file resource