39 Commits

Author SHA1 Message Date
Steve Wilkerson
5bfae58176 Change 'docker' to 'Docker' in docs
Changed occurences of 'docker' to 'Docker' to be in accordance
with Docker Inc's trademark guidelines found here:

https://www.docker.com/trademark-guidelines

This was done due to a pending change that will append Docker
Inc's trademark notice in the kolla docs

TrivialFix

Change-Id: Ie3f385897bfa604986bd99329c0f4b961d3c8552
2016-12-08 08:07:12 -06:00
Jenkins
19dfe16dbb Merge "Add profile usage to kolla-build guide" 2016-11-06 20:39:11 +00:00
Christian Berendt
5cd30d4914 Remove Fedora support
Closes-bug: #1616387
Change-Id: Id97f88b9baa3d48d33ce120962450a374282d044
2016-11-03 10:50:22 +01:00
Duong Ha-Quang
b043a95b96 Add profile usage to kolla-build guide
It's not uncommon case which user need defined set of images to
use in their scenario.

TrivialFix

Change-Id: I903220def8ce263a51257380a19ae9ea67fb4cd5
2016-10-19 17:05:24 +00:00
Christian Berendt
febc13edfd Deprecate Fedora based Docker images
Change-Id: I84f01a93656ed9c9d828b4619753cb1bb806f74f
Partial-bug: #1616387
2016-09-29 11:49:55 +02:00
Duong Ha-Quang
bcbf22c792 Add Using a different base image to image-building doc
TrivialFix

Change-Id: Ic8e716aa2cfb4717c548ae6f9fecfbe367eb8845
2016-09-23 10:01:22 +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
Paul Bourke
316f0a78f1 Document the Dockerfile customisation mechanism
Document how the new Jinja2 based template customisations work, along
with examples.

Change-Id: Iaddcad6a88acba33d8d07c4eea37d16006e354d1
2016-08-15 09:10:54 +00: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
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
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
Jenkins
ee390f1ed5 Merge "Specify registry volume location" 2016-05-27 21:14:04 +00: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
Martin André
07631a7391 Update the image-building documentation
Small sphinx syntax fixes, better wording, removed pronouns, and
anything else we can think of.

Change-Id: Id7ca8d4673f987d10b520cb1eab77802a043c223
Partially-implements: blueprint documentation-rework
2016-05-25 14:06:24 +02: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
Eduardo Gonzalez
776d9418dd Specify registry volume location
Makes sense specify where the docker volume path is present
for image storage in the kolla host as kolla-vagrant does in the
bootstrapping step. With this way users will know where exactly
their images are stored when re-utilize registry containers

Change-Id: I7f5c46ebab8ec4287a40cd6bd34e75eeb919a24f
2016-05-24 14:55:23 +00: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
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
Ryan Hallisey
9fce1ac981 Document custom-repos
Change-Id: I8777a354acba4395d8ccc48e32cc4178db58461b
2016-04-27 10:48:37 -04:00
Gerard Braad
674ff439fd Change CentOS in documentation
Change-Id: Ic4725a4cef02a57e837c727378a99bf7575d4ebd
2016-03-24 06:59:24 +00:00
Martin André
18f1971144 Document the new 'local' type for source build
Change-Id: Ia385364e3fd8fc3441ebd07adcd981154f34ebb8
2016-03-10 15:19:16 +09:00
Rodolfo Alonso
c0d7abc532 Add documentation for proxy buildargs picked from the environment.
Add documentation for the commit I084e5d1cc8f9993d65167878f9983ad58a68e86e.
Explain how 'build.py' picks up automatically env proxy variables.

Change-Id: Ia8513babd4ff72ed52e167b361d6b54393598a78
Closes-Bug: #1538108
2016-03-07 11:25:51 +00:00
Paul Bourke
8b3d3ef84e Add documentation for Kolla plugin functionality
Every now and then people ask about plugins for Kolla. This conversation
may need to be revisted in more detail soon, but till then it's worth
highlighting what we do currently support in Kolla.

Right now adding the block as shown in this patch will make the plugin
archive available in the image, but currently only Neutron has
Dockerfile directives to automatically install them if present. The same
can be added very easily for other commonly pluggable services such as
Horizon.

Change-Id: Ia52d5ccf753667c5452b19fcaf4bf5b893a59fd0
2016-03-03 10:24:29 +00:00
Allen Gao
23555a6936 add the kolla-build.conf generation doc
TrivialFix
Change-Id: Ic55664a8156560a9f979556ac9b0094fa2946ba4
2016-01-22 21:46:07 +08:00
Swapnil Kulkarni (coolsvap)
5c28abd5fb Updated image building guide for typos
Change-Id: I53b15f9edeb7a59f562f6648a5c5da16845f10a0
2015-11-20 04:58:52 +00:00
Steven Dake
237013afef Retitle several documents
We decided during the ODS documentation session that several
documents need retitling.  This patch retitles the documents
but doesn't actually adjust the content.  There is a separate
patch under work which refactors the content from three documents
into one document.

Change-Id: If5a4718b0ab50c405d42a2e20b7b054b93f3227a
2015-11-02 08:23:01 -07:00
Paul Bourke
61f9f407c4 Add documentation around how to build behind a proxy
Change-Id: Ie0e69f72a9f4c4c1eee897d2b48b4318c3b94638
2015-10-21 12:35:19 +01:00
Kuo-tung Kao
52b7253811 add "registry" flag to "tools/build.py"
With registry flag,
build image using `tools/build.py --registry 172.22.2.81:4000`
the image name looks like `172.22.2.81:4000/kollaglue/data`
When user use kolla-ansible,
user set `docker_registry` to `172.22.2.81:4000` in `/etc/kolla/globals.yml`.

Build image using `tools/build.py -n abcd`
the image name looks like `abcd/data`
When user use kolla-ansible,
user set `docker_namespace:` to `abcd` in `/etc/kolla/globals.yml`.

build image using `tools/build.py -n abcd --registry 172.22.2.81:4000`
the image name looks like `abcd/data`
When user use kolla-ansible,
user set `docker_namespace:` to `abcd` in `/etc/kolla/globals.yml`.
user set `docker_registry` to `172.22.2.81:4000` in `/etc/kolla/globals.yml`.

With the feature, it will reduce user confusing and mistaking.

Change-Id: I18ac7a3ccec032888e35f5e9a79fc190760cc8a0
Closes-Bug: #1505056
2015-10-17 10:08:03 +08:00
Kuo-tung Kao
3f9fbdfd3f add missing kollaglue in image-building
add missing `kollaglue` word to build command in image-building.rst.

Change-Id: Idd9c50a5298094492d170537e42ffeb1ed73af4f
2015-10-12 13:53:06 +08:00
Kuo-tung Kao
08b93d1d85 update doc about local registry in image-building
Reformat local registry section. And document that the Docker config need to
be modified when building images if using local registry.

Change-Id: I51c4df499d84c8ce2a2afc3787b2d609cc0f7d7e
2015-10-08 13:51:40 +08:00
Kuo-tung Kao
32d0e4ef2d update doc about how to set up local registry
Update document about how to set up local registry.

Change-Id: I52895e2416a219e1dfaf2e493eac857598f9c819
Closes-Bug: #1459355
2015-10-07 11:48:43 +08:00
Martin André
6c5aeeee41 Consolidate kolla-build configuration in one file
The source location definition previously in build.ini was merged in
etc/kolla/kolla-build.conf since it is really configuration for the
kolla-build tool.

Change-Id: I7531af0029bdfeabbaefb8a6aa97b70bb12c021a
Closes-Bug: #1496702
2015-09-21 21:20:48 +09:00
Jenkins
4b107aff5f Merge "Spell corrections in Image building guide" 2015-09-18 17:56:29 +00:00
Swapnil Kulkarni
f56109bb22 Spell corrections in Image building guide
Change-Id: I27d560fda14ec87217162c5a20b5752bd21210ef
2015-09-18 15:09:28 +05:30
Martin André
7a4a9eef20 Implement configuration file for kolla-build
Kolla build script configuration now lives in
/etc/kolla/kolla-build.conf.

This allows overriding configuration options without the need to pass
arguments on the command line.

Command line arguments still get precedence.

Closes-Bug: #1496185
Change-Id: I69482a11437087f19d7f76b379dca85b1f622268
2015-09-17 17:21:31 +09:00
Kuo-tung Kao
d4ac18c4fd build.py fails with error on AUFS
add workaround to avoid the issue to image-building document.

Change-Id: Icf34acb2f25c813dee7c7a3dfbb71560be5a970f
Closes-Bug: #1487458
2015-09-10 14:58:41 +08:00
Steven Dake
360999929d Add support to the base image for RHEL
Add support to the base image for running RHEL containers.  Document
how to register a system with RHN in image-buliding.rst.

Change-Id: Id69c114cf734a8242066b8d7d05ba19c07af036a
Partially-Implements: blueprint rhel-based-image-support
2015-09-04 07:06:56 -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