Skip to content

Commit

Permalink
Documentation formatting fixes for CHANGELOG.md and DOC_CHANGES.md
Browse files Browse the repository at this point in the history
  • Loading branch information
adamedx committed Feb 6, 2015
1 parent d37cc30 commit 8dabdca
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 26 deletions.
26 changes: 13 additions & 13 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
# knife-azure Change Log

## Last release: 1.4.0.rc.2 (2015/02/06)
[knife-azure #189](https://github.com/chef/knife-azure/issues/189) Server Create failing for some custom sysprepped images
[knife-azure #184](https://github.com/chef/knife-azure/pull/184) Disable certificate generation code for ssl transport until supported by knife-windows
* [knife-azure #189](https://github.com/chef/knife-azure/issues/189) Server Create failing for some custom sysprepped images
* [knife-azure #184](https://github.com/chef/knife-azure/pull/184) Disable certificate generation code for ssl transport until supported by knife-windows

## Last release: 1.4.0.rc.1 (2015/02/05)
[knife-azure #102](https://github.com/chef/knife-azure/pull/102) User specified ssh/winrm port 22/5985 instead of random port with --azure-connect-to-existing-dns option for server creation
[knife-azure #179](https://github.com/chef/knife-azure/pull/179) Enable creation of new vnets
[knife-azure #169](https://github.com/chef/knife-azure/pull/169) Enable automatic update of the Chef extension the Azure VM Chef Extension --auto-update-client
[knife-azure #167](https://github.com/chef/knife-azure/pull/167) Include custom VM images in knife azure image list
## Release: 1.4.0.rc.1 (2015/02/05)
* [knife-azure #102](https://github.com/chef/knife-azure/pull/102) User specified ssh/winrm port 22/5985 instead of random port with --azure-connect-to-existing-dns option for server creation
* [knife-azure #179](https://github.com/chef/knife-azure/pull/179) Enable creation of new vnets
* [knife-azure #169](https://github.com/chef/knife-azure/pull/169) Enable automatic update of the Chef extension the Azure VM Chef Extension --auto-update-client
* [knife-azure #167](https://github.com/chef/knife-azure/pull/167) Include custom VM images in knife azure image list

## Release: 1.4.0.rc.0 (2014/12/02)
[knife-azure #171](https://github.com/chef/knife-azure/pull/171) EXPERIMENTAL: Support for unreleased knife-windows 1.0 configuration option winrm\_authentication\_protocol
[knife-azure #163](https://github.com/chef/knife-azure/pull/163) Remove the az prefix from DNS name when VM name is specified and DNS name is not specified
[knife-azure #160](https://github.com/chef/knife-azure/pull/160) Support for adding winrm SSL certificate, for winrm ssl communication
[knife-azure #157](https://github.com/chef/knife-azure/pull/157) Add integration tests
[knife-azure #162](https://github.com/chef/knife-azure/pull/162) Documentation fix to remove extraneous dash and use real example of VM image
[knife-azure #153](https://github.com/chef/knife-azure/pull/153) Resource extension support through knife-azure plugin -- cloud-api bootstrap without network transport
* [knife-azure #171](https://github.com/chef/knife-azure/pull/171) EXPERIMENTAL: Support for unreleased knife-windows 1.0 configuration option winrm\_authentication\_protocol
* [knife-azure #163](https://github.com/chef/knife-azure/pull/163) Remove the az prefix from DNS name when VM name is specified and DNS name is not specified
* [knife-azure #160](https://github.com/chef/knife-azure/pull/160) Support for adding winrm SSL certificate, for winrm ssl communication
* [knife-azure #157](https://github.com/chef/knife-azure/pull/157) Add integration tests
* [knife-azure #162](https://github.com/chef/knife-azure/pull/162) Documentation fix to remove extraneous dash and use real example of VM image
* [knife-azure #153](https://github.com/chef/knife-azure/pull/153) Resource extension support through knife-azure plugin -- cloud-api bootstrap without network transport

## Release: 1.3.0 (2014/07/31)
* Update specs to rspec 3
Expand Down
33 changes: 20 additions & 13 deletions DOC_CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,6 @@ Description of the required change.

# knife-azure 1.4.0 doc changes

### `azure_subnet_name` option to create new subnets
This option allows users to specify the name of a new subnet to create via the
`knife azure vnet create` subcommand. Despite the subcommand name, this command would
only update existing vnets, not create them. This option allows the vnet name
to be specified and will also correctly create vnets as the name of the
subcommand suggests.

### `cloud-api` value for `bootstrap_protocol_option` in server create
This option can be specified as an alternative to the `winrm`
(default for Windows) or `ssh` (default for Linux) protocols as the way to
Expand All @@ -26,12 +19,6 @@ on the system.
This is equivalent to using the Azure portal to create a Chef-enabled VM as
described in the [Chef documentation](https://docs.chef.io/azure_portal.html).

### `azure_vm_startup_timeout` option in server create
The number of minutes that knife-azure will wait for the virtual machine to reach the 'provisioning' state. Default is 10.

### `azure_vm_ready_timeout` option in server create
The number of minutes that knife-azure will wait for the virtual machine state to transition from 'provisioning' to 'ready'. Default is 15.

### `auth_timeout` option in server create
When boostrapping Windows nodes, this is the maximum time in minutes to wait
for authentication over the WinRM transport
Expand Down Expand Up @@ -79,3 +66,23 @@ option is specified. In this case, the VM will be set to automatically update
to the latest version of the Chef extension, which upgrades the Chef Client to
the latest version. By default, Chef Client is only updated on the guest for
patch revision changes.

### `azure_subnet_name` option to create new subnets
This option allows users to specify the name of a new subnet to create via the
`knife azure vnet create` subcommand. Despite the subcommand name, this command would
only update existing vnets, not create them. This option allows the vnet name
to be specified and will also correctly create vnets as the name of the
subcommand suggests.

### `azure_vm_startup_timeout` option in server create
The number of minutes that knife-azure will wait for the virtual machine to reach the 'provisioning' state. Default is 10.

### `azure_vm_ready_timeout` option in server create
The number of minutes that knife-azure will wait for the virtual machine state to transition from 'provisioning' to 'ready'. Default is 15.

### `auth_timeout` option in server create
When boostrapping Windows nodes, this is the maximum time in minutes to wait
for authentication over the WinRM transport
to the node to succeed. The default value is 25 minutes. This wait starts
after the guest has reached the "ready" state (or waited unsuccessfully for
the "ready" the amount of time specified by the `azure_vm_ready_timeout` option.

0 comments on commit 8dabdca

Please sign in to comment.