aboutsummaryrefslogtreecommitdiff
path: root/doc/source/admin
AgeCommit message (Collapse)AuthorFilesLines
2026-05-05set_configs: Add support for creating directories and setting permsMichal Nasiadka1-0/+17
Change-Id: Id63c035fafaa68a9004c65161c5a3a3ad5544f02 Signed-off-by: Michal Nasiadka <mnasiadka@gmail.com>
2026-03-26Fix: Update outdated documentationPiotr Milewski3-3/+4
Change-Id: I3374810166f10c67df88e97e8bf10a692cfab2cf Signed-off-by: Piotr Milewski <vurmil@gmail.com>
2025-08-29Remove RDO/DeloreanMichal Nasiadka1-11/+4
RDO has staffing problems and has decided to only support SLURP releases - let's drop reliance on that repository. Change-Id: I56f86a1c5262e3ee2bcbb52cae53c3b2655ed87f Signed-off-by: Michal Nasiadka <mnasiadka@gmail.com>
2025-05-20Fix lines in documencation [trivial]Michal Arbet1-14/+14
Change-Id: I5295bba1e11f84217bb2b28ea4d92cb47812b778
2025-03-27Merge "Change Bifrost Python upper-constraints source"Zuul1-5/+63
2025-02-18Allow to use configure_user macro for external templatesAndriy Kurilin1-0/+92
Commit 79a234239516b94b1b79c7ddafcc4fbe4e3ba155 introduced an ability to build 'in-house'/'not-built-in' projects with Kolla. This commits extends this feature with an ability to use configure_user macro for 'not-built-in' users. The implementation is done the same way as for 'sources', i.e. engine after registers new section structure as soon as it finds unknown '<project>-user' section. In addition, the documentation and CI are extended to cover ``--docker-dir`` option. Change-Id: I690d9f3829083f2493bf286a1c45764b9699219b
2025-02-05Change Bifrost Python upper-constraints sourceSeunghun Lee1-5/+63
Users can override the upper-constraints.txt by setting the source of openstack-base in kolla-build.conf. However, bifrost-base Dockerfile so far doesn't pass overridden upper-constraints file to Bifrost install playbook resulting the playbook not acknowledging it and just use upstream one. This change sets the source of Bifrost upper-constraints to use upper-constraints of openstack-base for consistency among all Kolla images With this, change the environment variable UPPER_CONSTRAINTS_FILE is only affecting kolla-toolbox image. Therefore, moved UPPER_CONSTRATINS_FILE variable example to the ``kolla_toolbox_pip_conf`` block of kolla-toolbox Dockerfile. Additionally, updated 'Python packages build options' section of documentation to represent latest method of changing Python package related options (including this change). Change-Id: I0a9c782ca1177ef84e4323cb1e5bfac0fb3f383c
2024-11-15Add mechanism for patching files in containersMichal Arbet1-0/+53
This patch adds a way to patch files in a Docker image built by Kolla. This is very useful for several reasons, specifically: - Custom modifications - The stable branch of some library has a fix but no pip package has been released - Eliminates the need to package your own pip packages - Eliminates the need to invent your own versioning to prevent upstream versioning - Eliminates the need to manage a pip server - In other words, it eliminates the need to get a wheel into the image and install it manually using any method not previously mentioned It is also highly desirable because, although Kolla can replace the source for a service with a custom URL for a tarball or its own Git repo, it cannot do this for dependencies pulled from pip. I would also like to point out that this is a feature with its own code path and works only if the user "inserts" a patch into the folder patches/docker-image/something.patch and creates an analogous series file for patch source code. Simply said, this code will never interfere with the upstream build process since this feature is not intended for use in upstream. It is rather meant for downstream users who know what they are doing. Now they just have an option to patch their images. Everything works on all layers of the Docker image and stores a report of applied patches which can then be seen in /etc. This mechanism is similar as debian patch quilt. Change-Id: I61d0790c5d4d070b7ea9e8c99c0a76ff5d22bf9d
2024-08-21Merge "Add exclude for permissions in kolla config.json file"Zuul1-1/+5
2024-08-21Add exclude for permissions in kolla config.json fileMinSun1-1/+5
When using recursive mode to set permissions for a directory as defined in kolla config.json, all the subdirectories and files will receive the same permissions. This change adds the option to exclude specific files or directories - either a name or a regular expression can be used. Closes-Bug: #1931294 Closes-Bug: #1972168 Co-Authored-By: Jakub Darmach <jakub@stackhpc.com> Change-Id: If2f39736e2af34cd91d0976051ff66f06e96ab42
2024-06-28Merge "Change logic for plugins in grafana image build"Zuul1-0/+18
2024-06-28Change logic for plugins in grafana image buildDawud1-0/+18
Co-authored-by: Will Szumski <will@stackhpc.com> Change-Id: I2b1c95395aeefb2ccb1d8edf415eee0f98c52190
2024-02-08add: cross-compile supportTadas Sutkaitis1-0/+22
The main goal is to be able to build ARM images on standard x86 hardware. Add simple functions supported by python-py and podman-py to enable creation of container images on emulated architectures. Change-Id: I1526b460f6e271c2ec63ab3a3b1dc348d742e96d
2023-09-21[docs] add instructions for optional dependenciesSven Kieske1-1/+6
Change-Id: Iac6617a6755a8271f1cd423c50e79a82bc75e67b Signed-off-by: Sven Kieske <kieske@osism.tech>
2023-09-01Document KOLLA_UPGRADE_CHECK environment variableMatt Crees1-0/+4
Adds docs for the KOLLA_UPGRADE_CHECK variable, introduced here: https://review.opendev.org/c/openstack/kolla/+/878744 This feature currently hard-codes the Nova upgrade check, but should be extended in the future to support the other services that have upgrade checks. (Placement, for example: https://docs.openstack.org/placement/latest/cli/placement-status.html) The docs reflect this intention. Change-Id: I0e9d482b1b26d3e4deddbf6d4a6c83bd8e021269
2023-01-02Add locals_base optionJason1-0/+13
This option allows you to define 'locals' style dependencies as relative to a $locals_base variable, similar to how $tarballs_base works. This can help you avoid defining the same hard-coded path in kolla-build, and instead pass it to kolla via a flag. Similar to $tarballs_base, this works via oslo_config's existing interpolation functionality[1]. Example usage: [DEFAULT] locals_base = /opt/openstack [neutron-base] type = local location = $locals_base/neutron/neutron-stable-rocky.tar.gz [1]: https://docs.openstack.org/oslo.config/latest/reference/configuration-files.html#option-value-interpolation Change-Id: I8670db4dde4dac26df28502637eadc6b854261cf
2022-08-29Fix CVE-2022-38060Radosław Piliszek1-18/+4
Closes-Bug: #1985784 Change-Id: I66476a2b396e2cbe41e68ac51f57aae1806b2ed8
2022-06-02doc: get rid of remainders of binary imagesMarcin Juszkiewicz1-33/+6
We still documented some of binary images details. While we do not have them anymore. Change-Id: I49148ed788cd35ed9f5606d8b69c5e75230433f3
2022-04-14drop install_type almost everywhereMarcin Juszkiewicz1-2/+0
The only place where it stays is argument parsing where it gets ignored. Hardcoded to 'source' to make merging both kolla and kolla-ansible changes easier. Change-Id: I6890a7ec7baf507f8acd75b42bbd0fb17c2e4511 Depends-On: https://review.opendev.org/c/openstack/kolla-ansible/+/837620
2022-03-17Merge "Add enabled flag for sources"Zuul1-6/+11
2022-03-16Add enabled flag for sourcesMark Goddard1-6/+11
Sometimes it might be useful to disable a source for an image, e.g. for a plugin that is not used. This may be to reduce image sizes, or restrict the dependencies necessary to build images. This change adds a new 'enabled' option to each source definition. This allows sources, plugins or additions for each source image to be disabled individually. Change-Id: I31ee0744574fb3db96bee2e9f545600de53d9ee4
2022-03-11Unify curl use (customisation options)Maksim Malchuk1-0/+11
This change adds and unifies an ability to override hardcoded URLs for air-gapped environments via the usual blocks mechanism. Also, this change replaces ENV with ARG instruction for the variables used only in building images, and uses bash variable expansion where it possible. This change is a continuation of the I46b77978926fc2b578a68d1aaa944b2198af0685 Change-Id: I1fbad333b1bc95484e6f4c5145d5936a0e2db84f Signed-off-by: Maksim Malchuk <maksim.malchuk@gmail.com>
2022-03-07Clarify documentation about source overrideVictor Coutellier1-2/+7
The current documentation about source override is ambiguous and let users presume that you should always use "-base" after the project name you want to override source location. This assumption is wrong, as kolla look for a section who match exactly the name of the image. Images who don't have a "-base", like Horizon, are really hard to override for a user. I propose to put an example without a "-base" and also add a disclaimer in the documentation about that. Change-Id: I308a352975f11c29afb3f2ea1c22212062066b4b
2021-11-28document that binary images are now deprecatedMarcin Juszkiewicz1-0/+5
Support for binary images gets removed in Z cycle. Change-Id: I9cd93a2022d6b9d17f326d55d57f86cb5e141e7d
2021-09-30Build source type images by defaultMark Goddard1-2/+2
Source images get the most test coverage, so it makes sense to build these by default. Change-Id: Ie10a41a94af95075a1b91feb2b74ade02b17117e
2021-07-28drop leftovers of RHEL supportMarcin Juszkiewicz2-20/+0
As a project we never built RHEL based images so support for them was not tested. Change-Id: I27dfe34ade088228d71f6857ec4f3ab28ee63915
2021-04-30docs: update supported OS distrosMark Goddard1-2/+3
* correct base container image info * show RHEL as deprecated Change-Id: Ie8eec4cb4e29e7f659228e2792c13c01dfb4a41c
2021-04-21[release] Add docs on Neutron pluginsRadosław Piliszek1-0/+14
And improve the reno. Change-Id: I76ffed7332da18c8c01e96dbf0c30badf231a0d0
2021-03-17Improve docsRadosław Piliszek1-204/+163
Part of changes discussed during Kolla Kalls. These make our documentation easier to digest. Changes in conf.py are to avoid warnings from sphinx. Change-Id: I76ab6786b271963252278fcf12f1a28cab520fdb
2021-01-18docs: drop Fedora info, mark Ubuntu one as Debian / UbuntuMarcin Juszkiewicz1-7/+2
Newton release was long time ago. Time to retire info that we had Fedora support. Change-Id: I44fcb6e11b729369b5e64bdeb64e9ca7c0142979
2020-11-30Update the'image-building.rst' documentLinPeiWen1-11/+11
The openstack Ussuri and Victoria versions no longer support python2 and python-pip packages by default, update the'image-building.rst' document Change-Id: I34a2880a06e80ec1b7737ec1ffbef5f6ba7bed47
2020-07-07Remove opendaylight imageMichal Nasiadka1-28/+0
It has been deprecated in Ussuri cycle. Change-Id: I6d3174e8b52cb4d1f2eca4d85d506665dafe2406
2020-04-15CentOS 8: Switch last mentions of yum to dnfMark Goddard1-1/+1
Change-Id: I31e9742793cfb1abff9749083c9ce86000dae1af Partially-Implements: blueprint centos-rhel-8
2020-04-06Add docs and release note for CentOS 8Mark Goddard1-0/+4
Adds info on supported distros to support matrix. Adds release note about CentOS 7 drop and dropped images. Change-Id: I0ada13af2fe57de550c1703d636436190e5d489a Partially-Implements: blueprint centos-rhel-8
2019-10-29Docs: Remove a bad recommendationRadosław Piliszek1-8/+0
Change-Id: I50bea7e81955299949d7129adb8ad70c33decf51
2019-09-18Remove support for OracleLinuxMark Goddard2-3/+1
We have agreed to remove support for Oracle Linux. http://lists.openstack.org/pipermail/openstack-discuss/2019-June/006896.html Change-Id: I961dfba1aeef2c509ecdaf376dfe6928926ffb39 Depends-On: https://review.opendev.org/682858
2019-08-12Merge "Upgrade Monasca to InfluxDB 1.7"Zuul1-18/+0
2019-07-05Merge "Change port of docker registry"Zuul1-2/+2
2019-06-24Upgrade Monasca to InfluxDB 1.7Doug Szumski1-18/+0
Monasca now supports InfluxDB 1.7, the current version provided by Kolla. We no longer need to build an old version for Monasca. Depends-On: https://review.opendev.org/#/c/658330 Change-Id: I5a86405901139d643172835acb89f55b14bfedbf
2019-06-17Change port of docker registrypengdake1-2/+2
The port of docker registry is conflict with keystone. So we need to change port of docker registry. Change-Id: If15c0caf76b5406f590b05030e43d65ca14c8788 Signed-off-by: pengdake <19921207pq@gmail.com>
2019-06-14doc: Start using openstackdoctheme's extlink extensionchenxing1-8/+6
This ensures we have version-specific references to other projects [1]. Note that this doesn't mean the URLs are actually valid - we need to do more work (linkcheck?) here, but it's an improvement nonetheless. [1] https://docs.openstack.org/openstackdocstheme/latest/#external-link-helper Change-Id: I7c979dacd89ebead404b751d596ba120b38f00f3
2019-04-24Move to opendevZhongShengping1-3/+3
1.Use opendev.org instead of git.openstack.org. 2.Use review.opendev.org instead of review.openstack.org. You can see the discussion below: http://lists.openstack.org/pipermail/openstack-discuss/2019-March/003603.html Change-Id: I377ea63827b6f3995ee275fdc466c1b2100eafc7
2019-03-12Add python3 packages for RHEL systemsAlex Schultz1-1/+1
RDO is currently working on python3 support for the next version of CentOS/RHEL based systems. This package uses the distro_python3 flag that was added as part of I4028991bad92c0e8e21066cc4173c06ce5eba393 to use the python3 specific package names. This change only adds python3 package names for RHEL systems. Conflicts-With: https://review.openstack.org/#/c/636457/ Change-Id: Iad6b70b433a0dd1b0f8ae6790fd280594517661a Related-Blueprint: python3-support
2018-12-21Update docs for building ovs-dpdk imagesGeorg Kunz1-12/+8
Correcting and clarifying the documention for how to build OVS images with DPDK support: * The additional heading was confusing and the following sentence even more so. * Fixed the image name in the build command. * Updated the OVS and DPDK version numbers to current stable versions. Change-Id: Ib12be3da4f1fc14f1fed990a8abcdf87477a4e1b
2018-11-14Replacing the HTTP protocal with HTTPS .zhouxinyong1-1/+1
Change-Id: I4217433a2c7d199a3768ae02e2f6798fe6703fd8
2018-11-08Merge "Fix documentation for Kolla image-building guide"Zuul1-1/+1
2018-11-08Fix documentation for Kolla image-building guideletrangg1-1/+1
A grammar error that might make it confusing for the readers to follow the document was fixed. Change-Id: I497822904d1360f64ef3fbaf9c128fcb38e2f8db
2018-10-16Merge "Add Monasca template override file"Zuul1-0/+18
2018-10-09Document Kolla image APIMartin André2-0/+186
A first shot at documenting the kolla image API. Not perfect but this should at least provide a good overview for the projects that want to consume kolla images. Change-Id: I10943a050e4d21dfcdebb75084a26c12845d322b
2018-10-02Add Monasca template override fileDoug Szumski1-0/+18
Unfortunately Monasca currently requires an old version of InfluxDB. Partially-Implements: blueprint monasca-containers Change-Id: I09af763ef97efc786994c180562861fef96dcc14