77 Commits

Author SHA1 Message Date
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
Steven Dake
50c52081de Explain how to use kolla-ansible pull
During multi-node, it is possible for master target node images to
be older then the Ansible master playboks if the repository is
updated.  Add documentation to explain this situation.

Change-Id: I2ccf57004147873e89f23fbb996d01f550e90c3f
2016-03-18 11:57:27 -07:00
Steven Dake
812b27867e RST syntax error in quickstart.rst
Change-Id: I3c5b6f73b19968c9ae26b12e64864c72a5e2b7f2
2016-03-12 22:14:51 +00:00
Swapnil Kulkarni (coolsvap)
333ee4e742 Restructuring the Quickstart guide
We need the gcc and other dependencies
installed before we can do any tox related
commands.

Installation of git was never checked in QSG.
I happened to create a baremetal CentOS server
with minimal install and there was no git.
Added steps to install git.

Moved the steps related to git clone and other
kolla configuration after basic installation.
since tox fails for gcc.

In the quickstart guide we are generating
the configuration using tox but tox is not
installed before doing so. Adding steps to
install tox before generating conf.

Change-Id: Ic8a756e66d33963e47607ed60c4c768e0859152d
2016-03-11 22:20:58 +05:30
Martin André
3105580d39 Provide instruction to generate kolla-build.conf
Although not strictly mandatory, it's less confusing to have
a kolla-build.conf file in /etc/kolla that users can modify it they
want to customize their builds, rather than to rely on defaults
settings and command line options.

The `tox -e genconfig` was already documented in "Image building" doc.

Change-Id: Ia44e6f28ce18601cdaba5109ea12cd50fa8372b2
Closes-Bug: #1532066
2016-03-10 15:25:56 +09:00
Nikolai Korablin
b58fd41ad6 Fixing ambiguity in the documetation
After change change 284856, there were some comments
about ambiguity in docs.

Change-Id: I90129c475b87bf63f2e5c870dba7bd07893c8c9c
2016-03-02 21:37:35 -08:00
Jenkins
ac12632ead Merge "Recommend vagrant and heat for development only" 2016-02-28 19:10:30 +00:00
Jenkins
c81097df8b Merge "Change kolla_internal_address variable" 2016-02-27 17:50:52 +00:00
Rajath Agasthya
58ef5fee02 Recommend vagrant and heat for development only
Vagrant and Heat, while really cool tech, are not very well maintained
in Kolla. They are not always up to date, and as a result, are not
recommended for evaluation purposes by this change.

TrivialFix

Change-Id: Ic8b8519431ed5c50a9a46b2e8b8f822d0982b1cf
2016-02-26 23:36:21 -08:00
SamYaple
d3cfb2052a Change kolla_internal_address variable
Due to poor planning on our variable names we have a situation where
we have "internal_address" which must be a VIP, but "external_address"
which should be a DNS name. Now with two vips "external_vip_address"
is a new variable.

This corrects that issue by deprecating kolla_internal_address and
replacing it with 4 nicely named variables.

kolla_internal_vip_address
kolla_internal_fqdn
kolla_external_vip_address
kolla_external_fqdn

The default behaviour will remain the same, and the way the variable
inheritance is setup the kolla_internal_address variable can still be
set in globals.yml and propogate out to these 4 new variables like it
normally would, but all reference to kolla_internal_address has been
completely removed.

Change-Id: I4556dcdbf4d91a8d2751981ef9c64bad44a719e5
Partially-Implements: blueprint ssl-kolla
2016-02-26 20:00:09 +00:00
Michael A. Trimm
f9b603872b Fixed slight gramatical issues that could be considered confusing
Signed-off-by: Michael Trimm <mitrimm@cisco.com>
Change-Id: Iccd3c53526caf8b109ba4ede117eebf66958782d
2016-02-26 12:56:53 -05:00
Jenkins
604e1d5e8a Merge "General improvements to quickstart" 2016-02-25 21:52:53 +00:00
Jenkins
3616381db2 Merge "Fixed a typo in quickstart.rst" 2016-02-25 15:21:22 +00:00
Abe Music
73f7fcb958 General improvements to quickstart
- Provided info on installing ansible via yum from EPEL and pointed
  readers to the EPEL docs to learn how to install/enable the repo

Change-Id: I4bf87fbf90779be85293eb65fe7cd2ffe548d6ae
2016-02-25 08:10:27 -06:00
Asha Saravanamohan
cf1c3180e5 Fixed a typo in quickstart.rst
In Deploying Kolla section of the quickstart.rst IP addr needed to
be changed IP address.

Change-Id: I4f3895d6f05340a0608b2b66170a769bd1454fb7
Signed-off-by: Asha Saravanamohan <assarava@cisco.com>
2016-02-25 08:56:03 -05:00
Matthew Montgomery
f572cbf0af Quick spelling/grammar fix
Change-Id: I882fb31bc21be4b4f22e61938c1d8f6775d69323
2016-02-24 21:55:07 -06:00
Jenkins
32695378cb Merge "Remove information about downgrading docker" 2016-02-25 00:59:22 +00:00
Jason Myers
1893abc306 Remove information about downgrading docker
Since docker 1.10.1 is required, and docker 1.8.2 does not work with Kolla,
Remove the downgrade instructions

TrivialFix

Change-Id: I461572a40b6fc96f73593cf989967449e4bc8e0a
Signed-off-by: Jason Myers <jason@jasonamyers.com>
2016-02-24 17:52:06 -06:00
Steven Dake
0fd36a63c1 Add docs about failures during evaluation
The operators aren't mindreaders.  Lets throw them a bone about
how to properly evaluate Kolla.  This can probably be expanded
on.

TrivialFix

Change-Id: I70d0f6a63417dc9f361d8c14bbb512e1dcc44ed0
2016-02-24 13:36:57 -07:00
Jenkins
9a0104bcdb Merge "Updated doc/quickstart.rst - Part 1" 2016-02-24 16:36:25 +00:00
Éric Lemoine
edc0e57c89 Update Debugging Kolla section of documentation
Partially implements: blueprint heka

Change-Id: If0db8a5c9b8426687f64002a65e1dd9cbe041d1c
2016-02-24 12:17:25 +01:00
Vikram Hosakote
a906c6242d Updated doc/quickstart.rst - Part 1
Part 1

Change-Id: Idf3d45a5a5d9da731e986765ee0376288a60254f
Closes-Bug:1545926
2016-02-23 20:09:10 +00:00