Commit Graph

12 Commits

Author SHA1 Message Date
Julia Kreger aad9617163 Centralize user documentation
Change-Id: Icf1643f3d6c87a596e6a6b5cdb73dced42ea0797
2017-08-11 09:09:22 +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
Nam Nguyen Hoai 900bd2a5b4 TrivialFix: Fix typo in the RST file
Change-Id: I597cbec746fa47e6ec6b8a10807b6f28b231d04f
2016-09-30 10:41:43 +07:00
Julia Kreger 8e9936942e Update IPA info in troubleshooting.rst
The details on IPA image options were not previously detailed in
the troubleshooting documentation, and given that we have switched
from CoreOS to TinyIPA for testing, it is relevent to suppliment the
troubleshooting information. Updated formatting and placement in
an attempt to provide better clarity to the reader or user attempting
to remedy an issue.

Change-Id: Ic2f4acd8c4824ddc4c13dabec7d6b8cfb413b35b
2016-08-30 09:41:57 -07:00
Julia Kreger 5f6b94db45 Update troubleshooting text for custom IPA images
Additional text to help users understand how to gain access to a
running IPA image for troubleshooting purposes.

Change-Id: I337f02f7fa496312893bff8bb2bfb67dadb67cd9
2015-10-23 16:44:37 -04:00
stephane dc6bcb0ea4 Clean up troubleshooting.rst markup
Do some cleanups on our troubleshooting doc, including:
- Add the doc to the tree of stuff that gets rendered
- Correctly mark up literals
- Consistent capitalization for Ironic/Bifrost
- Make list autonumerate for ease of maintenance

Change-Id: I29dc39bf5b88588d19626af566d2e7d29fdacf48
2015-09-11 14:22:20 -07:00
Julia Kreger 09cda5ec9c Improve logging for VMs to identify IPA issues
Since the coreos config drive issue has been solved elsewhere
we shall re-use the line to improve our logging so we can have
useful configdrive logs.

Change-Id: I0e044121e146f3036aa6b1830983dd9d7a68e9ac
Depends-On: I76a2a23e2a75022bae3511700c81145b5cbeae77
2015-09-08 17:06:58 -04:00
Julia Kreger 13222de6f3 Wrapping length of lines in troubleshoting.rst
Wrapping line length and minor text edits to improve clarity.

Change-Id: Ia2652d2fc0b8a525dd2f0110c010ccc640753551
2015-07-22 22:09:47 -04:00
Julia Kreger fa0a0bded2 Add README and Troubleshooting updates for SSH keys
Updated the README and Troubleshooting files in order to better
guide users to ensure that ssh keys are present, and how to identify
the and recover from the error when this occurs.

Change-Id: Ib025166359a45a8010bdc050361771cab124262e
Closes-Bug: 1470137
2015-07-02 17:24:07 -04:00
Mitsuhiro SHIGEMATSU aa4e919353 Fix documentation in bifrost
Fix typos or something in RST files

Change-Id: I395358194c93f0491b6c1311f8be9f42c99806ed
2015-05-25 13:53:01 +00:00
Julia Kreger 1c486131cd Add playbook to remove deployment images from the system
In the event of redeployments on installations that have been
in-place for some time, it may be necessary to clean the
master_images folder along with the deployment kernel and
ramdisk to ensure that fresh images are downloaded during
the next installation.

Updated troubleshooting documentation to mention availability of
the playbook and the potential case when it may be needed.
2015-04-16 16:21:00 -04:00
Julia Kreger 13cbd10482 Add initial documentation for troubleshooting
Adding troubleshooting information for network connectivity, node
locking, and the ironic-python-agent.
2015-03-19 13:48:59 -04:00