aboutsummaryrefslogtreecommitdiff
path: root/doc/image-building.rst
AgeCommit message (Collapse)AuthorFilesLines
2017-10-11Rearrange existing documentation to fit the new standard layoutchenxing1-453/+0
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-08-06Add RHEL distro available for building imagesTaeha Kim1-0/+1
Change-Id: I8a113f98f4a916ab91de45029a2390d06ae4ea65 Signed-off-by: Taeha Kim <kthguru@gmail.com>
2017-07-13Fix doc build warningsEduardo Gonzalez1-3/+5
Fix warnings: doc/image-building.rst:415:undefined label: deploy_a_registry (if the link has no caption the label must precede a section header) Change-Id: I8d921f3b05acf9304ccf41e172926887088b97d7
2017-06-08`[keystone]` should be `[keystone-base]` in docjiangpch1-1/+1
This can be misleading when building source-type images, as `[keystone]` doesn't work as expected. Change-Id: Id59fa5f05e4ddeb4ac0afc111a4fc516c503e58b
2017-05-17Fix typozejian Zhuang1-1/+1
Change-Id: Ie19f4d2bb623924b85b8d73be686dd1782822851
2017-05-10Clarify documentation around plugins and additions archivesMartin André1-23/+16
Change-Id: I339874bcdb14f46b211bbab7a915d27310bb862d
2017-03-27RHEL: Add mod_ssl for services running over httpdJuan Antonio Osorio Robles1-0/+1
This apache module is necessary for when one wants to use TLS for the services running over httpd. This only addressed RHEL based systems at the moment, since there is no such package available for Ubuntu. This requires apache2.2-common which will carry a lot more dependencies; So I think this should be handled and decided in a separate patch. when installing mod_ssl in RHEL-based distributions, an ssl.conf file is installed in the /etc/httpd/conf.d directory. This file tells httpd to listen on port 443; however, we don't want to do this by default, since this should be explicitly enabled by the container's configuration. This line is thus removed from the configuration. A release note was added, which specifies this. And the last sentence can be removed if this is addressed for debian/ubuntu as well. Related-Bug: #1675490 Co-Authored-By: Martin André <m.andre@redhat.com> Change-Id: Id6215d31547247309d43c031e163fa9e4c4ec5dc
2017-03-21Switch trunk/cbs/buildlogs to use httpsEmilien Macchi1-1/+1
There is a permanent redirection from http to https in buildlogs, cbs and trunk repos that might create issues when the redirection fails for some reasons. Let's use https directly. Change-Id: I15b2df335b4b9331466da2f7cb6e838823a6fd34
2017-02-24Fix typos in doc_filesyuhui_inspur1-1/+1
Change-Id: I57844e5284a51a0804bc2f14d9ac1f3a7c9bfdf8
2017-01-05Allow for image additions archives (as well as plugins)Joshua Harlow1-1/+63
It is quite useful to be able to add additional items (such as jenkins build information) into the image but the only way to do this seems to be via plugins archives. Using these for such information ends badly when building neutron (because those *plugin* archives need to contain setup.py files) so this proposes a new mechanism to put files that are not python plugins but are auxilary useful data to put in the image (such as the jenkins data mentioned above). Change-Id: Ica8b5750bd239e023f14225190e68dab75519d36
2016-12-09Merge "Minor documentation fixes"Jenkins1-2/+2
2016-12-08Change 'docker' to 'Docker' in docsSteve Wilkerson1-5/+5
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: I2a030232ca9ca7a040780402c0b73df0341ae253
2016-12-07Minor documentation fixesSayantani Goswami1-2/+2
doc/cinder-guide.rst:90: Title underline too short. doc/cinder-guide.rst:131: Title underline too short. doc/image-building.rst:153: Line too long doc/manila-guide.rst:327: Line too long doc/manila-guide.rst:332: Line too long doc/manila-hnas-guide.rst:28: Title underline too short. doc/manila-hnas-guide.rst:102: Title underline too short. doc/manila-hnas-guide.rst:75: Line too long doc/quickstart.rst:187: Trailing whitespace doc/quickstart.rst:194: Trailing whitespace doc/quickstart.rst:68: Line too long Change-Id: I1f27f93337450ccf82d15a5981c8ccbed2a6d464
2016-11-29Merge "Word choice for back end"Jenkins1-1/+1
2016-11-25Remove --include-header and --include-footer parameterTin Lam1-24/+7
In Newton, kolla moved to Dockerfile customization, and the parameters --included-header and --include-footer were marked deprecated. This patch set removes them in the Ocata release. Change-Id: I3263c305bf619ab47a31cf4eafe5d4fcfa4aec17 Closes-Bug: #1643967
2016-11-22Merge "Clean up docs around local registry"Jenkins1-58/+7
2016-11-15Clean up docs around local registryPaul Bourke1-58/+7
* Remove duplicated info between the 'image-building' and 'multinode' guides regarding deploying a local insecure registry. * Add a helper script to easily start a local registry in a consistent way. * Remove warnings around bugs in older registries, 2.3+ is now the default * Remove references to running the local registry on port 4000, this causes confusion as Docker expects port 5000 by default unless specified, and registries are not required for all-in-one deployments anyhow. TrivialFix Change-Id: I89f231df09102e3f1d5f21c8a8ca938ea60ae95b
2016-11-15Word choice for back endlijing1-1/+1
This patch changes the use of back end in kolla according to the word choice convention [1]. [1] http://docs.openstack.org/contributor-guide/writing-style/word-choice.html Change-Id: I20f2e158ba487622208d89b48eea0250257f5e76
2016-11-06Merge "Add profile usage to kolla-build guide"Jenkins1-0/+24
2016-11-03Remove Fedora supportChristian Berendt1-1/+0
Closes-bug: #1616387 Change-Id: Id97f88b9baa3d48d33ce120962450a374282d044
2016-10-19Add profile usage to kolla-build guideDuong Ha-Quang1-0/+24
It's not uncommon case which user need defined set of images to use in their scenario. TrivialFix Change-Id: I903220def8ce263a51257380a19ae9ea67fb4cd5
2016-09-29Deprecate Fedora based Docker imagesChristian Berendt1-0/+5
Change-Id: I84f01a93656ed9c9d828b4619753cb1bb806f74f Partial-bug: #1616387
2016-09-23Add Using a different base image to image-building docDuong Ha-Quang1-0/+8
TrivialFix Change-Id: Ic8e716aa2cfb4717c548ae6f9fecfbe367eb8845
2016-08-20Make tox -e docs workSteven Dake1-4/+4
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-15Document the Dockerfile customisation mechanismPaul Bourke1-26/+150
Document how the new Jinja2 based template customisations work, along with examples. Change-Id: Iaddcad6a88acba33d8d07c4eea37d16006e354d1
2016-08-04Add doc8 test and improve rst syntaxChristian Berendt1-12/+15
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-06-14Update kollaglue repo on docker to kollaSwapnil Kulkarni (coolsvap)1-1/+1
[1] http://lists.openstack.org/pipermail/openstack-dev/2016-June/097227.html Change-Id: I73af59dcf1e755dbe0579486f1fb0ebe5ca0119c Closes-Bug: #1592286
2016-05-31Merge "Update Documentation"Jenkins1-32/+28
2016-05-28Do not use AUFS for centos/fedora/oraclelinux container images on ubuntu hostHui Kang1-4/+5
Change-Id: I9e9a96b71498a7d824d34e21028ad73f57302125 Closes-Bug: #1579583
2016-05-27Merge "Specify registry volume location"Jenkins1-1/+5
2016-05-27Update DocumentationMauricio Lima1-32/+28
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-25Update the image-building documentationMartin André1-79/+38
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-25Simplify image building information in quickstartMartin André1-16/+27
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-24Specify registry volume locationEduardo Gonzalez1-1/+5
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-16Structuring the documentationSwapnil Kulkarni (coolsvap)1-18/+14
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-14Doc rework for quickstart, multinode, and image-buildingRyan Hallisey1-0/+18
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-04-27Document custom-reposRyan Hallisey1-0/+18
Change-Id: I8777a354acba4395d8ccc48e32cc4178db58461b
2016-03-24Change CentOS in documentationGerard Braad1-1/+1
Change-Id: Ic4725a4cef02a57e837c727378a99bf7575d4ebd
2016-03-10Document the new 'local' type for source buildMartin André1-1/+13
Change-Id: Ia385364e3fd8fc3441ebd07adcd981154f34ebb8
2016-03-07Add documentation for proxy buildargs picked from the environment.Rodolfo Alonso1-0/+12
Add documentation for the commit I084e5d1cc8f9993d65167878f9983ad58a68e86e. Explain how 'build.py' picks up automatically env proxy variables. Change-Id: Ia8513babd4ff72ed52e167b361d6b54393598a78 Closes-Bug: #1538108
2016-03-03Add documentation for Kolla plugin functionalityPaul Bourke1-0/+38
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-01-22add the kolla-build.conf generation docAllen Gao1-3/+8
TrivialFix Change-Id: Ic55664a8156560a9f979556ac9b0094fa2946ba4
2015-11-20Updated image building guide for typosSwapnil Kulkarni (coolsvap)1-1/+1
Change-Id: I53b15f9edeb7a59f562f6648a5c5da16845f10a0
2015-11-02Retitle several documentsSteven Dake1-2/+2
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-10-21Add documentation around how to build behind a proxyPaul Bourke1-0/+36
Change-Id: Ie0e69f72a9f4c4c1eee897d2b48b4318c3b94638
2015-10-17add "registry" flag to "tools/build.py"Kuo-tung Kao1-6/+4
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-12add missing `kollaglue` in image-buildingKuo-tung Kao1-2/+2
add missing `kollaglue` word to build command in image-building.rst. Change-Id: Idd9c50a5298094492d170537e42ffeb1ed73af4f
2015-10-08update doc about local registry in image-buildingKuo-tung Kao1-3/+27
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-07update doc about how to set up local registryKuo-tung Kao1-0/+46
Update document about how to set up local registry. Change-Id: I52895e2416a219e1dfaf2e493eac857598f9c819 Closes-Bug: #1459355
2015-09-21Consolidate kolla-build configuration in one fileMartin André1-2/+4
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
generated by cgit v1.2.3 (git 2.39.1) at 2026-11-05 21:05:40 +0000