Commit Graph

106 Commits

Author SHA1 Message Date
Sharpz7 4529d48afe [codespell] Fixing Spelling Mistakes
This is the first in a series of commits to add support for codespell. This is continuning the process completed in ironic-python-agent.

Future Commits will add a Tox Target, CI support and potentially a git-blame-ignore-revs file if their are lots of spelling mistakes that could clutter git blame.

Change-Id: I41b2db35cdf21917ac20ed0866af3b9c94789f0b
2024-01-25 21:31:33 +00:00
Riccardo Pittau 1b77766a51 Use Launchpad for bug reports
Change-Id: Ia13b031b86585e6290d3703896638e899d5efe27
2023-07-19 15:15:20 +02:00
Dmitry Tantsur 5a76f5429b More compact README.rst
This file is included from the main documentation, so make it
smaller. Remove a separate MISSION.rst, nobody is going to read it.

Update the links to look more uniform.

Change-Id: I9b88faaad5ad0ccc85a7660d8cd7e8d20f3ed120
2021-02-17 12:45:38 +01:00
Monty Taylor ec852a3fad Update links for opendev
The most important bits are updating shade references to remove
the openstack-infra. The other git urls will work through the
redirect, but cleaning them up is just nicer.

This removes two comments that reference files that no longer
exist due to config generation.

Also, fix some random use of github for cloning openstack repos,
since the github mirror is best-effort only.

Change-Id: I55a1d9db940cf5fa2c35421db7add015ae334563
Needed-By: https://review.opendev.org/654056
2019-04-22 17:16:46 +02:00
Nguyen Van Trung 106eade694 Add repository & storyboard link to README
Change-Id: I10359bd752cd89cb8ff66dbec4b321449a8c7eb6
2018-07-02 16:38:42 +07:00
sunqingliang6 96ba38824a add link to release notes
This updates the README to include a link to the release
notes.

Change-Id: I22061b5334a7a82a3a8888b6230acc55019fa0fd
2018-06-18 14:17:07 +00:00
shangxiaobj 2c6d130f0b Update and replace http with https for doc links
1) Update doc links according to OpenStack document migration
2) Use https instead of http for docs links

Change-Id: I66ec684f89a842f73f5854ad70c35c8a3d8334dc
2017-09-19 15:08:48 +00:00
Dmitry Tantsur 864c498528 Fix rendering in README
It is included into doc/source/index, so its heading levels have to be
compatible with ones there. The same goes for MISSION.

Also fixes incorrect link syntax.

Change-Id: I71f575b72abad0c5992be841ac3ee5ea1094537d
2017-08-11 11:34:49 +02:00
Julia Kreger bc0a12dfff Begin breaking out installation documentation
Broke out install related content, and linked the
mission statement in to the main index page.

Change-Id: I439e07429f9862f57520c7f92f5b0814536c0ffc
2017-08-10 19:02:02 +00:00
Julia Kreger 67977f9885 Enable warning-is-error for doc builds
Some of the documentation linking is broken, and will need
to be fixed as the documentation is revamped for the doc
migration.

Change-Id: I23a5f8a7c0cc7b0ce19052a2383e20b96e195996
2017-07-11 19:37:30 +00:00
Pavlo Shchelokovskyy 9cbecb6fcf Fix README.rst
mostly fixed headers levels so that rst is renderable.

Change-Id: Ice37f0fecbc7bd122b8485769e1513c64b8cdbce
2017-03-06 10:50:54 +00:00
Julia Kreger 7fad2491e7 Documentation cleanup
Reordering documenation for a cleaner presentation
of details, and centralization of howto information.

Change-Id: I758161b46cb19b8871e59cd2b3fcddbfc009b785
2017-03-02 18:55:41 +00:00
Pavlo Shchelokovskyy 7a7f858ae2 Always install Ansible with pip
Instaling and using Ansible from source for bifrost has several
drawbacks, mainly due to how Ansible's 'ansible/hacking/env-setup'
script mangles with PATH and PYTHONPATH, which complicates running it as
part of other scripts. Besides, cloning the whole repo and it's
submodules is somewhat longer.

The main reason why we were doing that at all was a necessity to install
some additional Ansible modules from newer Ansible versions, which we
dropped right into the source of Ansible code - but this does not have to
be so.

Luckily for us, all Ansible versions we target to support can load
modules from 'library' directory next to playbooks/roles,
and we already use that for 'os_ironic_facts' module.
The need to install a particular module can be assessed by running
ad-hoc 'ansible' command against localhost with the module in question
and without any arguments ('ansible localhost -m <module>'):
- if the module is available in Ansible, the stderr will contain
  "changed" substring (as part of the standard module output)
- if the module is absent form Ansible, "changed" string will be absent
  from stderr too, in which case we can download the module from github
  directly into 'playbooks/library' directory.

This patch removes possibility of installing Ansible from source, and
always installs a released Ansible version via pip.
If not installed into venv, Ansible will be installed in user's ~/.local
directory via 'pip install --user'.
The missing but needed modules are downloaded as described above.

Some level of backward compatibility is provided:
- when the ANSIBLE_GIT_BRANCH has form of 'stable-X.Y', the
  env-setup.sh script will do the next best thing and install latest
  available Ansible version of X.Y.w.z

Also, ANSIBLE_PIP_VERSION can now accept a full pip version specifier:
- if ANSIBLE_PIP_VERSION starts with a digit, this exact version will be
  installed (as 'ansible==X.Y.W.Z')
- otherwize this whole variable is assigned as Ansible version specifier
  for pip, e.g

    env ANSIBLE_PIP_VERSION="<2.2" env-setup.sh

  will result in pip being called as

    pip install -U "ansible<2.2"

Closes-Bug: #1663562
Change-Id: I2c9f47abbbb6740d03978f684ad2c876749655b7
2017-02-13 13:10:54 +02:00
Andrey Shestakov 1236d9343e Allow deploy-dynamic on remote host
This change allows deploy nodes on remote server with installed Ironic.

Change-Id: If0625ee5a4a2271452305bb3e079ad075b9c71b1
2017-02-07 19:07:56 +00:00
Pavlo Shchelokovskyy 299a7259aa Do not install pxe_amt driver by default
AMT drivers have been removed from ironic tree. As a result,
ironic-conductor installed by bifrost with default settings
(enable_pxe_drivers=true) does not start as 'pxe_amt' driver can not be
found.

AMT drivers are now exclusively part of ironic-staging-drivers,
and setting them up (including dependencies installation) must be
handled by tasks installing those.

Change-Id: Ie85f8b7453bd99e824f63e41003db8089026d8c1
2017-01-31 21:44:32 +02:00
Andrey Shestakov c6e2851819 Fixes to allow install Ironic on remote node
This change introduces fixes, which allows install Ironic on remote
server. This may not complete list of changes required for all
operations.
Also added group 'target' to inventory file, which is same as localhost
by default, and host in this group can be replaced by remote host.

Change-Id: I59c942d2556c5e1b7eee661fb8cf13c4ae02b2d1
2017-01-23 13:28:12 +00:00
Jenkins 073646760d Merge "Adding staging driver support" 2016-12-14 08:43:24 +00:00
Chris Krelle 382f21c015 Adding staging driver support
Adding Staging drivers install.

Change-Id: I80e0303a7f5cfe7ae955763090d93d32ccb8c66e
2016-12-12 20:43:51 -08:00
Jenkins 394934ec1f Merge "Minor documentation updates" 2016-12-09 23:37:21 +00:00
Markos Chandras 9241ceb07b README.rst: Add openSUSE Leap to list of supported distributions
SUSE support has been added a while ago and openSUSE Leap is being
tested in the OPNFV CI so add it to the list of supported
distributions.

Change-Id: Ie004ea88d02a35c57786b2249c2fbd94ac99ea7d
2016-12-07 09:39:48 +00:00
Julia Kreger cf77dd9f70 Minor documentation updates
* Adding keystone support reference to documentation.
* Adding Xenial to the list of supported Ubuntu distributions.

Change-Id: Id093d2e474c6e9501599431342d208886d04444c
2016-12-06 16:30:50 +00:00
Clint Byrum 33d79b09a9 Config drive spec uses network_data.json
The filename was incorrectly implemented as network_info.json instead
of network_data.json. Support for reading the correct file already
exists in glean. As such, we need to write both files for user
compatability in the short term, and remove the second file at a
later point in time.

A release note has been added detailing this as well.

Co-Authored-By: Julia Kreger <juliaashleykreger@gmail.com>
Change-Id: I4150f86fbc141dcd6fd12094acab1ca43d76910c
2016-12-02 15:59:17 +00:00
Flavio Percoco d1e73c79aa Show team and repo badges on README
This patch adds the team's and repository's badges to the README file.
The motivation behind this is to communicate the project status and
features at first glance.

For more information about this effort, please read this email thread:

http://lists.openstack.org/pipermail/openstack-dev/2016-October/105562.html

To see an example of how this would look like check:

b'https://gist.github.com/1adf06e485f9955c5b653d1ba78b907f\n'

Change-Id: Ib455d351630cb83a2049e00135109efbbfa09093
2016-11-25 13:36:36 +01:00
John L. Villalovos 1433fc8537 Explain how to pronounce Bifrost
Give the pronunciation for Bifrost

Change-Id: I2d1dbfdbcbe9feb603a05591359895fd18e31858
2016-09-16 07:22:52 -07:00
Bruno Cornec e0fb22dec9 Fix minor documentation issue
- When referering to the ANSIBLE_INSTALL_ROOT, the stack subdir is not
  to be used
- Improve setup verification by giving an example of ironic command to pass

Change-Id: Ib0471e5170d64684e9a6137da5e9b0ccad35a668
2016-09-01 12:25:42 +02:00
Ricardo Carrillo Cruz 8c947c52ef Set OS_AUTH_TOKEN to dummy string, instead of empty space
Setting the OS_AUTH_TOKEN to empty space as stated on the docs
and env-vars no longer works, it errors out a message from requests
library.
Changing to dummy 'fake-token' fixes this.

Change-Id: Ia02aa3c56e7231a33a02474d01e9a7a2e6bfc223
Closes-Bug: #1612577
2016-08-15 12:21:53 +00:00
stephane 2e0ff6322a Unify test playbooks
We currently use fairly similar playbooks for the regular test vs
the dhcp test. Consolidate these into one playbook to make things
easier to maintain in the future. Add a deprecation warning
indicating that the existing test playbooks will be removed in
the Ocata cycle.

Change-Id: Ib78821d4ebfe4125405e301b5f19b31b1e3cdbc8
2016-06-28 11:06:25 -07:00
Jenkins 15e418d21d Merge "Add redeploy-dynamic playbook" 2016-06-13 12:35:19 +00:00
Chuck Carmack b8a97b8ad3 Add redeploy-dynamic playbook
The playbook unprovisions the nodes, giving each node a configurable amount
of time to change to provision state 'available'. Then it deploys
the nodes, giving each node  a configurable amount of time to change to
provision state 'active'

Change-Id: I1e477c2dee3d0c40f467cd9e1906fd3dfa7cc1bd
2016-06-08 12:59:28 +00:00
Ganesh Maharaj Mahalingam e7fc06aadc Make ansible installation directory configurable
This change helps with the remote problem where ansible is installed
on a machine using the same script by User A and User B is also
trying to use ansible using the same method. The change lets each
user have his own copy of ansible installed in a directory of
his/her choosing.

Change-Id: I8fddaaa8cad291da840ac44c4b1e9a7a93f92aee
Signed-off-by: Ganesh Maharaj Mahalingam <ganesh.mahalingam@intel.com>
Partial-Bug: #1589672
2016-06-06 13:24:46 -07:00
Dan Bode e1d20a6695 Document that ssh_public_key_path must be set
The public key parameter should be set and
point to the public key that you wish to
inject into systems built with ironic.

Otherwise, the ansible deploy call fails.

Change-Id: I986bb9cabf44ad8940a8e57a37435e3880bc5c01
2016-05-26 13:09:23 +00:00
stephane b360a0c3f2 Initial support for virtualenv installation
In order to avoid dependency issues, etc., we would like
the ability to use bifrost with a python venv. Provide
experimental support in the install role for venv but
leave it off by default.

Implements: blueprint bifrost-venv-use
Change-Id: I3d6e01825358fcd766ae890bde10fa14fb0b28be
2016-02-11 14:38:48 -08:00
Ricardo Carrillo Cruz f2293c5106 Allow configuring provisioning IP address when using inventory_dhcp
This change adds flag 'inventory_dhcp_static_ip' to the
deploy-nodes-dynamic role.

If set to true, it will read the new 'provisioning_ipv4_address'
key from the inventory machine section and use that as assigned
IP for the machine mac.
If set to false, dnsmasq will assign IPs from the configured DHCP
range.

An inventory machine example specifying provisioning_ipv4_address:

"compute00.hpuseast.ic.openstack.org": {
  "ansible_ssh_host": "15.126.48.52",
  "ipv4_address": "15.126.48.52",
  "provisioning_ipv4_address": "10.23.212.5",
  "uuid": "30303536-3734-5355-4532-333745314C41",
  "driver_info": {
    "power": {
      "ipmi_address": "1.1.1.1",
      "ipmi_username": "xxx"
      "ipmi_password": "moarxxx"
    }
  }

Change-Id: I9083cd34096aad04136564c2ded024527c88c711
2016-01-12 15:07:14 +01:00
Julia Kreger 47fd014d25 Add information regarding drivers
Added drivers support details, as well as the stance on the
OneView driver since it requires explicit global configuration.

Change-Id: Idd4a0b6e3717a584f9c4b44f2f5939d67d413eaf
2015-12-18 05:00:41 -05:00
Jenkins c0a2fdffc8 Merge "Adjusted line length to 79 characters" 2015-12-04 06:03:52 +00:00
Summer Barringer b8f2448256 Adjusted line length to 79 characters
Change-Id: Ie2aa27cf8d343c2d814d3f4c6c8bde4198778cd0
2015-12-03 08:42:02 -05:00
Jenkins 17d65108ea Merge "Change DIB role to default to Debian jessie" 2015-12-03 01:23:49 +00:00
Haomeng, Wang 2917820b3d follow 249528 to fix typo
A typo involved by 249528 patch, will fix it with this patch.

Change-Id: I4dc675339dca35feeba49fb17ab1c60d4a4a25c0
2015-12-03 00:17:09 +00:00
Julia Kreger de7a20c8c5 Change DIB role to default to Debian jessie
In the event that Debian is selected or defaulted to for an image
build operation, then that image should be jessie based.

Added logic to check and set if so, and permit user override.

Change-Id: I2c54cd4ec11fe85c246c25c3bcc219a22ef26b12
2015-12-01 08:00:12 -05:00
Haomeng, Wang 7a7bc32a0c Add git clone step into README for beginners
In this patch will add basic steps, such as git clone the code
into README.rst for beginners to have a step by step guide.

Change-Id: I1d701a509fd0fc1fa5533ca61f31038bca56aaa1
Partial-Bug: #1519582
2015-12-01 02:35:00 +00:00
stephane 9e727a7cec Nit fixes for I8f0a24d929db78a45fdda2e30091aeb945c2802b
Fix a couple of minor issues with our excellent new
documentation.

Change-Id: Ie15dde41a38adb4ffebef1e0753dccc9b08af04c
2015-10-29 00:42:30 -07:00
Julia Kreger 355513d76e Updating docs to provide additional context
Upon reflection, we have determined that we need to provide
a greater amount of context to those contributing in order to
drive a higher quality end result.

Change-Id: I8f0a24d929db78a45fdda2e30091aeb945c2802b
2015-10-28 20:41:20 -04:00
stephane 5cff30dc26 README cleanups
Miscellaneous cleanups, including:
- Fixed typos
- Consistent markup of literals
- Fixed markup of internal & external hyperlinks
- Reflowed text where appropriate to be more
  considerate to readers viewing the plaintext version
- Consistent capitalization for ironic
- Update supported versions to reflect recent work

Change-Id: I4ef35599d552a19d98c4a51893f443a54307c160
2015-09-11 10:11:48 -07:00
Vladyslav Drok 9f1b1f05b6 Fix RST warnings in README.rst
Change-Id: Ia49e3966073e08d802f468087b17dfc7ad2cf981
2015-08-28 13:42:02 +03:00
Jenkins f306c4b69d Merge "Test script to drive image testing" 2015-08-19 18:22:53 +00:00
Mitsuhiro SHIGEMATSU 24fe513735 Fix typos in bifrost docs
Change-Id: Ifeb206438d95bb531f53830a017cd86da1412153
2015-08-19 08:57:11 +09:00
Julia Kreger e929254f93 Test script to drive image testing
Support to enable building an IPA image for testing
and script to leverage testing image building.

Change-Id: I31263909d2cb275491e57d7ed8c3f08a86462699
2015-08-14 17:54:56 -04:00
Julia Kreger 3aa2cebe35 Remove the group_vars/all file for easy customization
Removal and split of the group_vars all file resulted in a general
clean-up and optomization of dependency information with-in the
roles as defaults are required and a number of them were being
supplied from group_vars/all.

Additionally split out the group_vars/all file into
group_vars/baremetal and group_vars/localhost files with
improved comments to help direct a user wanting to perform
deeper customization.

Due to variable loading processes, additionally unwire the bifrost-
create-bootable-image role, as it is no longer developed upon and
the default vars are conflicting with the variables used across
role.

Additionally updated READMEs where appropriate.

Co-Authored-By: stephane <stephane@alum.mit.edu>
Change-Id: Ia6226a8573753ff02da19dcb3c2b5abfb9b3c297
2015-08-13 22:17:34 +00:00
Julia Kreger 0d1f4580c0 Add JSON and YAML examples
Addition of example JSON and YAML based inventory files to
allow for easy adaptation by users.

Change-Id: I227c031f75c4f5bb3b2030c23164c2d76caf4077
2015-08-03 18:40:24 -04:00
Julia Kreger 7f3ece10f8 Removal of legacy roles and related updates
Removed legacy roles that utilize the baremetal.csv and looping
to achieve the desired results which was extremely limiting and the
predicessor to the dynamic inventory module and roles which
allow greater flexibility.

Additionally updated the deploy and enroll yaml files to redirect
users to the newer process and updated the README to remove
references to the older process.

Change-Id: Ia394652686608c012a848c0329195fba9abd45d1
2015-07-20 14:51:25 -04:00