diff --git a/README.md b/README.md deleted file mode 100644 index d073e4a..0000000 --- a/README.md +++ /dev/null @@ -1,50 +0,0 @@ -# Description - -Installs the fog-openstack gem and offers LWRPs to use it. - -# Requirements - -- gem 'fog-openstack' -- chef-client >= 12.8.1 - -# Resources - -## openstack_domain -- creates or deletes an openstack domain -- example recipe can be found - [here](spec/cookbooks/openstackclient_test/recipes/domain.rb) - -## openstack_endpoint -- creates or deletes an openstack endpoint -- example recipe can be found - [here](spec/cookbooks/openstackclient_test/recipes/endpoint.rb) - -## openstack_project -- creates or deletes an openstack project -- example recipe can be found - [here](spec/cookbooks/openstackclient_test/recipes/project.rb) - -## openstack_role -- creates or deletes an openstack role -- example recipe can be found - [here](spec/cookbooks/openstackclient_test/recipes/role.rb) - -## openstack_service -- creates or deletes an openstack service -- example recipe can be found - [here](spec/cookbooks/openstackclient_test/recipes/service.rb) - -## openstack_user -- creates or deletes an openstack user -- grants or revokes role to user in project -- grants or revokes domain to user -- example recipe can be found - [here](spec/cookbooks/openstackclient_test/recipes/user.rb) - -# License and Maintainer - -Maintainer:: cloudbau GmbH () -Source:: https://github.com/cloudbau/cookbook-openstackclient -Issues:: https://github.com/cloudbau/cookbook-openstackclient/issues - -License:: Apache v2.0 diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..b23fd71 --- /dev/null +++ b/README.rst @@ -0,0 +1,97 @@ +OpenStack Chef Cookbook - openstackclient +========================================= + +.. image:: https://governance.openstack.org/badges/cookbook-openstackclient.svg + :target: https://governance.openstack.org/reference/tags/index.html + +Description +=========== + +Installs the ``fog-openstack`` gem and offers custom resources to use +it. + +Requirements +============ + +- Chef 14 or higher +- ChefDK 3.2.30 for testing (also includes Berkshelf for cookbook + dependency resolution) +- gem 'fog-openstack' + +Resources +========= + +openstack_domain +---------------- + +- creates or deletes an openstack domain +- example recipe can be found + `here `__ + +openstack_endpoint +------------------ + +- creates or deletes an openstack endpoint +- example recipe can be found + `here `__ + +openstack_project +----------------- + +- creates or deletes an openstack project +- example recipe can be found + `here `__ + +openstack_role +-------------- + +- creates or deletes an openstack role +- example recipe can be found + `here `__ + +openstack_service +----------------- + +- creates or deletes an openstack service +- example recipe can be found + `here `__ + +openstack_user +-------------- + +- creates or deletes an openstack user +- grants or revokes role to user in project +- grants or revokes domain to user +- example recipe can be found + `here `__ + +License and Author +================== + ++-----------------+---------------------------------------------------+ +| **Author** | Jan Klare (j.klare@x-ion.de) | ++-----------------+---------------------------------------------------+ +| **Author** | Lance Albertson (lance@osuosl.org) | ++-----------------+---------------------------------------------------+ + ++-----------------+---------------------------------------------------+ +| **Copyright** | Copyright (c) 2016-2018, cloudbau GmbH | ++-----------------+---------------------------------------------------+ +| **Copyright** | Copyright (c) 2016-2019, x-ion GmbH | ++-----------------+---------------------------------------------------+ +| **Copyright** | Copyright (c) 2019, Oregon State University | ++-----------------+---------------------------------------------------+ + +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. diff --git a/metadata.rb b/metadata.rb index 6bb2b94..3b7ffec 100644 --- a/metadata.rb +++ b/metadata.rb @@ -5,7 +5,7 @@ license 'Apache-2.0' description 'Installs the fog-openstack gem and offers LWRPs to use it' issues_url 'https://launchpad.net/openstack-chef' source_url 'https://opendev.org/openstack/cookbook-openstack-client' -chef_version '>= 12.5' if respond_to?(:chef_version) +chef_version '>= 14.0' version '18.0.0' %w(ubuntu redhat centos).each do |os|