Browse Source

update the README after refactoring and align it with other cookbooks

* also removed the empty default recipe

Change-Id: Iff2c536d595f90f932129ab8a2faad17ae41415b
Jan Klare 3 years ago
parent
commit
f950ab4b40
3 changed files with 36 additions and 100 deletions
  1. 36
    74
      README.md
  2. 0
    7
      metadata.rb
  3. 0
    19
      recipes/default.rb

+ 36
- 74
README.md View File

@@ -1,105 +1,67 @@
1 1
 Description
2 2
 ===========
3 3
 
4
-This cookbook installs the OpenStack Heat service **Heat** as part of an OpenStack reference deployment Chef for OpenStack.
4
+This cookbook installs the OpenStack Heat service **Heat** as part of an
5
+OpenStack reference deployment Chef for OpenStack.
5 6
 
6 7
 https://wiki.openstack.org/wiki/Heat
7 8
 
8 9
 Requirements
9 10
 ============
10 11
 
11
-Chef 11 or higher required (for Chef environment use).
12
+- Chef 12 or higher
13
+- chefdk 0.9.0 for testing (also includes berkshelf for cookbook dependency
14
+  resolution)
12 15
 
13
-Cookbooks
14
----------
15
-
16
-The following cookbooks are dependencies:
17
-
18
-* openstack-common
19
-* openstack-identity
20
-
21
-Usage
22
-=====
23
-
24
-api
25
-------
26
-- Configure and start heat-api service
16
+Platform
17
+========
27 18
 
28
-api-cfn
29
-------
30
-- Configure and start heat-api-cfn service
31
-
32
-api-cloudwatch
33
-------
34
-- Configure and start heat-api-cloudwatch service
19
+- ubuntu
20
+- redhat
21
+- centos
35 22
 
36
-client
37
-----
38
-- Install the heat client packages
39
-
40
-common
41
-------
42
-- Installs the heat packages and setup configuration for Heat.
23
+Cookbooks
24
+=========
43 25
 
44
-engine
45
-------
46
-- Setup the heat database and start heat-engine service
26
+The following cookbooks are dependencies:
47 27
 
48
-identity_registration
49
----------------------
50
-- Registers the Heat API endpoint, heat service and user
28
+- 'openstack-common', '>= 13.0.0'
29
+- 'openstack-identity', '>= 13.0.0'
51 30
 
52 31
 Attributes
53 32
 ==========
54 33
 
55
-Attributes for the Heat service are in the ['openstack']['orchestration'] namespace.
56
-
57
-* `openstack['orchestration']['identity_service_chef_role']` - The name of the Chef role that installs the Keystone Service API
58
-* `openstack['orchestration']['rabbit_server_chef_role']` - The name of the Chef role that knows about the message queue server
59
-* `openstack['orchestration']['user']` - User heat runs as
60
-* `openstack['orchestration']['group']` - Group heat runs as
61
-* `openstack['db']['orchestration']['username']` - Username for heat database access
62
-* `openstack['orchestration']['service_role']` - User role used by heat when interacting with keystone, defaults to 'service'. Used in the API and registry paste.ini files
63
-* `openstack['orchestration']['syslog']['use']` - Should heat log to syslog?
64
-* `openstack['orchestration']['platform']` - hash of platform specific package/service names and options
65
-* `openstack['orchestration']['api']['auth']['version']` - Select v2.0 or v3.0. Default v2.0. The auth API version used to interact with the identity service.
34
+Please see the extensive inline documentation in `attributes/*.rb` for
35
+descriptions of all the settable attributes for this cookbook.
66 36
 
67
-TODO: update this section adding new attributes
37
+Note that all attributes are in the `default['openstack']` "namespace"
68 38
 
69
-MQ attributes
70
--------------
39
+The usage of attributes to generate the heat.conf is decribed in the
40
+openstack-common cookbook.
71 41
 
72
-TODO: update this section with the new attributes
42
+Recipes
43
+=======
73 44
 
74
-Service bindings
75
-----------------
76
-
77
-* `openstack['bind_service']['all']['orchestration-api']['host']` - The IP address to bind the service to
78
-* `openstack['bind_service']['all']['orchestration-api']['port']` - The port to bind the service to
79
-* `openstack['bind_service']['all']['orchestration-api']['interface']` - The interface to bind the service to
80
-
81
-* `openstack['bind_service']['all']['orchestration-api-cfn']['host']` - The IP address to bind the service to
82
-* `openstack['bind_service']['all']['orchestration-api-cfn']['port']` - The port to bind the service to
83
-* `openstack['bind_service']['all']['orchestration-api-cfn']['interface']` - The interface to bind the service to
45
+## openstack-orchestration::api-cloudwatch
46
+- Configure and start heat-api-cloudwatch service
84 47
 
85
-* `openstack['bind_service']['all']['orchestration-api-cloudwatch']['host']` - The IP address to bind the service to
86
-* `openstack['bind_service']['all']['orchestration-api-cloudwatch']['port']` - The port to bind the service to
87
-* `openstack['bind_service']['all']['orchestration-api-cloudwatch']['interface']` - The interface to bind the service to
48
+## openstack-orchestration::api-cfn
49
+- Configure and start heat-api-cfn service
88 50
 
89
-If the value of the 'interface' attribute is non-nil, then the service will be bound to the first IP address on that interface and
90
-the 'host' attribute will be ignored. 
91
-If the value of the 'interface' attribute is nil (which is the default), then the service will be bound to the IP address specified
92
-in the 'host' attribute.
51
+## openstack-orchestration::api
52
+- Configure and start heat-api service
93 53
 
94
-Miscellaneous Options
95
----------------------
54
+## openstack-orchestration::client
55
+- Install the heat client packages
96 56
 
97
-* `orchestration_auth_encryption_key` - Key used to encrypt authentication info in the database. Length of this key must be 16, 24 or 32 characters. Comes from secrets databag.
57
+## openstack-orchestration::common
58
+- Installs the heat packages and setup configuration for Heat.
98 59
 
99
-Testing
100
-=====
60
+## openstack-orchestration::engine
61
+- Setup the heat database and start heat-engine service
101 62
 
102
-Please refer to the [TESTING.md](TESTING.md) for instructions for testing the cookbook.
63
+## openstack-orchestration::identity_registration
64
+- Registers the Heat API endpoint, heat service and user
103 65
 
104 66
 License and Author
105 67
 ==================

+ 0
- 7
metadata.rb View File

@@ -6,13 +6,6 @@ license 'Apache 2.0'
6 6
 description 'Installs and configures the Heat Service'
7 7
 long_description IO.read(File.join(File.dirname(__FILE__), 'README.md'))
8 8
 version '13.0.0'
9
-recipe 'openstack-orchestration::api', 'Start and configure the Heat API service'
10
-recipe 'openstack-orchestration::api-cfn', 'Start and configure the Heat API CloudFormation service'
11
-recipe 'openstack-orchestration::api-cloudwatch', 'Start and configure the Heat API CloudWatch service'
12
-recipe 'openstack-orchestration::client', 'Installs packages for heat client'
13
-recipe 'openstack-orchestration::common', 'Installs packages and configures a Heat Server'
14
-recipe 'openstack-orchestration::engine', 'Sets up Heat database and starts Heat Engine service'
15
-recipe 'openstack-orchestration::identity_registration', 'Registers Heat service, user and endpoints with Keystone'
16 9
 
17 10
 %w(ubuntu redhat centos).each do |os|
18 11
   supports os

+ 0
- 19
recipes/default.rb View File

@@ -1,19 +0,0 @@
1
-# encoding: UTF-8
2
-#
3
-# Cookbook Name:: openstack-orchestration
4
-# Recipe:: default
5
-#
6
-# Copyright 2013, IBM Corp.
7
-#
8
-# Licensed under the Apache License, Version 2.0 (the "License");
9
-# you may not use this file except in compliance with the License.
10
-# You may obtain a copy of the License at
11
-#
12
-#     http://www.apache.org/licenses/LICENSE-2.0
13
-#
14
-# Unless required by applicable law or agreed to in writing, software
15
-# distributed under the License is distributed on an "AS IS" BASIS,
16
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17
-# See the License for the specific language governing permissions and
18
-# limitations under the License.
19
-#

Loading…
Cancel
Save