Skip to content

Commit db5d43e

Browse files
seunghun1eeseunghun1ee
committed
Update old contents
1 parent 85d1b39 commit db5d43e

3 files changed

Lines changed: 58 additions & 116 deletions

File tree

‎doc/source/operations/control-plane-operation.rst‎

Lines changed: 48 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -294,27 +294,61 @@ node is powered back on.
294294
Software Updates
295295
================
296296

297-
Update Packages on Control Plane
298-
--------------------------------
297+
Update Host Packages on Control Plane
298+
-------------------------------------
299299

300-
OS packages can be updated with:
300+
The host packages and Kolla container images are distributed from `StackHPC Release Train
301+
<https://stackhpc.github.io/stackhpc-release-train/>`__ to ensure tested and reliable
302+
software releases are provided.
303+
304+
Syncing new StackHPC Release Train contents to local Pulp server is needed before updating
305+
host packages and/or Kolla services.
306+
307+
To sync host packages:
308+
309+
.. code-block:: console
310+
311+
kayobe# kayobe playbook run $KAYOBE_CONFIG_PATH/ansible/pulp-repo-sync.yml
312+
kayobe# kayobe playbook run $KAYOBE_CONFIG_PATH/ansible/pulp-repo-publish.yml
313+
314+
If the system is production environment and want to use packages tested in test/staging
315+
environment, you can promote them by:
316+
317+
.. code-block:: console
318+
319+
kayobe# kayobe playbook run $KAYOBE_CONFIG_PATH/ansible/pulp-repo-promote-production.yml
320+
321+
To sync container images:
301322

302323
.. code-block:: console
303324
304-
kayobe# kayobe overcloud host package update --limit <Hypervisor node> --packages '*'
305-
kayobe# kayobe overcloud seed package update --packages '*'
325+
kayobe# kayobe playbook run $KAYOBE_CONFIG_PATH/ansible/pulp-container-sync.yml
326+
kayobe# kayobe playbook run $KAYOBE_CONFIG_PATH/ansible/pulp-container-publish.yml
327+
328+
Once sync with StackHPC Release Train is done, new contents will be accessible from local
329+
Pulp server.
330+
331+
Host packages can be updated with:
332+
333+
.. code-block:: console
334+
335+
kayobe# kayobe overcloud host package update --limit <node> --packages '*'
336+
kayobe# kayobe seed host package update --packages '*'
306337
307338
See https://docs.openstack.org/kayobe/latest/administration/overcloud.html#updating-packages
308339

309-
Minor Upgrades to OpenStack Services
310-
------------------------------------
340+
Upgrading OpenStack Services
341+
----------------------------
342+
343+
* Update tags for the images in ``etc/kayobe/kolla-image-tags.yml`` to use the new value of ``kolla_openstack_release``
344+
* Pull container images to overcloud hosts with ``kayobe overcloud container image pull``
345+
* Run ``kayobe overcloud service upgrade``
346+
347+
You can update the subset of containers or hosts by
348+
349+
.. code-block:: console
311350
312-
* Pull latest changes from upstream stable branch to your own ``kolla`` fork (if applicable)
313-
* Update ``kolla_openstack_release`` in ``etc/kayobe/kolla.yml`` (unless using default)
314-
* Update tags for the images in ``etc/kayobe/kolla/globals.yml`` to use the new value of ``kolla_openstack_release``
315-
* Rebuild container images
316-
* Pull container images to overcloud hosts
317-
* Run kayobe overcloud service upgrade
351+
kayobe# kayobe overcloud service upgrade --kolla-tags <service> --limit <hostname> --kolla-limit <hostname>
318352
319353
For more information, see: https://docs.openstack.org/kayobe/latest/upgrading.html
320354

@@ -339,7 +373,7 @@ To boot an instance on a specific hypervisor
339373

340374
.. code-block:: console
341375
342-
openstack server create --flavor <Flavour name>--network <Network name> --key-name <key> --image <Image name> --availability-zone nova::<Hypervisor name> <VM name>
376+
openstack server create --flavor <flavour name>--network <network name> --key-name <key> --image <Image name> --os-compute-api-version 2.74 --host <hypervisor hostname> <vm name>
343377
344378
Cleanup Procedures
345379
==================

‎doc/source/operations/customising-horizon.rst‎

Lines changed: 10 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -46,79 +46,35 @@ Further reading:
4646
* https://docs.openstack.org/horizon/latest/configuration/themes.html
4747
* https://docs.openstack.org/horizon/latest/configuration/branding.html
4848

49-
Building a Horizon container image with custom theme
50-
----------------------------------------------------
49+
Adding the custom theme
50+
-----------------------
5151

52-
Building a custom container image for Horizon can be done by modifying
53-
``kolla.yml`` to fetch the custom theme and include it in the image:
52+
Create a directory and transfer custom theme files to it ``$KAYOBE_CONFIG_PATH/kolla/config/horizon/themes/<custom theme name>``.
5453

55-
.. code-block:: yaml
56-
57-
kolla_sources:
58-
horizon-additions-theme-<custom theme name>:
59-
type: "git"
60-
location: <custom theme repository url>
61-
reference: master
62-
63-
kolla_build_blocks:
64-
horizon_footer: |
65-
# Binary images cannot use the additions mechanism.
66-
{% raw %}
67-
{% if install_type == 'source' %}
68-
ADD additions-archive /
69-
RUN mkdir -p /etc/openstack-dashboard/themes/<custom theme name> \
70-
&& cp -R /additions/horizon-additions-theme-<custom theme name>-archive-master/* /etc/openstack-dashboard/themes/<custom theme name>/ \
71-
&& chown -R horizon: /etc/openstack-dashboard/themes
72-
{% endif %}
73-
{% endraw %}
74-
75-
If using a specific container image tag, don't forget to set:
54+
Define the custom theme in ``etc/kayobe/kolla/globals.yml``
7655

7756
.. code-block:: yaml
78-
79-
kolla_tag: mytag
80-
81-
Build the image with:
82-
83-
.. code-block:: console
84-
85-
kayobe overcloud container image build horizon -e kolla_install_type=source --push
86-
87-
Pull the new Horizon container to the controller:
88-
89-
.. code-block:: console
90-
91-
kayobe overcloud container image pull --kolla-tags horizon
57+
horizon_custom_themes:
58+
- name: <custom theme name>
59+
label: <custom theme label> # This will be the visible name to users
9260
9361
Deploy and use the custom theme
9462
-------------------------------
9563

96-
Switch to source image type in ``${KAYOBE_CONFIG_PATH}/kolla/globals.yml``:
97-
98-
.. code-block:: yaml
99-
100-
horizon_install_type: source
101-
102-
You may also need to update the container image tag:
103-
104-
.. code-block:: yaml
105-
106-
horizon_tag: mytag
107-
10864
Configure Horizon to include the custom theme and use it by default:
10965

11066
.. code-block:: console
11167
112-
mkdir -p ${KAYOBE_CONFIG_PATH}/kolla/config/horizon/
68+
mkdir -p $KAYOBE_CONFIG_PATH/kolla/config/horizon/
11369
114-
Add to ``${KAYOBE_CONFIG_PATH}/kolla/config/horizon/custom_local_settings``:
70+
Create file ``$KAYOBE_CONFIG_PATH/kolla/config/horizon/custom_local_settings`` and add followings
11571

11672
.. code-block:: console
11773
11874
AVAILABLE_THEMES = [
11975
('default', 'Default', 'themes/default'),
12076
('material', 'Material', 'themes/material'),
121-
('<custom theme name>', '<custom theme visible name>', '/etc/openstack-dashboard/themes/<custom theme name>'),
77+
('<custom theme name>', '<custom theme label>', 'themes/<custom theme name>'),
12278
]
12379
DEFAULT_THEME = '<custom theme name>'
12480
@@ -137,9 +93,6 @@ Deploy with:
13793
Troubleshooting
13894
---------------
13995

140-
Make sure you build source images, as binary images cannot use the addition
141-
mechanism used here.
142-
14396
If the theme is selected but the logo doesn’t load, try running these commands
14497
inside the ``horizon`` container:
14598

‎doc/source/operations/openstack-reconfiguration.rst‎

Lines changed: 0 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -138,48 +138,3 @@ And then to enable a hypervisor again:
138138
139139
admin# openstack compute service set --enable \
140140
<Hypervisor name> nova-compute
141-
142-
Managing Space in the Docker Registry
143-
=====================================
144-
145-
If the Docker registry becomes full, this can prevent container updates and
146-
(depending on the storage configuration of the seed host) could lead to other
147-
problems with services provided by the seed host.
148-
149-
To remove container images from the Docker Registry, follow this process:
150-
151-
* Reconfigure the registry container to allow deleting containers. This can be
152-
done in ``docker-registry.yml`` with Kayobe:
153-
154-
.. code-block:: yaml
155-
156-
docker_registry_env:
157-
REGISTRY_STORAGE_DELETE_ENABLED: "true"
158-
159-
* For the change to take effect, run:
160-
161-
.. code-block:: console
162-
163-
kayobe seed host configure
164-
165-
* A helper script is useful, such as https://github.com/byrnedo/docker-reg-tool
166-
(this requires ``jq``). To delete all images with a specific tag, use:
167-
168-
.. code-block:: console
169-
170-
for repo in `./docker_reg_tool http://registry-ip:4000 list`; do
171-
./docker_reg_tool http://registry-ip:4000 delete $repo $tag
172-
done
173-
174-
* Deleting the tag does not actually release the space. To actually free up
175-
space, run garbage collection:
176-
177-
.. code-block:: console
178-
179-
seed# docker exec docker_registry bin/registry garbage-collect /etc/docker/registry/config.yml
180-
181-
The seed host can also accrue a lot of data from building container images.
182-
The images stored locally in the seed host can be seen using ``docker image ls``.
183-
184-
Old and redundant images can be identified from their names and tags, and
185-
removed using ``docker image rm``.

0 commit comments

Comments
 (0)