Merge branch 'release/1.0.0'

Author: jyang09

CHANGELOG.md

@@ -1,3 +1,25 @@
+Changelog
+=========
+
+1.0.0
+-----
+
+* Improved logic in Vtp class to handle the presence or absence of
+  'feature vtp' and 'vtp domain' configuration.
+* Fixed missing `default_timer_throttle_*` APIs in RouterOspfVrf class.
+* Fixed idempotency and area update issues in interface_ospf class.
+* Updated CliError class definition to make it easier to troubleshoot such
+  errors when running Puppet modules that use this gem.
+* Added dotted-decimal munging for the area getter in interface_ospf.
+* Added n9000_sample*.rpm to /tests for use with minitests.
+* Updated yum install method to include vrf, fixes minitest issue.
+* Extended cisco_interface with the following attributes:
+  * encapsulation dot1q
+  * mtu
+  * switchport trunk allowed and native vlans
+  * vrf member
+* Move misc READMEs into /docs
+
 0.9.0
 -----
 

CONTRIBUTING.md

@@ -1,31 +1,33 @@
-# Contributing
-
-## Submitting an Issue
-
-Issues are tracked on GitHub (TODO).
-
-## Developing a new Feature Provider
-
-1. Create a new class file in `lib/cisco_node_utils/`.
-2. Write the class.
-3. Add the class to `lib/cisco_node_utils.rb`.
-4. Create a new minitest file in `tests/`.
-5. Write the minitest. We recommend subclassing the provided `CiscoTestCase`
-   class as it provides numerous helper methods.
-6. Run the minitest. `ruby test_my_feature.rb -- <NX-OS node IP> <user> <pass>`
-7. Once minitest is passing, add the test to `tests/test_all_cisco.rb`.
-8. Run rubocop (`rake rubocop`) and fix any failures.
-9. Proceed to submit a pull request as described below.
-
-## Submitting a Pull Request
-
-1. Fork the code (https://github.com/cisco/cisco_node_utils/fork) (TODO)
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Write your code
-4. Write minitest cases to cover your new code
-5. Verify that minitest passes in full (`ruby tests/test_all_cisco.rb --
-   n3k_test.mycompany.com username password`)
-6. Verify that rubocop also passes (`rake rubocop`).
-7. Commit your changes (`git commit -am 'Add some feature'`)
-8. Push to the branch (`git push origin my-new-feature`)
-9. Create a new Pull Request
+# How to contribute
+Cisco Network Elements support a rich set of features to make networks robust, efficient and secure. The GitHub project [cisco-network-puppet-module](https://github.com/cisco/cisco-network-puppet-module) defines a set of Puppet resource types and providers to manage the network element. Similarly, the GitHub project [cisco-network-chef-cookbook](https://github.com/cisco/cisco-network-chef-cookbook) defines a set of Chef resources and providers for network element management. The providers defined in these projects leverage a common set of Ruby API Objects defined in this project. This object set is expected to grow with contributions from Cisco, Cisco-Partners and third-party alike. Contributions to this project are welcome. To ensure code quality, contributors will be requested to follow few guidelines.
+
+## Getting Started
+
+* Create a [GitHub account](https://github.com/signup/free)
+* Create a [cisco.com](http://cisco.com) account if you need access to a Network Simulator to test your code.
+
+## Making Changes
+
+* Fork the repository
+  * Pull a branch under the "develop" branch for your changes.
+  * Follow all guidelines documented in [README-creating-node_utils-APIs](#README-creating-node_utils-APIs.md)
+  * Make changes in your branch.
+* Testing
+  * Create a minitest for new APIs or new functionality
+  * Run all the tests to ensure there was no collateral damage to existing code
+* Committing
+  * Check for unnecessary whitespace with `git diff --check` before committing.
+  * Run `rubocop --lint` against all changed files. See [https://rubygems.org/gems/rubocop](https://rubygems.org/gems/rubocop)
+  * Make sure your commit messages clearly describe the problem you are trying to solve and the proposed solution.
+
+## Submitting Changes
+
+* All contributions you submit to this project are voluntary and subject to the terms of the Apache 2.0 license
+* Submit a pull request to the repository
+* A core team consisting of Cisco and Cisco-Partner employees will looks at Pull Request and provide feedback.
+* After feedback has been given we expect responses within two weeks. After two weeks we may close the pull request if it isn't showing any activity.
+
+# Additional Resources
+
+* [General GitHub documentation](http://help.github.com/)
+* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)

SUPPORT.md

@@ -0,0 +1,3 @@
+Cisco Node Utils GEM is supported by Cisco Partners and Cisco Systems.
+
+Please report any issues with this module to [https://github.com/cisco/cisco-network-node-utils/issues](https://github.com/cisco/cisco-network-node-utils/issues)

cisco_node_utils.gemspec

@@ -26,5 +26,5 @@ Currently supports NX-OS nodes.
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rubocop', '>= 0.32'
-  spec.add_runtime_dependency 'cisco_nxapi', '>= 0.9'
+  spec.add_runtime_dependency 'cisco_nxapi', '~> 1.0'
 end

docs/.rubocop.yml

@@ -0,0 +1,13 @@
+# Rubocop configuration
+
+inherit_from: ../.rubocop.yml
+
+Style/ClassAndModuleCamelCase:
+  Enabled: false
+
+Style/FileName:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+