1.remove the # - it makes copy and paste very difficult
2.change "ubuntu" to "Ubuntu"
3.add "Restart docker by executing the following commands: "
TrivialFix
Change-Id: I0192d9fd7f597b0e2dc8d26d4fe5ba8b32483ce0
There were some problems in the documentaiton that
prevented tox -e docs from working. Also changed
attention to WARNING since attention was not as eye-grabbing
as I'd hoped during a previous review.
Change-Id: I2b661afa2cd4a4331bbcc99240d3e127a5d94a11
Updated quickstart.rst file to support both evaluation/deployment and development.
Updated both dependency and install sections.
Change-Id: Icd2a699e26553e3c41ee58ff6081716efe77dc25
This will test all rst files inside the doc directory for style issues with
doc8 (an opinionated style checker for rst styles of documentation).
This will fix all syntax issues identified by doc8 and will improve
the syntax.
Change-Id: Id1b9563e07e77e306aef5a0767c98c27f87c5c0e
According to the openstack contributer guide, the underlines
in an rst file should be of the same length as that of the
heading text to follow rst formatting conventions.
http://docs.openstack.org/contributor-guide/rst-conv/titles.html
Change-Id: I186abdfd87bc1e26fb822412b7335b1c42c25b25
Signed-off-by: Asha Saravanamohan <assarava@cisco.com>
python-pip package from canocnical for trusty is old.
It causes resolving dependencies problem when "pip install".
This fixes it.
Change-Id: I9134d9d46eba3e9c37167552bf90758690b62ecf
Closes-Bug: #1595792
By adding `kolla-ansible pull` before the deployment, it may help to
guarantee a successful deployment, and avoid polluting the host
environment due to the failure of the deployment.
Change-Id: I951a3093ca02601ed6c0469e626fcd92bd1297c1
When a new comer looks at the docs launch page the quick start should be
more prominent in the table.
Change-Id: Ie4591e6201e17926d74a8d9a2f50da1cc959e2e7
Remove information about build time on specific hardware and reasons
for not pushing images per commit that are not relevant for
a quickstart guide.
Link to detailed instruction about image building from the quickstart
guide and update the image building guide to use `kolla-build` command
by default instead of `tools/build.py`.
Change-Id: If821370acdaaa860c96597aa373687f5f10d3121
Partially-implements: blueprint documentation-rework
Restructured the documenation to
1. Add reference at the top
2. Updated the title formatting
3. Updated the heading formatting
4. Updated the links formatting
Change-Id: Ie3786e92fee674da1fa39cf07f1bf0a3badd5b92
CentOS shipped with an older version of docker-py named docker-python before.
But currently CentOS also shipped with a new rpm named python-docker-py-1.7.2
which obsoletes docker-python and also fulfill kolla need according to its
version(kolla needs docker-py >= 1.6.0).
Change-Id: I684a6a4e6b6baa9589e9b2afd3cfcc195d2a5e21
Signed-off-by: Zhijiang Hu <hu.zhijiang@zte.com.cn>
Our quickstart guide is way too complex. We need to simplify
the quickstart guide by pulling out the overwhelming amount of
information and splitting it into other docs.
Change-Id: Iec175ee7f60bfd11ce06b22c861e51e180c188a9
Partially-implements: blueprint documentation-rework
Includes basic information about how to search, visualize and analyse logs,
create a Dashboard and export/import created items.
Closes-Bug: #1570544
Change-Id: I70ce5d28a6bb719a94570d23e85d5ba4aa0b114e
The disable HAProxy option is not commonly used and not
recommended. This patch moves the section that describes it
out of the Quick Start Guide and into the Advanced Configuration
Guide.
Change-Id: Iccd8a6369d772bd85f304cba0a99300180a369c8
Closes-Bug: #1569560
Heat development environments don't work at all.
As such document this so folks avoid them unless they want to
work on making them better.
Change-Id: Ibe3296660d30ccc24213c272ef379e6d3e2c21f2
Kibana requires creating an index for the first time when you log
in since we don't have a default dashboard yet. Documenting that
step in quickstart.rst.
Change-Id: I82ecd228c61e2affa5c8f9f9c93f8845728f707f
Added information when using nested environment for Kolla deployment.
Added check command to verify hardware acceleration
Change-Id: I6cb43ebbf11b5cf34f866fdccb550e9641a47f6c
As with all tools, this is a first pass at the generation. Perhaps we
even want to move this into kolla/kolla/cmd and be generated with tox
itself in the future.
This tool, when run, will only populate empty fields that have no
values meaning that it is safe to run repeatedly on the same file.
Of note, there is no way to preserve comments in the file after it has
been processed by the yaml parser in python. Comments and sections
will remain in the passwords.yml template for additional documentation
if the user wishes to populate the file themselves.
Use SystemRandom and clean up the docs a bit to not use pronouns.
Co-Authored-By: Steven Dake <stdake@cisco.com>
Closes-Bug: #1559266
Change-Id: I2932d592df8871f1b7811059206d0b4d0553a687
While it's possible to edit distro/package unit files installed to
/lib/systemd/system, a cleaner solution exists. systemd will pick up
'drop-in' unit files located in '/etc/systemd/system/[unit name].d/'.
A drop-in unit file only has to include fields that override those in
the main unit file, and the drop-in unit and main unit file can change
independently.
This change updates the quickstart doc to use drop-in unit files to
configure docker.service instead of editing the main unit file.
See: https://coreos.com/os/docs/latest/using-systemd-drop-in-units.html
Change-Id: Iddbebf658741937e3c4157fc0a021751f10fabd2