From 92b6694a0a97be485ca46d6c233e900525a498e3 Mon Sep 17 00:00:00 2001 From: Lance Albertson Date: Fri, 6 Dec 2019 10:33:21 -0800 Subject: [PATCH] Updates for rocky - Replace git.openstack.org with opendev.org - Update some documentation - Move README.md to README.rst for better rendering Change-Id: Id39550d931218a60c5229802d9f660ce59ae0ad6 --- Berksfile | 19 ++++++--- README.md | 6 --- README.rst | 120 ++++++++++++++++++++++++++++++++++++++++++++++++++++ metadata.rb | 7 ++- 4 files changed, 135 insertions(+), 17 deletions(-) delete mode 100644 README.md create mode 100644 README.rst diff --git a/Berksfile b/Berksfile index 6cca20b..f08f6b3 100644 --- a/Berksfile +++ b/Berksfile @@ -1,14 +1,19 @@ source 'https://supermarket.chef.io' -%w(common identity image network).each do |cookbook| - if Dir.exist?("../cookbook-openstack-#{cookbook}") - cookbook "openstack-#{cookbook}", path: "../cookbook-openstack-#{cookbook}" +solver :ruby, :required + +%w( + client + -common + -identity + -image + -network +).each do |cookbook| + if Dir.exist?("../cookbook-openstack#{cookbook}") + cookbook "openstack#{cookbook}", path: "../cookbook-openstack#{cookbook}" else - cookbook "openstack-#{cookbook}", git: "https://git.openstack.org/openstack/cookbook-openstack-#{cookbook}" + cookbook "openstack#{cookbook}", git: "https://opendev.org/openstack/cookbook-openstack#{cookbook}" end end -cookbook 'openstackclient', - git: 'https://git.openstack.org/openstack/cookbook-openstackclient' - metadata diff --git a/README.md b/README.md deleted file mode 100644 index b72ee4f..0000000 --- a/README.md +++ /dev/null @@ -1,6 +0,0 @@ -This project is no longer maintained. - -The contents of this repository are still available in the Git -source code management system. To see the contents of this -repository before it reached its end of life, please check out the -previous commit with "git checkout HEAD^1". diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..d000452 --- /dev/null +++ b/README.rst @@ -0,0 +1,120 @@ +OpenStack Chef Cookbook - bare-metal +==================================== + +.. image:: https://governance.openstack.org/badges/cookbook-openstack-bare-metal.svg + :target: https://governance.openstack.org/reference/tags/index.html + +Description +=========== + +This cookbook installs the OpenStack Bare Metal service **Ironic** as +part of the OpenStack reference deployment Chef for OpenStack. The +`OpenStack chef-repo`_ contains documentation for using this cookbook in +the context of a full OpenStack deployment. Nova is currently installed +from packages. + +.. _OpenStack chef-repo: https://opendev.org/openstack/openstack-chef + +https://docs.openstack.org/ironic/latest/ + +Requirements +============ + +- Chef 14 or higher +- ChefDK 3.2.30 for testing (also includes Berkshelf for cookbook + dependency resolution) + +Platform +======== + +- ubuntu +- redhat +- centos + +Cookbooks +========= + +The following cookbooks are dependencies: + +- 'openstack-common', '>= 18.0.0' +- 'openstack-identity', '>= 18.0.0' +- 'openstack-image', '>= 18.0.0' +- 'openstack-network', '>= 18.0.0' + +Attributes +========== + +Please see the extensive inline documentation in ``attributes/*.rb`` for +descriptions of all the settable attributes for this cookbook. + +Note that all attributes are in the ``default['openstack']`` "namespace" + +The usage of attributes to generate the ``ironic.conf`` is described in the +openstack-common cookbook. + +Recipes +======= + +openstack-bare-metal::api +------------------------- + +- Installs the ``ironic-api``, sets up the ironic database + +openstack-bare-metal::conductor +------------------------------- + +- Installs the ``ironic-conductor`` service + +openstack-bare-metal::default +----------------------------- + +- Temp workaround to create ironic db with user + +openstack-bare-metal::identity_registration +------------------------------------------- + +- Registers ironic service/user/endpoints in keystone + +openstack-bare-metal::ironic-common +----------------------------------- + +- Defines the common pieces of repeated code from the other recipes + +License and Author +================== + ++-----------------+---------------------------------------------------+ +| **Author** | Mark Vanderwiel | ++-----------------+---------------------------------------------------+ +| **Author** | Ma Wen Cheng | ++-----------------+---------------------------------------------------+ +| **Author** | Jan Klare | ++-----------------+---------------------------------------------------+ +| **Author** | Jens Harbott | ++-----------------+---------------------------------------------------+ +| **Author** | Lance Albertson | ++-----------------+---------------------------------------------------+ +| **Author** | Samuel Cassiba | ++-----------------+---------------------------------------------------+ + ++-----------------+---------------------------------------------------+ +| **Copyright** | Copyright (c) 2015, IBM, Corp. | ++-----------------+---------------------------------------------------+ +| **Copyright** | Copyright (c) 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 3ece712..f98a8d5 100644 --- a/metadata.rb +++ b/metadata.rb @@ -3,11 +3,10 @@ maintainer 'openstack-chef' maintainer_email 'openstack-discuss@lists.openstack.org' license 'Apache-2.0' description 'Installs/Configures OpenStack Bare Metal service Ironic' -long_description IO.read(File.join(File.dirname(__FILE__), 'README.md')) version '18.0.0' -issues_url 'https://launchpad.net/openstack-chef' if respond_to?(:issues_url) -source_url 'https://github.com/openstack/cookbook-openstack-bare-metal' if respond_to?(:source_url) -chef_version '>= 12.5' if respond_to?(:chef_version) +issues_url 'https://launchpad.net/openstack-chef' +source_url 'https://opendev.org/openstack/cookbook-openstack-bare-metal' +chef_version '>= 14.0' recipe 'openstack-bare-metal::api', 'Installs the ironic-api, sets up the ironic database' recipe 'openstack-bare-metal::conductor', 'Installs the ironic-conductor service'