aboutsummaryrefslogtreecommitdiff
path: root/doc/quickstart.rst
AgeCommit message (Collapse)AuthorFilesLines
2016-05-31Retitle quick start to make it more obvious in indexPaul Bourke1-3/+6
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-31Merge "Update Documentation"Jenkins1-90/+88
2016-05-28Do not use AUFS for centos/fedora/oraclelinux container images on ubuntu hostHui Kang1-0/+3
Change-Id: I9e9a96b71498a7d824d34e21028ad73f57302125 Closes-Bug: #1579583
2016-05-27Update DocumentationMauricio Lima1-90/+88
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-26Merge "Simplify image building information in quickstart"Jenkins1-12/+3
2016-05-25Update quickstart guide for formattingSwapnil Kulkarni (coolsvap)1-55/+51
Change-Id: I1d9f5c354e439754564bc654fce9d4dfcf515a10 partially-implements: blueprint documentation-rework
2016-05-25Simplify image building information in quickstartMartin André1-12/+3
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-16Structuring the documentationSwapnil Kulkarni (coolsvap)1-27/+22
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-16Merge "Doc rework for quickstart, multinode, and image-building"Jenkins1-133/+90
2016-05-16Update doc about how to install python-docker-py on centosZhijiang Hu1-2/+10
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-14Doc rework for quickstart, multinode, and image-buildingRyan Hallisey1-133/+90
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-06Merge "Add Kibana quick start guide"Jenkins1-2/+3
2016-04-28Yum install Ansible 1.9 specifiedBlake Smith1-2/+3
EPEL has added an Ansible 2.0 rpm. Version 1.9 needs to be specifically called out. Change-Id: I4bf296d72cc6eab50213a3a96923bf7e6b5f3399
2016-04-21Update remaining files for formattingSwapnil Kulkarni (coolsvap)1-1/+1
Change-Id: Ie9fc941bb48edf86b00fc1f2dba0b83b675a5a1c Partial-Bug:#1569417
2016-04-15Change Jinja2 rquirements to match globalsSteven Dake1-1/+1
Global requirements are 2.8.0 for Jinja2, and master will not run without it. Change-Id: I91f93736b1e067653840dff219fb8be9359da078
2016-04-15Add Kibana quick start guideakwasniewska1-2/+3
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-12Remove Disable HAProxy option from Quick Start GuideDave McCowan1-12/+0
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-11Add note about heat being busted for developmentSteven Dake1-4/+14
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-06Added Kibana instructions to quickstart.rstRajath Agasthya1-0/+20
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-05Add remove apparmor reminder to the quickstartRyan Hallisey1-0/+12
Change-Id: I1333bf4352aa559f3f9ee5c78ff85533e27c7716
2016-03-31Update Quickstart with example for distro and install typeDavanum Srinivas1-1/+11
Make it a bit more clear on how to switch distro if needed TrivialFix Change-Id: I888c8310d11c8bc65f579df2cdc9d32f3928dc23
2016-03-24Change CentOS in documentationGerard Braad1-7/+7
Change-Id: Ic4725a4cef02a57e837c727378a99bf7575d4ebd
2016-03-24Include docker python installGerard Braad — 吉拉德1-1/+12
Change-Id: I5a55f6798d73b289b02232dd26f5e5fb72da9e4c
2016-03-23Merge "Added note about nested environment"Jenkins1-0/+23
2016-03-22Added note about nested environmentCarlos Cesario1-0/+23
Added information when using nested environment for Kolla deployment. Added check command to verify hardware acceleration Change-Id: I6cb43ebbf11b5cf34f866fdccb550e9641a47f6c
2016-03-21Add generate_passwords.py to generate passwordsSamYaple1-0/+9
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-21Merge "Update quickstart doc to use drop-in unit files"Jenkins1-19/+14
2016-03-19Update quickstart doc to use drop-in unit filesMaru Newby1-19/+14
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-18Explain how to use kolla-ansible pullSteven Dake1-3/+9
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-12RST syntax error in quickstart.rstSteven Dake1-0/+1
Change-Id: I3c5b6f73b19968c9ae26b12e64864c72a5e2b7f2
2016-03-11Restructuring the Quickstart guideSwapnil Kulkarni (coolsvap)1-22/+33
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-10Provide instruction to generate kolla-build.confMartin André1-1/+3
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-02Fixing ambiguity in the documetationNikolai Korablin1-1/+2
After change change 284856, there were some comments about ambiguity in docs. Change-Id: I90129c475b87bf63f2e5c870dba7bd07893c8c9c
2016-02-28Merge "Recommend vagrant and heat for development only"Jenkins1-12/+11
2016-02-27Merge "Change kolla_internal_address variable"Jenkins1-8/+6
2016-02-26Recommend vagrant and heat for development onlyRajath Agasthya1-12/+11
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-26Change kolla_internal_address variableSamYaple1-8/+6
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-26Fixed slight gramatical issues that could be considered confusingMichael A. Trimm1-13/+13
Signed-off-by: Michael Trimm <mitrimm@cisco.com> Change-Id: Iccd3c53526caf8b109ba4ede117eebf66958782d
2016-02-25Merge "General improvements to quickstart"Jenkins1-2/+4
2016-02-25Merge "Fixed a typo in quickstart.rst"Jenkins1-1/+1
2016-02-25General improvements to quickstartAbe Music1-2/+4
- 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-25Fixed a typo in quickstart.rstAsha Saravanamohan1-1/+1
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-24Quick spelling/grammar fixMatthew Montgomery1-1/+1
Change-Id: I882fb31bc21be4b4f22e61938c1d8f6775d69323
2016-02-25Merge "Remove information about downgrading docker"Jenkins1-15/+4
2016-02-24Remove information about downgrading dockerJason Myers1-15/+4
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-24Add docs about failures during evaluationSteven Dake1-0/+40
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-24Merge "Updated doc/quickstart.rst - Part 1"Jenkins1-8/+21
2016-02-24Update Debugging Kolla section of documentationÉric Lemoine1-4/+4
Partially implements: blueprint heka Change-Id: If0db8a5c9b8426687f64002a65e1dd9cbe041d1c
2016-02-23Updated doc/quickstart.rst - Part 1Vikram Hosakote1-8/+21
Part 1 Change-Id: Idf3d45a5a5d9da731e986765ee0376288a60254f Closes-Bug:1545926
2016-02-22Minor update add prechecks into workflow pathWilliam Snow1-3/+12
TrivialFix Change-Id: I93f9ec574b4d46a53086ca11946bfa1003e26fa0
generated by cgit v1.2.3 (git 2.39.1) at 2026-11-06 02:25:11 +0000