From 777ab9691ce7de1dcb0d770ea5f8271ebf76e99a Mon Sep 17 00:00:00 2001 From: Julia Kreger Date: Wed, 25 Mar 2015 19:59:20 -0400 Subject: [PATCH] Updated role readme files Update role readme files to include a very basic description and the correct license. --- roles/bifrost-configdrives/README.md | 34 +++++++++++++++--------- roles/bifrost-prepare-for-test/README.md | 34 +++++++++++++++--------- roles/bifrost-setup-nodes/README.md | 30 +++++++++++++-------- roles/bifrost-test-vm/README.md | 34 +++++++++++++++--------- roles/ironic-deploy/README.md | 34 +++++++++++++++--------- roles/ironic-enroll/README.md | 34 +++++++++++++++--------- 6 files changed, 124 insertions(+), 76 deletions(-) diff --git a/roles/bifrost-configdrives/README.md b/roles/bifrost-configdrives/README.md index 225dd44b9..3997e1388 100644 --- a/roles/bifrost-configdrives/README.md +++ b/roles/bifrost-configdrives/README.md @@ -1,38 +1,46 @@ -Role Name -========= +bifrost-configdrives +==================== -A brief description of the role goes here. +Creates configdrives for nodes being provisioned in Bifrost. Requirements ------------ -Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required. +TODO Role Variables -------------- -A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well. +TODO Dependencies ------------ -A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles. +TODO Example Playbook ---------------- -Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too: - - - hosts: servers - roles: - - { role: username.rolename, x: 42 } +TODO License ------- -BSD +Copyright (c) 2015 Hewlett-Packard Development Company, L.P. + +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 orimplied. +See the License for the specific language governing permissions and +limitations under the License. Author Information ------------------ -An optional section for the role authors to include contact information, or a website (HTML is not allowed). +Ironic Developers diff --git a/roles/bifrost-prepare-for-test/README.md b/roles/bifrost-prepare-for-test/README.md index 225dd44b9..b0fd4f05f 100644 --- a/roles/bifrost-prepare-for-test/README.md +++ b/roles/bifrost-prepare-for-test/README.md @@ -1,38 +1,46 @@ -Role Name -========= +bifrost-prepare-for-test +======================== -A brief description of the role goes here. +Enrolls nodes that have been stood up by the deployment module in Bifrost, into the in-memory inventory for testing. Requirements ------------ -Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required. +TODO Role Variables -------------- -A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well. +TODO Dependencies ------------ -A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles. +TODO Example Playbook ---------------- -Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too: - - - hosts: servers - roles: - - { role: username.rolename, x: 42 } +TODO License ------- -BSD +Copyright (c) 2015 Hewlett-Packard Development Company, L.P. + +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 orimplied. +See the License for the specific language governing permissions and +limitations under the License. Author Information ------------------ -An optional section for the role authors to include contact information, or a website (HTML is not allowed). +Ironic Developers diff --git a/roles/bifrost-setup-nodes/README.md b/roles/bifrost-setup-nodes/README.md index 225dd44b9..f47f087dc 100644 --- a/roles/bifrost-setup-nodes/README.md +++ b/roles/bifrost-setup-nodes/README.md @@ -1,38 +1,46 @@ Role Name ========= -A brief description of the role goes here. +Provisions nodes based on the contents of the file designated by baremetal_csv_file utilizing the os_ironic_node installed by Bifrost. Requirements ------------ -Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required. +TODO Role Variables -------------- -A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well. +TODO Dependencies ------------ -A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles. +TODO Example Playbook ---------------- -Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too: - - - hosts: servers - roles: - - { role: username.rolename, x: 42 } +TODO License ------- -BSD +Copyright (c) 2015 Hewlett-Packard Development Company, L.P. + +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 orimplied. +See the License for the specific language governing permissions and +limitations under the License. Author Information ------------------ -An optional section for the role authors to include contact information, or a website (HTML is not allowed). +Ironic Developers diff --git a/roles/bifrost-test-vm/README.md b/roles/bifrost-test-vm/README.md index 225dd44b9..f9749686a 100644 --- a/roles/bifrost-test-vm/README.md +++ b/roles/bifrost-test-vm/README.md @@ -1,38 +1,46 @@ -Role Name -========= +bifrost-test-vm +=============== -A brief description of the role goes here. +Gathers facts from nodes in the testvm group which is added by the bifrost-prepare-for-test role. Requirements ------------ -Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required. +TODO Role Variables -------------- -A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well. +TODO Dependencies ------------ -A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles. +TODO Example Playbook ---------------- -Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too: - - - hosts: servers - roles: - - { role: username.rolename, x: 42 } +TODO License ------- -BSD +Copyright (c) 2015 Hewlett-Packard Development Company, L.P. + +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 orimplied. +See the License for the specific language governing permissions and +limitations under the License. Author Information ------------------ -An optional section for the role authors to include contact information, or a website (HTML is not allowed). +Ironic Developers diff --git a/roles/ironic-deploy/README.md b/roles/ironic-deploy/README.md index 225dd44b9..4891b4918 100644 --- a/roles/ironic-deploy/README.md +++ b/roles/ironic-deploy/README.md @@ -1,38 +1,46 @@ -Role Name -========= +ironic-deploy +============= -A brief description of the role goes here. +Preforms basic sanity checks as part of Bifrost before nodes are provisioned. Requirements ------------ -Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required. +TODO Role Variables -------------- -A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well. +TODO Dependencies ------------ -A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles. +TODO Example Playbook ---------------- -Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too: - - - hosts: servers - roles: - - { role: username.rolename, x: 42 } +TODO License ------- -BSD +Copyright (c) 2015 Hewlett-Packard Development Company, L.P. + +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 orimplied. +See the License for the specific language governing permissions and +limitations under the License. Author Information ------------------ -An optional section for the role authors to include contact information, or a website (HTML is not allowed). +Ironic Developers diff --git a/roles/ironic-enroll/README.md b/roles/ironic-enroll/README.md index 225dd44b9..57cbde78f 100644 --- a/roles/ironic-enroll/README.md +++ b/roles/ironic-enroll/README.md @@ -1,38 +1,46 @@ -Role Name -========= +ironic-enroll +============= -A brief description of the role goes here. +Enrolls nodes into Ironic utilizing the os_ironic Ansible module that is installed by Bifrost. Requirements ------------ -Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required. +TODO Role Variables -------------- -A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well. +TODO Dependencies ------------ -A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles. +TODO Example Playbook ---------------- -Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too: - - - hosts: servers - roles: - - { role: username.rolename, x: 42 } +TODO License ------- -BSD +Copyright (c) 2015 Hewlett-Packard Development Company, L.P. + +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 orimplied. +See the License for the specific language governing permissions and +limitations under the License. Author Information ------------------ -An optional section for the role authors to include contact information, or a website (HTML is not allowed). +Ironic Developers