Updates for rocky
- Update some documentation - Move README.md to README.rst for better rendering Change-Id: I4056718fea8ef476b0805cbf24c4d724d513a98a
This commit is contained in:
parent
26826bfa8e
commit
5b651a5207
50
README.md
50
README.md
@ -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 (<j.klare@cloudbau.de>)
|
||||
Source:: https://github.com/cloudbau/cookbook-openstackclient
|
||||
Issues:: https://github.com/cloudbau/cookbook-openstackclient/issues
|
||||
|
||||
License:: Apache v2.0
|
97
README.rst
Normal file
97
README.rst
Normal file
@ -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 <cookbook-openstackclient/src/branch/master/spec/cookbooks/openstackclient_test/recipes/domain.rb>`__
|
||||
|
||||
openstack_endpoint
|
||||
------------------
|
||||
|
||||
- creates or deletes an openstack endpoint
|
||||
- example recipe can be found
|
||||
`here <cookbook-openstackclient/src/branch/master/spec/cookbooks/openstackclient_test/recipes/endpoint.rb>`__
|
||||
|
||||
openstack_project
|
||||
-----------------
|
||||
|
||||
- creates or deletes an openstack project
|
||||
- example recipe can be found
|
||||
`here <cookbook-openstackclient/src/branch/master/spec/cookbooks/openstackclient_test/recipes/project.rb>`__
|
||||
|
||||
openstack_role
|
||||
--------------
|
||||
|
||||
- creates or deletes an openstack role
|
||||
- example recipe can be found
|
||||
`here <cookbook-openstackclient/src/branch/master/spec/cookbooks/openstackclient_test/recipes/role.rb>`__
|
||||
|
||||
openstack_service
|
||||
-----------------
|
||||
|
||||
- creates or deletes an openstack service
|
||||
- example recipe can be found
|
||||
`here <cookbook-openstackclient/src/branch/master/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 <cookbook-openstackclient/src/branch/master/spec/cookbooks/openstackclient_test/recipes/user.rb>`__
|
||||
|
||||
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.
|
@ -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|
|
||||
|
Loading…
Reference in New Issue
Block a user