Changelog (#255)

* release 2.2.4 Signed-off-by: Jeff Brimager <jbrimager@chef.io> * pushing updated docs Signed-off-by: Jeff Brimager <jbrimager@chef.io>
chef-boneyard · Nov 19, 2020 · 4590899 · 4590899
1 parent 99171e2
commit 4590899
Show file tree

Hide file tree

Showing 4 changed files with 41 additions and 44 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,28 +1,34 @@
 # Habitat Cookbook CHANGELOG
 
 This file is used to list changes made in each version of the habitat cookbook.
+
 ## Unreleased
+
 <!-- latest_release unreleased -->
-## Unreleased
+
+<!-- latest_release -->
+
+## 2.2.4 (2020-11-19)
 
 #### Merged Pull Requests
+
 - Adds support for Supervisor toml config [#254](https://github.com/chef-cookbooks/habitat/pull/254) ([collinmcneese](https://github.com/collinmcneese))
 - Cookstyle Bot Auto Corrections with Cookstyle 6.18.8 [#253](https://github.com/chef-cookbooks/habitat/pull/253) ([cookstyle[bot]](https://github.com/cookstyle[bot]))
 - Automated PR: Standardising Files [#252](https://github.com/chef-cookbooks/habitat/pull/252) ([xorimabot](https://github.com/xorimabot))
 - Fixed hab_service flapping on bldr_url and update_condition [#251](https://github.com/chef-cookbooks/habitat/pull/251) ([mattray](https://github.com/mattray))
 - It&#39;s `event_stream_cert` in the code [#249](https://github.com/chef-cookbooks/habitat/pull/249) ([mattray](https://github.com/mattray))
 - Automated PR: Standardising Files [#248](https://github.com/chef-cookbooks/habitat/pull/248) ([xorimabot](https://github.com/xorimabot))
-<!-- latest_release -->
-
 
 ## 2.2.3 (2020-06-25)
 
 #### Merged Pull Requests
+
 - correcting some documentation and fixing tagging [#247](https://github.com/chef-cookbooks/habitat/pull/247) ([sam1el](https://github.com/sam1el))
 
 ## 2.2.2 (2020-06-18)
 
 #### Merged Pull Requests
+
 - updates custom resources to add resource_name [#246](https://github.com/chef-cookbooks/habitat/pull/246) ([collinmcneese](https://github.com/collinmcneese))
 - Automated PR: Standardising Files [#244](https://github.com/chef-cookbooks/habitat/pull/244) ([xorimabot](https://github.com/xorimabot))
 - Automated PR: Cookstyle Changes [#243](https://github.com/chef-cookbooks/habitat/pull/243) ([xorimabot](https://github.com/xorimabot))
@@ -33,13 +39,13 @@ This file is used to list changes made in each version of the habitat cookbook.
 - Had idempotance issues with the install resource. Those are now corrected
 
 #### Merged Pull Requests
+
 - Automated PR: Standardising Files [#242](https://github.com/chef-cookbooks/habitat/pull/242) ([xorimabot](https://github.com/xorimabot))
 - updating how we handle the bldr_url to accommodate on-prem installed with Automate [#241](https://github.com/chef-cookbooks/habitat/pull/241) ([danielcbright](https://github.com/danielcbright))
 - fixes hab_install guard for resource_hab_sup [#239](https://github.com/chef-cookbooks/habitat/pull/239) ([collinmcneese](https://github.com/collinmcneese))
 - correcting all syntax issue [#238](https://github.com/chef-cookbooks/habitat/pull/238) ([sam1el](https://github.com/sam1el))
 - Automated PR: Cookstyle Changes [#237](https://github.com/chef-cookbooks/habitat/pull/237) ([xorimabot](https://github.com/xorimabot))
 
-
 ## 2.1.0 (2020-05-07)
 
 - Integrated Toml functions as a helper library to remove external gem dependencies. This will also make airgap usage easier
@@ -76,7 +82,7 @@ This file is used to list changes made in each version of the habitat cookbook.
 - All current `--event-stream` functions are now available to habitat versions 1.5.86 and up for the `hab_sup` resource
 - `windows-service` Can now be configured properly with `--event-stream` as well has your `HAB_AUTH_TOKEN` `HAB_BLDR_URL` and, `HAB_AUTH_GATEWAY_TOKEN`
 
-***See README.MD for usage of all new functions**
+**\*See README.MD for usage of all new functions**
 
 #### Merged Pull Requests
 
@@ -104,16 +110,14 @@ This file is used to list changes made in each version of the habitat cookbook.
 - changing the windows service cofig to better reflect newer functional… [#223](https://github.com/chef-cookbooks/habitat/pull/223) ([sam1el](https://github.com/sam1el))
 - removing update-confition defaults and tests [#221](https://github.com/chef-cookbooks/habitat/pull/221) ([sam1el](https://github.com/sam1el))
 
-
 ## 1.6.0 (2020-04-02)
 
-#### Merged Pull Requests	- complete overhaul of the windows-service config to refplect current best practice
+#### Merged Pull Requests - complete overhaul of the windows-service config to refplect current best practice
 
 - adding --update-condition funtionality that was added in habitat 1.5.71 [#217](https://github.com/chef-cookbooks/habitat/pull/217) ([sam1el](https://github.com/sam1el))
 - added --update-condition funtionality that was added in habitat 1.5.71. See README.MD for info on usage
 - complete overhaul of the windows-service config to refplect current best practice
 
-
 ## 1.5.10 (2020-04-01)
 
 #### Merged Pull Requests
@@ -157,7 +161,7 @@ This file is used to list changes made in each version of the habitat cookbook.
 
 #### Merged Pull Requests
 
-- Extending Windows chef-client compatibility  [#205](https://github.com/chef-cookbooks/habitat/pull/205) ([sam1el](https://github.com/sam1el))
+- Extending Windows chef-client compatibility [#205](https://github.com/chef-cookbooks/habitat/pull/205) ([sam1el](https://github.com/sam1el))
 
 ## 1.5.4 (2020-02-25)
 
@@ -215,7 +219,6 @@ This file is used to list changes made in each version of the habitat cookbook.
 - Cookstyle 5.10 fixes
 - Fixes to properly support loading of services using full ident
 
-
 #### Merged Pull Requests
 
 - Feature/service full ident fix [#185](https://github.com/chef-cookbooks/habitat/pull/185) ([sirajrauff](https://github.com/sirajrauff))
@@ -251,7 +254,7 @@ This file is used to list changes made in each version of the habitat cookbook.
 ## 0.81.0 (2019-05-29)
 
 - Update to hab 0.81.0
-- Implement new habitat license agreement requirements for ```hab_install``` and ```hab_sup``` resources
+- Implement new habitat license agreement requirements for `hab_install` and `hab_sup` resources
 
 #### Merged Pull Requests
 
@@ -271,7 +274,6 @@ This file is used to list changes made in each version of the habitat cookbook.
 
 - Update to habitat 0.79.1 [#169](https://github.com/chef-cookbooks/habitat/pull/169) ([chef-ci](https://github.com/chef-ci))
 
-
 ## [0.78.0](https://github.com/chef-cookbooks/habitat/tree/0.78.0) (2019-04-02)
 
 - Update to habitat 0.78.0
@@ -295,7 +297,6 @@ This file is used to list changes made in each version of the habitat cookbook.
 
 - Update to habitat 0.74.0
 
-
 ## 0.73.1 (2019-01-30)
 
 - remove duplicate windows query param
@@ -304,21 +305,19 @@ This file is used to list changes made in each version of the habitat cookbook.
 
 - remove duplicate windows query param [#156](https://github.com/chef-cookbooks/habitat/pull/156) ([skylerto](https://github.com/skylerto))
 
-
 ## 0.73.0 (2019-01-25)
 
-* Update Hab to 0.73.0 and launcher to 9167
-* Add binlinking support to hab_package resource
-* Support target architectures correctly in API queries
-* Improved Windows support
-
+- Update Hab to 0.73.0 and launcher to 9167
+- Add binlinking support to hab_package resource
+- Support target architectures correctly in API queries
+- Improved Windows support
 
 #### Merged Pull Requests
 
 - Update hab to 0.73.0 and launcher to 9167 [#154](https://github.com/chef-cookbooks/habitat/pull/154) ([jonlives](https://github.com/jonlives))
 - Install hab-sup from stable release [#153](https://github.com/chef-cookbooks/habitat/pull/153) ([jonlives](https://github.com/jonlives))
 - Full Windows Support For Cookbook [#143](https://github.com/chef-cookbooks/habitat/pull/143) ([wduncanfraser](https://github.com/wduncanfraser))
-- Add binlink property to hab_package resource.  Closes #138 [#139](https://github.com/chef-cookbooks/habitat/pull/139) ([qubitrenegade](https://github.com/qubitrenegade))
+- Add binlink property to hab_package resource. Closes #138 [#139](https://github.com/chef-cookbooks/habitat/pull/139) ([qubitrenegade](https://github.com/qubitrenegade))
 - fix incorrect documentation for hab_package action [#142](https://github.com/chef-cookbooks/habitat/pull/142) ([st-h](https://github.com/st-h))
 - Support targets for API query [#152](https://github.com/chef-cookbooks/habitat/pull/152) ([skylerto](https://github.com/skylerto))
 
@@ -330,19 +329,20 @@ This file is used to list changes made in each version of the habitat cookbook.
 
 ## 0.63.0 (2018-09-18)
 
-*  Update to habitat 0.63.0
+- Update to habitat 0.63.0
 
 ## 0.62.1 (2018-09-07)
 
-* Update hab version to 0.62.1 and pin supervisor version to 8380
-* Refactor cookbook resources for 0.62.1 compatibility
-* Add user_toml resource
-* Add remote supervisor support
-* Add multiple peer support
-* Add auth token support to package resource
-* Add basic support for Windows
+- Update hab version to 0.62.1 and pin supervisor version to 8380
+- Refactor cookbook resources for 0.62.1 compatibility
+- Add user_toml resource
+- Add remote supervisor support
+- Add multiple peer support
+- Add auth token support to package resource
+- Add basic support for Windows
 
 #### Merged Pull Requests
+
 - Refactor hab_service resource [#124](https://github.com/chef-cookbooks/habitat/pull/124) ([wduncanfraser](https://github.com/wduncanfraser))
 - Update to 0.62.1 and launcher 8380 [#129](https://github.com/chef-cookbooks/habitat/pull/129) ([jonlives](https://github.com/jonlives))
 - Added auth token support to package resource [#125](https://github.com/chef-cookbooks/habitat/pull/125) ([wduncanfraser](https://github.com/wduncanfraser))
@@ -381,7 +381,7 @@ This file is used to list changes made in each version of the habitat cookbook.
 
 ## 0.56.1 (2018-06-06)
 
-- Support passing TMPDIR attribute to Habitat install.sh script.  Addresses Issue #90
+- Support passing TMPDIR attribute to Habitat install.sh script. Addresses Issue #90
 - Add: bldr_url property for hab_sup
 - Fix hab_svc when using custom ip:port for supervisor
 - Include toml in the bundle
@@ -391,7 +391,7 @@ This file is used to list changes made in each version of the habitat cookbook.
 
 - Fix hab_svc when using custom ip:port for supervisor [#96](https://github.com/chef-cookbooks/habitat/pull/96) ([JonathanTron](https://github.com/JonathanTron))
 - Add: bldr_url property for hab_sup [#93](https://github.com/chef-cookbooks/habitat/pull/93) ([Atalanta](https://github.com/Atalanta))
-- Support passing TMPDIR attribute to Habitat install.sh script.  #90 [#91](https://github.com/chef-cookbooks/habitat/pull/91) ([qubitrenegade](https://github.com/qubitrenegade))
+- Support passing TMPDIR attribute to Habitat install.sh script. #90 [#91](https://github.com/chef-cookbooks/habitat/pull/91) ([qubitrenegade](https://github.com/qubitrenegade))
 - Include toml in the bundle [#100](https://github.com/chef-cookbooks/habitat/pull/100) ([jtimberman](https://github.com/jtimberman))
 
 ## 0.56.0 (2018-06-05)
@@ -585,4 +585,4 @@ This cookbook was updated to be compatible with the changes made in Habitat 0.26
 
 ## v0.0.3 (2016-07-14)
 
-- Initial release, includes `hab_package` and `hab_install` resources
+- Initial release, includes `hab_package` and `hab_install` resources
diff --git a/README.md b/README.md
@@ -11,10 +11,6 @@ This cookbook provides resources for working with [Habitat](https://habitat.sh).
 - APIs are subject to change
 - Habitat is a rapidly changing product, and this cookbook may change rapidly as well
 
-## TODOS
-
-- [ ] Remove reliance on `toml-rb` gem.
-
 ## License Note
 
 Habitat requires acceptance of a license before any habitat commands can be run. To accept the Habitat license using this cookbook, the `license` parameter can be set to `accept` for either the `hab_install` or `hab_sup` resources as shown in the below examples:
@@ -46,7 +42,7 @@ PLEASE NOTE: Without performing one of the above license acceptance steps, all o
 
 - Habitat version: 1.6.56+ `You can also pin to older versions if desired`
 
-This cookbook used to base version number off of the latest stable Habitat release and install a specific version of Habitat based upon the cookbook version.  Current behavior is now that the cookbook will install the latest stable release of Habitat on the source Habitat Builder which is contacted by default, but allows for explicit version pinning to be set via cookbook resources.
+This cookbook used to base version number off of the latest stable Habitat release and install a specific version of Habitat based upon the cookbook version. Current behavior is now that the cookbook will install the latest stable release of Habitat on the source Habitat Builder which is contacted by default, but allows for explicit version pinning to be set via cookbook resources.
 
 ### Chef
 
@@ -72,7 +68,7 @@ Installs Habitat on the system using the [install script](https://raw.githubuser
 - `install_url`: URL to the install script, default is from the [habitat repo](https://raw.githubusercontent.com/habitat-sh/habitat/master/components/hab/install.sh)
 - `bldr_url`: Optional URL to an alternate Builder (defaults to the public Builder)
 - `create_user`: Creates the `hab` system user (defaults to `true`)
-- `tmp_dir`: Sets TMPDIR environment variable for location to place temp files.  (required if `/tmp` and `/var/tmp` are mounted `noexec`)
+- `tmp_dir`: Sets TMPDIR environment variable for location to place temp files. (required if `/tmp` and `/var/tmp` are mounted `noexec`)
 - `license`: Specifies acceptance of habitat license when set to `accept` (defaults to empty string).
 - `hab_version`: Specify the version of `Habitat` you would like to install (defaults to latest)
 
@@ -113,7 +109,7 @@ Install the specified Habitat package from builder. Requires that Habitat is ins
 - `bldr_url`: The habitat builder url where packages will be downloaded from (defaults to public habitat builder)
 - `channel`: The release channel to install from (defaults to `stable`)
 - `auth_token`: Auth token for installing a package from a private organization on builder
-- `binlink`: If habitat should attempt to binlink the package.  Acceptable values: `true`, `false`, `:force`.  Will faill on binlinking if set to `true` and binary or binlink exists.
+- `binlink`: If habitat should attempt to binlink the package. Acceptable values: `true`, `false`, `:force`. Will faill on binlinking if set to `true` and binary or binlink exists.
 - `options`: Pass any additional parameters to the habitat install command.
 - `keep_latest`: Ability to uninstall while retaining a specified version (Default is not set. `This feature only works in Habitat 1.5.86+`)
 - `no_deps`: Remove package but retain dependencies (Default is `false`)
@@ -194,7 +190,7 @@ The follow properties are valid for the `load` action.
 - `loaded`: state property indicating whether the service is loaded in the supervisor
 - `running`: state property indicating whether the service is running in the supervisor
 - `strategy`: Passes `--strategy` with the specified update strategy to the hab command. Defaults to `:none`. Other options are `:'at-once'` and `:rolling`
-- `update_condition`: Passes `--update-condition` dictating when this service should updated. Defaults to `latest`. Options are `latest` or `track-channel` ***Note: This requires a minimum habitat version of 1.5.71***
+- `update_condition`: Passes `--update-condition` dictating when this service should updated. Defaults to `latest`. Options are `latest` or `track-channel` **_Note: This requires a minimum habitat version of 1.5.71_**
   - `latest`: Runs the latest package that can be found in the configured channel and local packages.
   - `track-channel`: Always run what is at the head of a given channel. This enables service rollback where demoting a package from a channel will cause the package to rollback to an older version of the package. A ramification of enabling this condition is packages newer than the package at the head of the channel will be automatically uninstalled during a service rollback.
 - `topology`: Passes `--topology` with the specified service topology to the hab command
@@ -254,7 +250,7 @@ Runs a Habitat Supervisor for one or more Habitat Services. It is used in conjun
 The `run` action handles installing Habitat using the `hab_install` resource, ensures that the appropriate versions of the `core/hab-sup` and `core/hab-launcher` packages are installed using `hab_package`, and then drops off the appropriate init system definitions and manages the service.
 
 All `event_stream_*` properties are optional, and allow the Habitat Supervisor to display details about it's status and running services via the [Chef Automate Applications Dashboard](https://automate.chef.io/docs/applications-dashboard/).
-***Note: Automate has TLS on by default. You will need to follow these instructions to make sure habitat has the proper certificates for `event_stram_*` [Share the TLS Certificate with Chef Habitat](https://automate.chef.io/docs/applications-setup/#share-the-tls-certificate-with-chef-habitat)***
+**_Note: Automate has TLS on by default. You will need to follow these instructions to make sure habitat has the proper certificates for `event*stram*_` [Share the TLS Certificate with Chef Habitat](https://automate.chef.io/docs/applications-setup/#share-the-tls-certificate-with-chef-habitat)\***
 
 #### Actions
 
@@ -272,7 +268,7 @@ All `event_stream_*` properties are optional, and allow the Habitat Supervisor t
 - `peer`: Only valid for `:run` action, passes `--peer` with the specified initial peer to the hab command
 - `ring`: Only valid for `:run` action, passes `--ring` with the specified ring key name to the hab command
 - `auto_update`: Passes `--auto-update`. This will set the Habitat supervisor to automatically update itself any time a stable version has been released
-- `update_condition`: Passes `--update-condition` dictating when this service should updated. Defaults to `latest`. Options are `latest` or `track-channel`  ***Note: This requires a minimum habitat version of 1.5.71***
+- `update_condition`: Passes `--update-condition` dictating when this service should updated. Defaults to `latest`. Options are `latest` or `track-channel` **_Note: This requires a minimum habitat version of 1.5.71_**
   - `latest`: Runs the latest package that can be found in the configured channel and local packages.
   - `track-channel`: Always run what is at the head of a given channel. This enables service rollback where demoting a package from a channel will cause the package to rollback to an older version of the package. A ramification of enabling this condition is packages newer than the package at the head of the channel will be automatically uninstalled during a service rollback.
 - `hab_channel`: The channel to install Habitat from. Defaults to stable
@@ -288,7 +284,7 @@ All `event_stream_*` properties are optional, and allow the Habitat Supervisor t
 - `event_stream_cert`: With `Intermediary Certificates` or, Automate 2 being set to use TLS with a valid cert, you will need to provide `Habitat` with your certificate for communication with Automate to work. [Follow these steps!](https://automate.chef.io/docs/applications-setup/#share-the-tls-certificate-with-chef-habitat)
 - `sup_verstion`: Allows you to choose which version of supervisor you would like to install. Defaults to `latest`. (If a version is provided, it will also install that version of habitat if not previously installed)
 - `launcher_version`: Allows you to choose which version of launcher to install. Defaults to `latest`
-- `service_version`: Allows you to choose which version of the ***Windows Service*** to install. Defaults to `latest`
+- `service_version`: Allows you to choose which version of the **_Windows Service_** to install. Defaults to `latest`
 - `keep_latest`: Automatically cleans up old packages. If this flag is enabled, service startup will initiate an uninstall of all previous versions of the associated package. This also applies when a service is restarted due to an update. If a number is passed to this argument, that number of latest versions will be kept. The same logic applies to the Supervisor packag `env:HAB_KEEP_LATEST_PACKAGES=1` (This requires Habitat version `1.5.86+`)
 
 #### Examples
@@ -406,6 +402,7 @@ hab_user_toml 'nginx' do
   })
 end
 ```
+
 ## Maintainers
 
 This cookbook is maintained by the following maintainers:

diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-2.2.3
+2.2.4