98 Commits

Author SHA1 Message Date
Mauricio Lima
73dd4f6cd8 Fix Typo in quickstart
Change-Id: Id155d0877ca0b7fd4873fbef3fb71d3faf51ee53
2016-09-05 15:30:19 -04:00
Jenkins
a9f875cddb Merge "Fix some minor errors in the doc" 2016-08-23 10:12:13 +00:00
caowei
c3410a9cfe Fix some minor errors in the doc
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
2016-08-23 07:37:17 +00:00
Steven Dake
755d5172b3 Make tox -e docs work
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
2016-08-20 09:31:07 -07:00
Jenkins
6d89528171 Merge "Fix the location of Kolla configurations in the evaluation workflow" 2016-08-20 15:47:34 +00:00
Abishek Subramanian
0002898617 Fix the location of Kolla configurations in the evaluation workflow
The location for the Kolla configurations in the workflow for evaluation
needs to be fixed correctly to /usr/share/kolla/etc_examples

This was brought up on IRC -
http://eavesdrop.openstack.org/irclogs/%23openstack-kolla/%23openstack-kolla.2016-08-18.log.html#t2016-08-18T21:02:18

Change-Id: Ie9f651308a7b51cfd3ad1c617637bab1b5cc568e
2016-08-19 11:06:05 -04:00
Jenkins
7bf87dddec Merge "Remove heat dev environment" 2016-08-19 02:25:51 +00:00
Jenkins
dd02500edc Merge "Simplify install process for faster quickstart execution" 2016-08-18 15:50:14 +00:00
lzachery
8cd0d2a72a Simplify install process for faster quickstart execution
Updated quickstart.rst file to support both evaluation/deployment and development.
Updated both dependency and install sections.

Change-Id: Icd2a699e26553e3c41ee58ff6081716efe77dc25
2016-08-18 10:05:58 -04:00
Duong Ha-Quang
bd3b79a26d Add guide to auto mount /run as shared
Add guide: auto mount /run as shared upon startup to quickstart guide

Change-Id: Icd6ad399a97e15ff357e75fa52e9646e78d09e21
2016-08-17 07:55:30 +00:00
Christian Berendt
608f6c7571 Remove heat dev environment
The heat dev environment is not functional, remove it to avoid confusions.

Change-Id: I05ac25294516270328ca1fe88f15defeea570306
Partial-bug: #1562334
2016-08-09 15:25:35 +02:00
Robin Naundorf
fc91ce7d2f Change Quickstart to follow code conventions
* Remove the -y for every occurance of package install
  * Replace `source` with `.`

according to
http://docs.openstack.org/contributor-guide/writing-style/code-conventions.html

Change-Id: I977c5dd58207be67a5bfc96d5ae1f9958b46089a
2016-08-09 12:50:26 +02:00
Christian Berendt
c3d8262ec5 Add doc8 test and improve rst syntax
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
2016-08-04 15:09:10 +02:00
Asha Saravanamohan
a109c7473f Underline should match the title length in docs
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>
2016-07-08 16:34:16 -07:00
Jenkins
b4ecfc5043 Merge "Add the verification of required images step before the deployment." 2016-06-27 15:27:32 +00:00
Takeaki Matsumoto
fd5c3c7919 Add upgrade pip command to QuickStart Doc
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
2016-06-24 15:05:31 +09:00
hanchao
89408983b0 Add the verification of required images step before the deployment.
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
2016-06-24 11:03:54 +08:00
Jenkins
8790492c6b Merge "Update kollaglue repo on docker to kolla" 2016-06-23 15:36:49 +00:00
hanchao
bb6a4befdf Format commands to the code block
Put commands to the code block in quickstart.rst.

Change-Id: Ia2f12fd5693032029912d7fda2f6bf13701723fa
2016-06-16 10:07:16 +00:00
Swapnil Kulkarni (coolsvap)
3f063626a2 Update kollaglue repo on docker to kolla
[1] http://lists.openstack.org/pipermail/openstack-dev/2016-June/097227.html

Change-Id: I73af59dcf1e755dbe0579486f1fb0ebe5ca0119c
Closes-Bug: #1592286
2016-06-14 12:34:34 +05:30
Patrick Powell
b6ae413cef The quickstart guide still says to use Anisble 1.9.4
Closes-bug: #1585995
Change-Id: I3163720dd4402848904fc9673e3240082e0c708f
Partially-includes: blueprint documentation-rework
2016-06-13 12:07:10 -04:00
Marc-Andre Gatien
e31d85e71c adding Note for ubuntu 16.04
Change-Id: Ie73bfb1f2cd0879cb41adf1fce180f91bca40f73
2016-06-01 14:51:10 +00:00
Paul Bourke
c45099def3 Retitle quick start to make it more obvious in index
When a new comer looks at the docs launch page the quick start should be
more prominent in the table.

Change-Id: Ie4591e6201e17926d74a8d9a2f50da1cc959e2e7
2016-05-31 12:33:27 +01:00
Jenkins
63e7f63af9 Merge "Update Documentation" 2016-05-31 11:08:52 +00:00
Hui Kang
5b871d15a3 Do not use AUFS for centos/fedora/oraclelinux container images on ubuntu host
Change-Id: I9e9a96b71498a7d824d34e21028ad73f57302125
Closes-Bug: #1579583
2016-05-28 08:57:48 -04:00
Mauricio Lima
be2724a655 Update Documentation
Applying RST formatting conventions [1],[2] and [3]
[1] http://docs.openstack.org/contributor-guide/rst-conv/gen-guidelines.html
[2] http://docs.openstack.org/contributor-guide/rst-conv/inline-markups.html
[3] http://docs.openstack.org/contributor-guide/rst-conv/lists.html
Change-Id: I38b77a45d30ca0542058675dd1e8aba790c68567
Partially-implements: blueprint documentation-rework
2016-05-27 08:10:43 -04:00
Jenkins
89b563282c Merge "Simplify image building information in quickstart" 2016-05-26 11:13:47 +00:00
Swapnil Kulkarni (coolsvap)
ca1a0551bc Update quickstart guide for formatting
Change-Id: I1d9f5c354e439754564bc654fce9d4dfcf515a10
partially-implements: blueprint documentation-rework
2016-05-25 11:58:31 +00:00
Martin André
ca942dfcf9 Simplify image building information in quickstart
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
2016-05-25 13:57:23 +02:00
Swapnil Kulkarni (coolsvap)
d87b4f63a2 Structuring the documentation
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
2016-05-16 23:55:35 +05:30
Jenkins
460ebbe021 Merge "Doc rework for quickstart, multinode, and image-building" 2016-05-16 09:59:27 +00:00
Zhijiang Hu
ad573a58dd Update doc about how to install python-docker-py on centos
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>
2016-05-16 11:20:45 +08:00
Ryan Hallisey
1c29522553 Doc rework for quickstart, multinode, and image-building
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
2016-05-14 12:24:44 -04:00
Jenkins
0b563fa5b8 Merge "Add Kibana quick start guide" 2016-05-06 10:20:45 +00:00
Blake Smith
420f8740ea Yum install Ansible 1.9 specified
EPEL has added an Ansible 2.0 rpm.
Version 1.9 needs to be specifically called out.

Change-Id: I4bf296d72cc6eab50213a3a96923bf7e6b5f3399
2016-04-28 18:13:14 -05:00
Swapnil Kulkarni (coolsvap)
fc8d716316 Update remaining files for formatting
Change-Id: Ie9fc941bb48edf86b00fc1f2dba0b83b675a5a1c
Partial-Bug:#1569417
2016-04-21 12:03:42 +00:00
Steven Dake
0786e6b165 Change Jinja2 rquirements to match globals
Global requirements are 2.8.0 for Jinja2, and master will not run
without it.

Change-Id: I91f93736b1e067653840dff219fb8be9359da078
2016-04-15 19:55:47 -07:00
akwasniewska
732ef0e715 Add Kibana quick start guide
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
2016-04-15 15:16:37 +02:00
Dave McCowan
c2ccf572d6 Remove Disable HAProxy option from Quick Start Guide
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
2016-04-12 16:27:56 -04:00
Steven Dake
9119e2e360 Add note about heat being busted for development
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
2016-04-11 00:22:33 -07:00
Rajath Agasthya
0e6fcdb591 Added Kibana instructions to quickstart.rst
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
2016-04-06 22:12:32 -07:00
Ryan Hallisey
bf6cae2c24 Add remove apparmor reminder to the quickstart
Change-Id: I1333bf4352aa559f3f9ee5c78ff85533e27c7716
2016-04-05 02:06:54 -04:00
Davanum Srinivas
f0be9c736c Update Quickstart with example for distro and install type
Make it a bit more clear on how to switch distro if needed

TrivialFix

Change-Id: I888c8310d11c8bc65f579df2cdc9d32f3928dc23
2016-03-31 14:42:18 +00:00
Gerard Braad
674ff439fd Change CentOS in documentation
Change-Id: Ic4725a4cef02a57e837c727378a99bf7575d4ebd
2016-03-24 06:59:24 +00:00
Gerard Braad — 吉拉德
4d58ef5d43 Include docker python install
Change-Id: I5a55f6798d73b289b02232dd26f5e5fb72da9e4c
2016-03-24 04:07:10 +00:00
Jenkins
ada9ac95a0 Merge "Added note about nested environment" 2016-03-23 07:13:15 +00:00
Carlos Cesario
8e2423a388 Added note about nested environment
Added information when using nested environment for Kolla deployment.

Added check command to verify hardware acceleration

Change-Id: I6cb43ebbf11b5cf34f866fdccb550e9641a47f6c
2016-03-22 10:20:01 -03:00
SamYaple
f03e06e09b Add generate_passwords.py to generate passwords
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
2016-03-21 17:02:23 +00:00
Jenkins
37e67ef3ed Merge "Update quickstart doc to use drop-in unit files" 2016-03-21 00:24:37 +00:00
Maru Newby
b9205399c5 Update quickstart doc to use drop-in unit files
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
2016-03-19 05:10:35 +00:00