diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index e2c28d7..77eb446 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,37 +1,20 @@ # Contributing to Vester -Everyone is welcome to contribute to this project. -The goal is to add fine-grained tests that look at specific values within a vSphere environment, compare them to defined configuration value, and optionally remediate discrepancies if the user so decides. -However, there is nothing wrong with submitting a pull request (PR) with a non-remediating test. -This is a great starting point for those newer to coding with PowerShell! - -## Contribution Requirements - -Every test that is added to Vester needs three things: - -1. An update to the example [`Config.ps1`][config] file with your required configuration value(s), comments, and accepted input type. -2. An update to the [`Config.Tests.ps1`][config.tests] file to validate that the `Config.ps1` file contains valid entries. -3. A test file using a properly formatted `Verb-Noun` format (use `Get-Verb` for more details) placed into the Tests folder. +Hello! We're always happy to hear from friends old and new. Here's some basic info about contributing for newcomers. ## Your First Contribution -If you're looking for your first bit of code to add, try this list: +If you're a first-timer, welcome! If you're not sure how to GitHub, allow me to humbly recommend a [GitHub 101] guide I wrote to try to help. + +Fixing typos or updating outdated documentation is always welcome. New sets of eyes are a very scarce resource :slightly_smiling_face: -1. Identify a configuration value in your vSphere environment that isn't being inspected by Vester. -2. Use the [Template][template] to create a test that inspects this value and try it out locally. -3. At this point you can submit a pull request (PR) for a non-remediating test. -If someone else wants the remediation code added, they will grab your code and write that portion. -4. Optionally, write the remediation portion yourself to make a fully remediating test. +If you're submitting anything more substantial, we'd love if you would open an issue with your bug or feature request first, and then describe your pull request as resolving a single issue. -## Contribution Process +Vester is designed so that Someone Like You™ could [Write Your Own Vester Test]. If you have a small value in your vSphere environment you want to test for, we'd love to add more tests to the suite. -1. Create a fork of the project into your own repository. -2. From your fork, create a new feature branch (other than master) that expresses your feature or enhancement. -3. Make all your necessary changes in your feature branch. -4. Create a pull request with a description on what was added or removed and details explaining the changes in lines of code. +Questions? [Reach out!] -If approved, project owners will merge it. -[config]: https://github.com/WahlNetwork/Vester/blob/master/Configs/Config.ps1 -[config.tests]: https://github.com/WahlNetwork/Vester/blob/master/Configs/Config.Tests.ps1 -[template]: https://github.com/WahlNetwork/Vester/blob/master/Templates/Update-Template.ps1 \ No newline at end of file +[GitHub 101]: http://www.brianbunke.com/blog/2017/05/08/github-101/ +[Write Your Own Vester Test]: http://www.brianbunke.com/blog/2017/03/09/write-your-own-vester-test/ +[Reach out!]: https://github.com/WahlNetwork/Vester/blob/master/README.md diff --git a/CHANGELOG.md b/CHANGELOG.md index c8c1a4b..8837898 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,43 @@ and this project adheres to [Semantic Versioning](http://semver.org/). +## [Unreleased] + +### Added +- New Cluster HA tests ([#170][issue-170]) + - HA-AdmissionControl-AutoComputePercentages + - HA-AdmissionControl-Resource-ReductionToToleratePercent + - HA-AdmissionControlEnabled + - HA-FailoverLevel + - HA-IsolationResponse + - HA-RestartPriority +- New Cluster VUM baseline attach test ([#175][issue-175]/[#179][issue-179]) + - VUM-Attached-Baseline +- New vSAN tests, fresh from the VMworld US Hackathon! + - VSAN-DefaultHostDecommissionMode ([#173][issue-173]) +- New Host test for vDS membership ([#176][issue-176]) + - vDS-HostMembership + +### Changed +- [#172][issue-172] + - `Get-VesterTest` now supports optional `$Recommendation` variables within Vester tests + - A use case for this is providing the "Security Config Guide" value for security tests + - `$Recommendation` added to VIB-AcceptanceLevel + - A new `Vester.Format.ps1xml` file more gracefully handles the custom `[Vester.Test]` objects that `Get-VesterTest` outputs +- Vester now requires `VMware.VumAutomation.Core` to support [#175][issue-175] +- Sort inventory objects when interactively using `New-VesterConfig` ([#186][issue-186]) + +### Fixed +- Support multiple datacenters by working around a PowerCLI bug ([#180][issue-180]) +- `Invoke-Vester -XMLOutputFile -PassThru` no longer ignores `-PassThru` ([#189][issue-189]) + +### Welcome! +[@BrandonLundt](https://github.com/BrandonLundt) [@aaronwsmith](https://github.com/aaronwsmith) [@krobe](https://github.com/krobe) [@NamedJason](https://github.com/NamedJason) [@kanjibates](https://github.com/kanjibates) + +### Much ❤ +[@jeffgreenca](https://github.com/jeffgreenca) [@haberstrohr](https://github.com/haberstrohr) + + ## [1.2.0] - 2017-08-21 Dropped some long overdue documentation updates. New URL: https://wahlnetwork.github.io/Vester @@ -127,3 +164,12 @@ Published just to reserve the name on the PowerShell Gallery. If you have this v [issue-158]: https://github.com/WahlNetwork/Vester/issues/158 [issue-160]: https://github.com/WahlNetwork/Vester/issues/160 [issue-164]: https://github.com/WahlNetwork/Vester/issues/164 +[issue-170]: https://github.com/WahlNetwork/Vester/issues/170 +[issue-172]: https://github.com/WahlNetwork/Vester/issues/172 +[issue-173]: https://github.com/WahlNetwork/Vester/issues/173 +[issue-175]: https://github.com/WahlNetwork/Vester/issues/175 +[issue-176]: https://github.com/WahlNetwork/Vester/issues/176 +[issue-179]: https://github.com/WahlNetwork/Vester/issues/179 +[issue-180]: https://github.com/WahlNetwork/Vester/issues/180 +[issue-186]: https://github.com/WahlNetwork/Vester/issues/186 +[issue-189]: https://github.com/WahlNetwork/Vester/issues/189 diff --git a/README.md b/README.md index f42c4c1..0e30ebd 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,34 @@ Vester is a community project that provides an extremely light-weight approach t Vester is written entirely in PowerShell, using [PowerCLI](https://www.vmware.com/support/developer/PowerCLI/) and [Pester](https://github.com/Pester/Pester). Config files are stored as json documents that can easily live in source control. -Please visit the **[full documentation](https://wahlnetwork.github.io/Vester)** for more details. +## Getting Started -This [three-part blog series](http://www.brianbunke.com/blog/2017/03/07/introducing-vester/) from March 2017 walks you through getting started with [Vester 1.0](https://www.powershellgallery.com/packages/Vester/1.0.1). +Vester 1.2 in ten minutes at VMworld US 2017: [vBrownBag video](https://youtu.be/9TRZ30XhK10) + +Download Vester from the [PowerShell Gallery](https://www.powershellgallery.com/packages/Vester/). + +```posh +Install-Module Vester +``` + +This [three-part blog series](http://www.brianbunke.com/blog/2017/03/07/introducing-vester/) from March 2017 walks you through getting started with v1.0. It still holds up; the main difference is the new `Get-VesterTest` function, making tests easier to fetch and explore. + +## Documentation + +You can find live docs online! https://wahlnetwork.github.io/Vester + +Or in your PowerShell console: + +```posh +Get-Command -Module Vester +Get-Help about_Vester +Get-Help Get-VesterTest -Full +``` + +**[Current changelog](https://github.com/WahlNetwork/Vester/blob/master/CHANGELOG.md)** + +## Questions? + +If you found a bug, would like to submit a feature request, or just have a question about Vester, feel free to search our [issues](https://github.com/WahlNetwork/Vester/issues) page, and create a new item if nothing fits the bill. + +You're also welcome to come hang out in the #vester channel of the VMware {code} Slack workspace. [Sign up for VMware {code}](https://code.vmware.com/join), and you'll receive a Slack invite via email.