Skip to content

Commit a02c89e

Browse files
seunghun1eeMaxBed4d
authored andcommittedFeb 28, 2025
Add information about using Amphora from SRT
1 parent e9b6727 commit a02c89e

File tree

2 files changed

+41
-16
lines changed

2 files changed

+41
-16
lines changed
 

‎doc/source/operations/octavia.rst

Lines changed: 40 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,12 @@ Octavia
44

55
.. _Amphora image:
66

7-
Building and rotating amphora images
8-
====================================
7+
Updating amphora images
8+
=======================
99

10-
StackHPC kayobe config contains utility playbooks to build and rotate the amphora images.
11-
With your kayobe environment activated, you can build a new amphora image with:
12-
13-
.. code-block:: console
14-
15-
kayobe playbook run ${KAYOBE_CONFIG_PATH}/ansible/octavia-amphora-image-build.yml
16-
17-
The resultant image is based on Ubuntu. By default the image will be built on the
18-
seed, but it is possible to change the group in the ansible inventory using the
19-
``amphora_builder_group`` variable.
10+
StackHPC kayobe config contains utility playbooks to update and build the amphora images.
2011

21-
To rotate the image, first activate an openrc file containing the credentials
12+
To update the image, first activate an openrc file containing the credentials
2213
for the octavia service account, e.g:
2314

2415
.. code-block:: console
@@ -31,16 +22,50 @@ You can then run the playbook to upload the image:
3122
3223
kayobe playbook run ${KAYOBE_CONFIG_PATH}/ansible/octavia-amphora-image-register.yml
3324
34-
This will rename the old image by adding a timestamp suffix, before uploading a
25+
By default, this will download Amphora image corresponds to OpenStack release from
26+
StackHPC Release Train.
27+
Then it will rename the old image by adding a timestamp suffix, before uploading a
3528
new image with the name, ``amphora-x64-haproxy``. Octavia should be configured
3629
to discover the image by tag using the ``amp_image_tag`` config option. The
3730
images are tagged with ``amphora`` to match the kolla-ansible default for
3831
``octavia_amp_image_tag``. This prevents you needing to reconfigure octavia
3932
when building new images.
4033

41-
To rollback an image update, simply delete the old image. The next newest image with
34+
To rollback an image update, simply delete the newest image. The next newest image with
4235
a tag matching ``amp_image_tag`` will be selected.
4336

37+
Building amphora images locally
38+
===============================
39+
40+
You can also build Amphora images locally.
41+
With your kayobe environment activated, you can build a new amphora image with:
42+
43+
.. code-block:: console
44+
45+
kayobe playbook run ${KAYOBE_CONFIG_PATH}/ansible/octavia-amphora-image-build.yml
46+
47+
The resultant image is based on Ubuntu. By default the image will be built on the
48+
seed, but it is possible to change the group in the ansible inventory using the
49+
``amphora_builder_group`` variable.
50+
51+
To register locally built image, set ``download_amphora_from_ark`` to ``false`` in
52+
``stackhpc.yml``
53+
54+
.. code-block:: yaml
55+
:caption: ``stackhpc.yml``
56+
57+
# Whether or not to download Octavia Amphora image from Ark. Default is true.
58+
download_amphora_from_ark: false
59+
60+
Then copy the image to your first controller host and run the image register playbook.
61+
The path to the image in the controller needs to be set as an extra variable.
62+
The default image path is ``/tmp/amphora-x64-haproxy.qcow2``.
63+
64+
.. code-block:: console
65+
66+
kayobe playbook run ${KAYOBE_CONFIG_PATH}/ansible/octavia-amphora-image-register.yml -e image_path="<path-to-amphora-image>"
67+
68+
4469
Manually deleting broken load balancers
4570
=======================================
4671

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1132,7 +1132,7 @@ scope of the upgrade:
11321132
Updating the Octavia Amphora Image
11331133
----------------------------------
11341134

1135-
If using Octavia with the Amphora driver, you should :ref:`build a new amphora
1135+
If using Octavia with the Amphora driver, you should :ref:`update the amphora
11361136
image <Amphora image>`.
11371137

11381138
Testing

0 commit comments

Comments
 (0)
Please sign in to comment.