knife-openstack 2.0.1 → 4.0.0

data/CONTRIBUTING.MD

@@ -1,164 +0,0 @@
-# Contributing to Chef's knife-openstack
-
-We're glad you want to contribute to Chef's knife-openstack! The first step is the desire to improve the project.
-
-## Getting in Contact with Us
-
-If you're interested in contributing to Chef's knife-openstack or just have a question about one of one of them we'd love to chat. You can find us in #general on the [Chef Community Slack](https://community-slack.chef.io/).
-
-## Submitting Issues
-
-Not every contribution comes in the form of code. Submitting, confirming, and triaging issues is an important task for any project. At Chef we use GitHub to track all project issues.
-
-## Contribution Process
-
-We have a 3 step process for contributions:
-
-1. Commit changes to a git branch, making sure to sign-off those changes for the [Developer Certificate of Origin](#developer-certification-of-origin-dco).
-2. Create a GitHub Pull Request for your change, following the instructions in the pull request template.
-3. Perform a [Code Review](#code-review-process) with the cookbook maintainers on the pull request.
-
-### Code Review Process
-
-Code review takes place in GitHub pull requests. See [this article](https://help.github.com/articles/about-pull-requests/) if you're not familiar with GitHub Pull Requests.
-
-Once you open a pull request, cookbook maintainers will review your code using the built-in code review process in Github PRs. The process at this point is as follows:
-
-1. A maintainer will review your code and merge it if no changes are necessary. Your change will be merged into the cookbooks's `master` branch and will be noted in the cookbook's `CHANGELOG.md` at the time of release.
-2. If a maintainer has feedback or questions on your changes they they will set `request changes` in the review and provide an explanation.
-
-### Developer Certification of Origin (DCO)
-
-Licensing is very important to open source projects. It helps ensure the software continues to be available under the terms that the author desired.
-
-Chef uses [the Apache 2.0 license](https://github.com/chef/chef/blob/master/LICENSE) to strike a balance between open contribution and allowing you to use the software however you would like to.
-
-The license tells you what rights you have that are provided by the copyright holder. It is important that the contributor fully understands what rights they are licensing and agrees to them. Sometimes the copyright holder isn't the contributor, such as when the contributor is doing work on behalf of a company.
-
-To make a good faith effort to ensure these criteria are met, Chef requires the Developer Certificate of Origin (DCO) process to be followed.
-
-The DCO is an attestation attached to every contribution made by every developer. In the commit message of the contribution, the developer simply adds a Signed-off-by statement and thereby agrees to the DCO, which you can find below or at <http://developercertificate.org/>.
-
-```
-Developer's Certificate of Origin 1.1
-
-By making a contribution to this project, I certify that:
-
-(a) The contribution was created in whole or in part by me and I
-    have the right to submit it under the open source license
-    indicated in the file; or
-
-(b) The contribution is based upon previous work that, to the
-    best of my knowledge, is covered under an appropriate open
-    source license and I have the right under that license to
-    submit that work with modifications, whether created in whole
-    or in part by me, under the same open source license (unless
-    I am permitted to submit under a different license), as
-    Indicated in the file; or
-
-(c) The contribution was provided directly to me by some other
-    person who certified (a), (b) or (c) and I have not modified
-    it.
-
-(d) I understand and agree that this project and the contribution
-    are public and that a record of the contribution (including
-    all personal information I submit with it, including my
-    sign-off) is maintained indefinitely and may be redistributed
-    consistent with this project or the open source license(s)
-    involved.
-```
-
-For more information on the change see the Chef Blog post [Introducing Developer Certificate of Origin](https://blog.chef.io/2016/09/19/introducing-developer-certificate-of-origin/)
-
-#### DCO Sign-Off Methods
-
-The DCO requires a sign-off message in the following format appear on each commit in the pull request:
-
-```
-Signed-off-by: Julia Child <juliachild@chef.io>
-```
-
-The DCO text can either be manually added to your commit body, or you can add either **-s** or **--signoff** to your usual git commit commands. If you forget to add the sign-off you can also amend a previous commit with the sign-off by running **git commit --amend -s**. If you've pushed your changes to GitHub already you'll need to force push your branch after this with **git push -f**.
-
-### Chef Obvious Fix Policy
-
-Small contributions, such as fixing spelling errors, where the content is small enough to not be considered intellectual property, can be submitted without signing the contribution for the DCO.
-
-As a rule of thumb, changes are obvious fixes if they do not introduce any new functionality or creative thinking. Assuming the change does not affect functionality, some common obvious fix examples include the following:
-
-- Spelling / grammar fixes
-- Typo correction, white space and formatting changes
-- Comment clean up
-- Bug fixes that change default return values or error codes stored in constants
-- Adding logging messages or debugging output
-- Changes to 'metadata' files like Gemfile, .gitignore, build scripts, etc.
-- Moving source files from one directory or package to another
-
-**Whenever you invoke the "obvious fix" rule, please say so in your commit message:**
-
-```
-------------------------------------------------------------------------
-commit 370adb3f82d55d912b0cf9c1d1e99b132a8ed3b5
-Author: Julia Child <juliachild@chef.io>
-Date:   Wed Sep 18 11:44:40 2015 -0700
-
-  Fix typo in the README.
-
-  Obvious fix.
-
-------------------------------------------------------------------------
-```
-
-## Using git
-
-For collaboration purposes, it is best if you create a GitHub account and fork the repository to your own account. Once you do this you will be able to push your changes to your GitHub repository for others to see and use.
-
-### Branches and Commits
-
-You should submit your patch as a git branch named after the Github issue, such as GH-22\. This is called a _topic branch_ and allows users to associate a branch of code with the ticket.
-
-It is a best practice to have your commit message have a _summary line_ that includes the ticket number, followed by an empty line and then a brief description of the commit. This also helps other contributors understand the purpose of changes to the code.
-
-```text
-    [GH-22] - platform_family and style
-
-    * use platform_family for platform checking
-    * update notifies syntax to "resource_type[resource_name]" instead of
-      resources() lookup
-    * GH-692 - delete config files dropped off by packages in conf.d
-    * dropped debian 4 support because all other platforms have the same
-      values, and it is older than "old stable" debian release
-```
-
-Remember that not all users use Chef in the same way or on the same operating systems as you, so it is helpful to be clear about your use case and change so they can understand it even when it doesn't apply to them.
-
-### More information
-
-Additional help with git is available on the [Community Contributions](https://docs.chef.io/community_contributions.html#use-git) page on the Chef Docs site.
-
-## Contribution Do's and Don't's
-
-Please do include tests for your contribution. If you need help, ask on the [chef-dev mailing list](https://discourse.chef.io/c/dev) or the [Chef Community Slack](https://community-slack.chef.io/). Not all platforms that a cookbook supports may be supported by Test Kitchen. Please provide evidence of testing your contribution if it isn't trivial so we don't have to duplicate effort in testing.
-
-Please do indicate new platform (families) or platform versions in the commit message, and update the relevant ticket.
-
-If a contribution adds new platforms or platform versions, indicate such in the body of the commit message(s), and update the relevant issues. When writing commit messages, it is helpful for others if you indicate the issue. For example: git commit -m '[ISSUE-1041] - Updated pool resource to correctly delete.'
-
-Please do ensure that your changes do not break or modify behavior for other platforms supported by the cookbook. For example if your changes are for Debian, make sure that they do not break on CentOS.
-
-Please do **not** modify the version number in the `metadata.rb`, a maintainer will select the appropriate version based on the release cycle information above.
-
-Please do **not** update the `CHANGELOG.md` for a new version. Not all changes to a cookbook may be merged and released in the same versions. A maintainer will update the `CHANGELOG.md` when releasing a new version of the cookbook.
-
-## Chef Community
-
-Chef is made possible by a strong community of developers and system administrators. If you have any questions or if you would like to get involved in the Chef community you can check out:
-
-- [Chef Mailing List](https://discourse.chef.io/)
-- [Chef Community Slack](https://community-slack.chef.io/)
-
-Also here are some additional pointers to some awesome Chef content:
-
-- [Chef Docs](https://docs.chef.io/)
-- [Learn Chef](https://learn.chef.io/)
-- [Chef Website](https://www.chef.io/)

data/Gemfile

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in knife-openstack.gemspec
-gemspec
-
-group :development do
-  gem "guard-rspec"
-  gem "mixlib-shellout"
-  gem "rake", "~> 11.0"
-  gem "rspec", "~> 3.0"
-  gem "chefstyle"
-  gem "rspec-expectations"
-  gem "rspec-mocks"
-  gem "rspec_junit_formatter"
-end
-
-# our use of the fork can go away if they merge https://github.com/skywinder/github-changelog-generator/pull/453
-group(:changelog) do
-  gem "github_changelog_generator", git: "https://github.com/tduffield/github-changelog-generator", branch: "adjust-tag-section-mapping"
-end

data/README.md

@@ -1,179 +0,0 @@
-# Knife OpenStack
-
-[![Gem Version](https://badge.fury.io/rb/knife-openstack.svg)](https://rubygems.org/gems/knife-openstack) [![Build Status](https://travis-ci.org/chef/knife-openstack.svg?branch=master)](https://travis-ci.org/chef/knife-openstack) [![Dependency Status](https://gemnasium.com/chef/knife-openstack.svg)](https://gemnasium.com/chef/knife-openstack)
-
-This is the official Chef Knife plugin for OpenStack Compute (Nova). This plugin gives knife the ability to create, bootstrap and manage instances in OpenStack Compute clouds. It has been tested against the `Diablo` through `Kilo` releases in configurations using Keystone against the OpenStack API (as opposed to the EC2 API).
-
-Please refer to the [CHANGELOG](CHANGELOG.md) for version history and known issues.
-
-- Documentation: <https://github.com/chef/knife-openstack/blob/master/README.md>
-- Source: <http://github.com/chef/knife-openstack/tree/master>
-- Issues: <https://github.com/chef/knife-openstack/issues>
-- Slack: <http://community-slack.chef.io/>
-- Mailing list: <https://discourse.chef.io/>
-
-Note: Documentation needs to be updated in chef docs
-
-## Requirements
-
-- Chef 12.0 higher
-- Ruby 2.2.2 or higher
-
-## Installation
-
-Using [ChefDK](https://downloads.chef.io/chef-dk/), simply install the Gem:
-
-```bash
-chef gem install knife-openstack
-```
-
-## Configuration
-
-In order to communicate with an OpenStack API you will need to tell Knife your OpenStack Auth API endpoint, your Dashboard username and password (tenant is optional). The easiest way to accomplish this is to create these entries in your `knife.rb` file:
-
-```ruby
-### Note: If you are not proxying HTTPS to the OpenStack auth port, the scheme should be HTTP
-knife[:openstack_auth_url] = "http://cloud.mycompany.com:5000/v2.0/tokens"
-knife[:openstack_username] = "Your OpenStack Dashboard username"
-knife[:openstack_password] = "Your OpenStack Dashboard password"
-knife[:openstack_tenant] = "Your OpenStack tenant name"
-knife[:openstack_region] = "Your OpenStack Region"
-```
-
-All of Fog's `openstack` options (`openstack_domain_name`, `openstack_project_name`, ...) are supported. This includes support for the OpenStack Identity v3
-
-```ruby
-knife[:openstack_auth_url] = "http://cloud.mycompany.com:5000/v3/auth/tokens"
-knife[:openstack_username] = "Your OpenStack Dashboard username"
-knife[:openstack_password] = "Your OpenStack Dashboard password"
-knife[:openstack_project_name] = "Your OpenStack project"
-knife[:openstack_domain_name] = "Your OpenStack domain"
-```
-
-If your knife.rb file will be checked into a SCM system (ie readable by others) you may want to read the values from environment variables. For example, using the conventions of [OpenStack's RC file](http://docs.openstack.org/user-guide/content/cli_openrc.html) (note the `openstack_auth_url`):
-
-```ruby
-knife[:openstack_auth_url] = "#{ENV['OS_AUTH_URL']}/tokens"
-knife[:openstack_username] = "#{ENV['OS_USERNAME']}"
-knife[:openstack_password] = "#{ENV['OS_PASSWORD']}"
-knife[:openstack_tenant] = "#{ENV['OS_TENANT_NAME']}"
-knife[:openstack_region] = "#{ENV['OS_REGION_NAME']}"
-```
-
-If your OpenStack deployment is over SSL, but does not have a valid certificate, you can add the following option to bypass SSL check:
-
-```ruby
-knife[:openstack_insecure] = true
-```
-
-If you need to use alternate service endpoints for communicating with OpenStack, you can set the following option:
-
-```ruby
-knife[:openstack_endpoint_type] = "internalURL"
-```
-
-You also have the option of passing your OpenStack API Username/Password into the individual knife subcommands using the `-A` (or `--openstack-username`) `-K` (or `--openstack-password`) command options
-
-```bash
-# provision a new image named kb01
-knife openstack server create -A 'MyUsername' -K 'MyPassword' --openstack-api-endpoint 'http://cloud.mycompany.com:5000/v2.0/tokens' -f 1 -I 13 -S trystack -i ~/.ssh/trystack.pem -r 'role[webserver]'
-```
-
-Additionally the following options may be set in your `knife.rb`:
-
-- flavor
-- image
-- openstack_ssh_key_id
-- template_file
-
-## Subcommands
-
-This plugin provides the following Knife subcommands. Specific command options can be found by invoking the subcommand with a `--help` option.
-
-### `knife openstack server create`
-
-Provisions a new server in an OpenStack Compute cloud and then perform a Chef bootstrap (using the SSH protocol). The goal of the bootstrap is to get Chef installed on the target system so it can run Chef Client with a Chef Server. The main assumption is a baseline OS installation exists (provided by the provisioning). It is primarily intended for Chef Client systems that talk to a Chef server. By default the server is bootstrapped using the [chef-full](https://github.com/opscode/chef/blob/master/chef/lib/chef/knife/bootstrap/chef-full.erb) template (default since the 10.10 release). This may be overridden using the `-d` or `--template-file` command options. If you do not have public IP addresses, use the `--openstack-private-network` option to use the private IP address for bootstrapping. In addition, you can use the `--bootstrap-network NAME` option to specify an alternate network for either a private or public network. If a network name isn't specified, the default name will be `'public'` for a public network and `'private'` for a private network e.g. when the `--openstack-private-network` option is specified. Please see `knife openstack server create --help` for all of the supported options.
-
-#### Working with Windows Images
-
-Provisioning and bootstrapping for Windows 2003 and later images is now supported. The Windows images need to have WinRM enabled with Basic Authentication configured. Current support does not support Kerberos Authentication.
-
-Example:
-
-```bash
-$ knife openstack server create -I <Image> -f <Flavor> -S <keypair_name> --bootstrap-protocol winrm -P <Administrator_Password> -x Administrator -N <chef_node_name> --bootstrap-template windows-chef-client-msi.erb
-```
-
-NOTE:
-
-- Bootstrap Protocol (`--bootstrap-protocol`) is required to be set to `winrm`.
-- Administrator Username (`--winrm-user` or `-x`) and Password (`-P`) are required parameters.
-- If the Template File (`--template`) is not specified it defaults to a Linux distro (most likely Ubuntu).
-
-#### Working with Floating IPs
-
-To use a floating IP address while bootstrapping nodes, use the `-a` or `--openstack-floating-ip` option.
-
-### `knife openstack server delete`
-
-Deletes an existing server in the currently configured OpenStack account. If a floating IP address has been assigned to the node, it is disassociated automatically by the OpenStack server. **PLEASE NOTE** - this does not delete the associated node and client objects from the Chef server without using the `-P` option to purge the client.
-
-### `knife openstack server list`
-
-Outputs a list of all servers in the currently configured OpenStack account. **PLEASE NOTE** - this shows all instances associated with the account, some of which may not be currently managed by the Chef server.
-
-### `knife openstack flavor list`
-
-Provides a list of all available flavors (available "hardware" configurations for a server) available to the currently configured OpenStack account. Each flavor has a unique combination of virtual cpus, disk space and memory capacity. This data may be useful when choosing a flavor to pass to the `knife openstack server create` subcommand.
-
-### `knife openstack volume list`
-
-Provides a list of all volumes in the currently configured OpenStack account. Each volume shows its size and its availibility to be attached to server. This data may be useful when choosing a volume to pass to the `knife openstack server create` subcommand.
-
-### `knife openstack image list`
-
-Lists all available images and snapshots available to the currently configured OpenStack account. An image is a collection of files used to create or rebuild a server. The retuned list filters out image names ending in 'initrd', 'kernel', 'loader', 'virtual' or 'vmlinuz' (this may be disabled with `--disable-filter`). This data may be useful when choosing an image to pass to the `knife openstack server create` subcommand.
-
-### `knife openstack group list`
-
-Provides a list of the security groups available to the currently configured OpenStack account. Each group may have multiple rules. This data may be useful when choosing your security group(s) to pass to the `knife openstack server create` subcommand.
-
-### `knife openstack network list`
-
-Lists the networks available to the currently configured OpenStack account. This data may be useful when choosing your networks to pass to the `knife openstack server create` subcommand. This command is only available with OpenStack deployments using the Neutron network service (not nova-network). Please see `knife openstack server create --help` for all of the supported options.
-
-### `knife openstack floating_ip list`
-
-Lists all of the available `floating-ips` you have associated with your account. You can ask for more via: `knife openstack floating_ip allocate --pool POOL` if you have run out. You can also `knife openstack floating_ip associate FLOATING_IP --instance-id INSTANCE_ID` and too. If you need to remove the `floating-ip` you can `disassociate` with the same command. If you would like to give back the `floating-ip` you can `knife openstack floating_ip release FLOATING_IP_ID`
-
-## Contributing
-
-For information on contributing to this project see <https://github.com/chef/chef/blob/master/CONTRIBUTING.md>
-
-## License
-
-Author:: Seth Chisamore ([schisamo@chef.io](mailto:schisamo@chef.io))
-
-Author:: Matt Ray ([matt@chef.io](mailto:matt@chef.io))
-
-Author:: Chirag Jog ([chirag@clogeny.com](mailto:chirag@clogeny.com))
-
-Author:: JJ Asghar ([jj@chef.io](mailto:jj@chef.io))
-
-Copyright:: Copyright (c) 2011-2016 Chef Software, Inc.
-
-License:: Apache License, Version 2.0
-
-```text
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-```

data/Rakefile

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-# Author:: Kaustubh Deorukhkar (<kaustubh@clogeny.com>)
-# Copyright:: Copyright (c) 2013-2016 Chef Software, Inc.
-
-require "bundler"
-require "bundler/setup"
-require "bundler/gem_tasks"
-require "chefstyle"
-require "rubocop/rake_task"
-require "rspec/core/rake_task"
-require "github_changelog_generator/task"
-require "knife-openstack/version"
-
-RuboCop::RakeTask.new
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: [:rubocop, :spec]
-
-GitHubChangelogGenerator::RakeTask.new :changelog do |config|
-  config.future_release = Knife::OpenStack::VERSION
-  config.max_issues = 0
-  config.add_issues_wo_labels = false
-  config.enhancement_labels = "enhancement,Enhancement,New Feature,Feature".split(",")
-  config.bug_labels = "bug,Bug,Improvement,Upstream Bug".split(",")
-  config.exclude_labels = "duplicate,question,invalid,wontfix,no_changelog,Exclude From Changelog,Question,Discussion,Tech Cleanup".split(",")
-end

data/knife-openstack.gemspec

@@ -1,30 +0,0 @@
-# -*- encoding: utf-8 -*-
-# frozen_string_literal: true
-$LOAD_PATH.push File.expand_path("../lib", __FILE__)
-require "knife-openstack/version"
-
-Gem::Specification.new do |s|
-  s.name        = "knife-openstack"
-  s.version     = Knife::OpenStack::VERSION
-  s.version = "#{s.version}-alpha-#{ENV['TRAVIS_BUILD_NUMBER']}" if ENV["TRAVIS"]
-  s.platform = Gem::Platform::RUBY
-  s.has_rdoc = true
-  s.extra_rdoc_files = ["README.md", "LICENSE"]
-  s.authors     = ["JJ Asghar"]
-  s.email       = ["jj@chef.io"]
-  s.homepage    = "https://github.com/chef/knife-openstack"
-  s.summary     = "A Chef knife plugin for OpenStack clouds."
-  s.description = "A Chef knife plugin for OpenStack clouds."
-  s.license     = "Apache-2.0"
-
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
-  s.require_paths = ["lib"]
-
-  s.required_ruby_version = ">= 2.2.2"
-
-  s.add_dependency "fog", "~> 1.23"
-  s.add_dependency "chef", ">= 12"
-  s.add_dependency "knife-cloud", "~> 1.2.0"
-end

data/spec/functional/flavor_list_func_spec.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-#
-# Author:: Mukta Aphale (<mukta.aphale@clogeny.com>)
-# Author:: Ameya Varade (<ameya.varade@clogeny.com>)
-# Copyright:: Copyright (c) 2013-2014 Chef Software, Inc.
-# License:: Apache License, Version 2.0
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-require "spec_helper"
-require "chef/knife/openstack_flavor_list"
-require "chef/knife/cloud/openstack_service"
-require "support/shared_examples_for_command"
-
-describe Chef::Knife::Cloud::OpenstackFlavorList do
-  let (:instance) { Chef::Knife::Cloud::OpenstackFlavorList.new }
-
-  context "functionality" do
-    before do
-      resources = [TestResource.new(id: "resource-1", name: "m1.tiny", vcpus: "1", ram: 512, disk: 0),
-                   TestResource.new(id: "resource-2", name: "m1-xlarge-bigdisk", vcpus: "8", ram: 16_384, disk: 50),
-                  ]
-      allow(instance).to receive(:query_resource).and_return(resources)
-      allow(instance).to receive(:puts)
-      allow(instance).to receive(:create_service_instance).and_return(Chef::Knife::Cloud::Service.new)
-      allow(instance).to receive(:validate!)
-      instance.config[:format] = "summary"
-    end
-
-    it "lists formatted list of resources" do
-      expect(instance.ui).to receive(:list).with(["Name", "ID", "Virtual CPUs", "RAM", "Disk",
-                                                  "m1-xlarge-bigdisk", "resource-2", "8", "16384 MB", "50 GB",
-                                                  "m1.tiny", "resource-1", "1", "512 MB", "0 GB"], :uneven_columns_across, 5)
-      instance.run
-    end
-  end
-end