Commit Graph

43 Commits

Author SHA1 Message Date
chenxing 5493fb64e1 Rearrange existing documentation to fit the new standard layout
For more detail, see the doc migration spec.
http://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html

Partially-Implements: blueprint queens-doc-restructure

Co-Authored-By: Kurt Taylor <kurt.r.taylor@gmail.com>
Change-Id: Iab93bf023a13b953a31152b91d4fea0fa75bf2d0
2017-10-11 14:06:08 +08:00
chenxing 7384f7eae5 Update the documentation link for doc migration
Change-Id: I93ecb6c27c2780e9cd86c8df065302b216fe7850
2017-07-21 09:50:25 +00:00
chenlx 50f75729eb Use https links for documentation
Use https instead of http to ensure the safety.

Change-Id: Iaf09b5b878e117d2333c30b8a769304a4a20f7ee
2017-06-12 23:06:35 +08:00
Marcus G K Williams 278bcdb154 Add OpenDaylight Container to kolla
Implements docker container template for OpenDaylight.

Change-Id: Icdcff77f0f6088f5a4db1bf77e37334dbd42074f
Partially-Implements: blueprint opendaylight-support
2017-04-18 12:57:55 -07:00
Paul Bourke e8c76c85c3 Remove all kolla-ansible related docs
The goal of this patch is to reduce the docs hosted for this repo down
to just the container images.

Hyperlinks are provided to each of the available deployment mechanisms,
currently kolla-ansible and kolla-kubernetes.

This is to cut down confusion on which doc patches go where, as well as
the massive duplication we currently have between kolla and
kolla-ansible documentation. Further improvements could involve breaking
out the 'Building Container Images' section into separate pages, e.g.
quickstart, customisation, advanced, etc.

Change-Id: Ia7959c71a241b9d7139ec50b34e36b24fbcf76e6
2017-01-26 15:19:58 +00:00
Sayantani Goswami db75665e1d Improve Quick Start documentation
Made improvents to the quickstart guide

Moved the troubleshooting section from quickstart guide to a new
document troubleshooting.rst

Change-Id: I0f08d8743682390b2fe8071ab2484e251f2ef803
2017-01-12 21:48:44 +00:00
Mauricio Lima f11a50457c Add guide for Hitachi NAS Platform Driver for Manila
Co-Authored-By: Francisco Edigleison Barbosa <barbosaedigleison@gmail.com>
Change-Id: Ib4fab8a3a83ec71152a526383ad58fc3e52d326e
2016-10-17 09:30:15 -03:00
Jeffrey Zhang 55f0642c14 Add a note for how to get prior release kolla doc
Change-Id: Iff8185ebd39f633512a20a07889bd01b6ee4e037
2016-09-27 14:56:28 +00:00
Christian Berendt b5d1b3a5df Document bug triage
Change-Id: I909d92f8f67e5dbe0d697e05cc2f8f7424add25d
2016-09-22 15:26:44 +02:00
Michal (inc0) Jastrzebski 43307904dd Add architecture guide back to index.rst
It was removed in some of patches (probably bad rebase?)

TrivialFix
Change-Id: Ie9542012c1c6cb0252284196389eb6618862a148
2016-09-21 14:34:14 +00:00
prithiv ef9d6ea8be Add networking guide for Neutron extensions
With Kolla supporting Neutron extensions, it is
essential to have networking guide to describe the
installation and configuration of these extensions.

Partial-Bug: #1603391

Change-Id: I78ff5b17e4024d96f8083c96ac5b5b608a7c0015
2016-09-16 10:18:26 +01:00
Hui Kang 0d28b311eb Add Kuryr ansible role
Change-Id: I7134bffab940ee780e5f5010d639af56f97b41d6
Co-authored-by: Mohammad Banikazemi <mb@us.ibm.com>
Co-Authored-By: zhubingbing <zhubingbing10@gmail.com>
Co-Authored-By: Antoni Segura Puimedon <antonisp@celebdor.com>
Partially-implements: bp kuryr-docker-plugin
2016-09-15 23:47:22 +00:00
Steven Dake 28b80a08cf Revert "Build a more organized doc structure"
Our philosophy document is one of our most important documents
in he documentation repository.  I appreciate in general the notion
of reorganizing many of our docs, but this one should be left alone
and possibly protected by a roll-call vote in the future.

This reverts commit aa517c4bf9.

Change-Id: Ic17861e823095a1891ac25ddaf429b66e352e30e
2016-09-12 12:13:48 -07:00
Jenkins 970eff43f3 Merge "introduce bifrost-deploy container" 2016-08-31 12:45:50 +00:00
Sean Mooney a9e16c8bde introduce bifrost-deploy container
- This change adds support for building and deploying
  a bifrost container for baremetal provisioning.
- This change documents how to manually deploy and bootstrap
  the bifrost container.

Implements: blueprint bifrost-support
Change-Id: I7d895839b11cbf916be33225875465c3358b5aa4
2016-08-31 09:24:24 +00:00
Michal (inc0) Jastrzebski 906c074901 Architecture guide doc
First few paragraphs with richer description on choices deployers can
make while deploy of production kolla

Co-Authored-By: Paul Bourke <paul.bourke@oracle.com>

Change-Id: I3a2d3cf2cbb3678db2dc100e9a63b4992817cc3b
2016-08-29 19:46:01 +00:00
Jenkins 7bf87dddec Merge "Remove heat dev environment" 2016-08-19 02:25:51 +00:00
Ryan Hallisey aa517c4bf9 Build a more organized doc structure
Use directories to further organize the path a user would
take through the docs.

Change-Id: I8e3885c7ac3a72eaadbf547efedf0de477aa0a9f
Partially-implements: blueprint documentation-rework
2016-08-17 06:28:29 -04: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
Mathias Ewald 3894883871 External Ceph - Implementation Cinder
This patch adds support for external Ceph clusters for Cinder.

For clean integration the backend configuration mechanism had to be
slightly adjusted.

We now have the option to enable multiple backends for Cinder
independently.

Currently, the flags cinder_backend_iscsi and cinder_backend_ceph are
used to toggle backends.

Documentation on how to use external ceph was added.

Change-Id: I7e0267b90d62d6d881f24f063cdb894422ec8618
Partially-Implements: Blueprint: external-ceph
2016-07-19 12:45:48 +00:00
Jenkins 19e9585ffb Merge "Added test document" 2016-06-14 09:06:39 +00:00
MD NADEEM 66b6eccd1b Added test document
This doc explain how to run kolla tests.

Change-Id: I498e18187c2c69bbd37c490ce4e1a8548f933791
Partially-implements: blueprint documentation-rework
2016-06-13 11:26:20 +00:00
Michal (inc0) Jastrzebski 775a4c27fd Remove liberty warning
Since it's no longer relevant as liberty 1.0.0 is not there any more

TrivialFix

Change-Id: Id2b2404d76c82444418c00162b1abab2e1a64eed
2016-06-09 15:45:45 +00:00
Paul Bourke 340326f0e9 Move developer related docs into their own section
Change-Id: Ie34bda2a93f92958ea929f305a0e16d1b8ee5566
2016-05-31 12:30:04 +01:00
Christian Berendt a7433cdced Add title to index page of developer documentation
At the moment the title of the index page of the developer documentation is
"Kolla’s Mission". Other projects use "Welcome to X’s developer documentation!".

Change-Id: Iadddc7fbe3d1eeafe5ed1926a3e090b5de70e7ee
2016-05-25 17:40:00 +00:00
Ryan Hallisey 47d7ed2bbf Change the SELinux doc to a security doc
Kolla should have a doc with an overview of security within
the project.

Partially implements: blueprint documentation-rework

Change-Id: I0a8b902fe1b9adf6617779646bf0bbaee1a36c4f
2016-05-18 09:02:33 -04: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
Mauricio Lima 6dfc1ef650 Add a CONTRIBUTING.rst for Kolla
Change-Id: I9910b4fba5ef11c26e687af3273e4fccaf5f235f
Closes-Bug: #1570017
2016-05-04 08:10:33 -04: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
Thiago Gomes d5c79a2487 Add Manila deployment document
Deploy Manila in kolla

Co-Authored-By: Mauricio Lima <mauriciolimab@gmail.com>
Change-Id: I1397e0f10dcbcfd182497fbaf0ebe9d5de718cc5
2016-03-16 09:11:42 -04:00
Steven Dake 13a6062260 Add documentation about critical data loss
There is a critical data loss in Liberty 1.0.0.  It is only fair we
warn Operators not to use 1.0.0 and then revert this change once
1.1.0 is released.

Change-Id: I65a18ddbbdbf2fc5f62f62ff7a1650049b61fada
2016-03-08 22:05:22 -07:00
SamYaple 89cb146ac1 Add docs to explain why we disabling selinux
Change-Id: Iadbd4a0d77aee692abd9ab4f81ba67ead8949b1e
2016-02-18 16:04:03 +00:00
Proskurin Kirill 58ee9c4b84 Updated quickstart doc
I merged "quickstart" doc with "ansible-deployment" and
"deploy-all-in-one-node". All three of them was covering same topic and
added a lot of confusion for new users.

I added some clarification lines from myself, with main goal to recive one
straightforward document for new users.

Change-Id: I793244c47ffbe0ba304e79bacf708494e59d99c4
2015-11-03 13:00:46 +03:00
Steven Dake ef046ee940 Fix broken link
quickstart got busted in a previous commit

Change-Id: I8affb6e0ecc3250eabe276aab401222dc6239349
2015-11-02 15:17:51 -07:00
Steven Dake 83e540cca3 Tidy up index.rst
Include our full mission statement and tidy up the documentation
landing page so it looks more professional and has shorter
titles that communicate the same information.

Change-Id: If54acbfa817e9a9a71e9f16f923094248b2f62f0
2015-11-02 11:25:27 -07:00
Steven Dake 426e637724 Implement Mitaka ODS Documentation structure
From this etherpad:
https://etherpad.openstack.org/p/kolla-mitaka-documentation

Lay groundwork for structure of new documentation layout.

Further work will finish the job on this doc work.

Note in a later change I793244c47ffbe0ba304e79bacf708494e59d99c4
ansible-deployment, deploy-all-in-one-node, and quickstart.rst
will be merged into one document.

Change-Id: I42b576ffab796da6e27adc9dbf55b2ceed641c16
2015-11-02 08:22:58 -07:00
Michal Jastrzebski 2eb16d2f0a Add ceph and ironic to index
Adding link to missing guides to our docs index page.

TrivialFix

Change-Id: I6704a59ef7e010d5ffec762325bd4442362a093c
2015-10-11 10:38:02 +02:00
Steven Dake bdad07d2de Rename swift-readme.rst to swift-guide.rst
All services should have a guide that follows the same style as
cinder-guide.rst or swift-guide.rst and all should be named
service-guie.rst.

Change-Id: Iaa75d137d4e159452153f9fe572fe017fe988be4
2015-09-25 08:54:44 -07:00
Steven Dake 5e83b6d369 Add a customize deployment document
Explain how to customize the deployment with an example and rationale
that is anti-templating :)

Change-Id: I148c89b0608211864d18b60ed7c7082c0b468931
2015-09-18 14:12:21 -07:00
Kuo-tung Kao 26eee6404e Add deploy all in one node document
Add deploy all in one node document.
Use ubuntu host and ubuntu docker image as example.

Change-Id: I8bc0862827e192b63ff3cbf7be9f7227e4f7b1bd
2015-09-10 13:56:00 +08:00
Steven Dake 501d6da665 Add image-buliding.rst to index.rst
Also tidy up title for the main deployment documentation.

Change-Id: Ibd137f01077565ece7cf87affe4200f414a0dce6
2015-09-03 22:21:41 -07:00
Steven Dake 233864ff32 Rename docs dir to doc for publishing
The publishing docs expect the documentation to be present in the
/doc directory not the /docs directory.  If the documentation is in
the /docs directory, according to fungi the docs won't be published
properly.

Change-Id: I718fec7e69d298a5cb2376ca4e2455e12169566e
Partially-Implements: blueprint kola-tox-doc
2015-09-02 22:37:36 -07:00