From a89895300df690a5b127df2baaf20b9c329b9ac2 Mon Sep 17 00:00:00 2001
From: Seunghun Lee <seunghun@stackhpc.com>
Date: Thu, 27 Feb 2025 11:05:08 +0000
Subject: [PATCH] Add information about using Amphora from SRT

---
 doc/source/operations/octavia.rst             | 55 ++++++++++++++-----
 doc/source/operations/upgrading-openstack.rst |  2 +-
 2 files changed, 41 insertions(+), 16 deletions(-)

diff --git a/doc/source/operations/octavia.rst b/doc/source/operations/octavia.rst
index f884d130f..c0d512a7f 100644
--- a/doc/source/operations/octavia.rst
+++ b/doc/source/operations/octavia.rst
@@ -4,21 +4,12 @@ Octavia
 
 .. _Amphora image:
 
-Building and rotating amphora images
-====================================
+Updating amphora images
+=======================
 
-StackHPC kayobe config contains utility playbooks to build and rotate the amphora images.
-With your kayobe environment activated, you can build a new amphora image with:
-
-.. code-block:: console
-
-  kayobe playbook run ${KAYOBE_CONFIG_PATH}/ansible/octavia-amphora-image-build.yml
-
-The resultant image is based on Ubuntu. By default the image will be built on the
-seed, but it is possible to change the group in the ansible inventory using the
-``amphora_builder_group`` variable.
+StackHPC kayobe config contains utility playbooks to update and build the amphora images.
 
-To rotate the image, first activate an openrc file containing the credentials
+To update the image, first activate an openrc file containing the credentials
 for the octavia service account, e.g:
 
 .. code-block:: console
@@ -31,16 +22,50 @@ You can then run the playbook to upload the image:
 
   kayobe playbook run ${KAYOBE_CONFIG_PATH}/ansible/octavia-amphora-image-register.yml
 
-This will rename the old image by adding a timestamp suffix, before uploading a
+By default, this will download Amphora image corresponds to OpenStack release from
+StackHPC Release Train.
+Then it will rename the old image by adding a timestamp suffix, before uploading a
 new image with the name, ``amphora-x64-haproxy``. Octavia should be configured
 to discover the image by tag using the ``amp_image_tag`` config option. The
 images are tagged with ``amphora`` to match the kolla-ansible default for
 ``octavia_amp_image_tag``. This prevents you needing to reconfigure octavia
 when building new images.
 
-To rollback an image update, simply delete the old image. The next newest image with
+To rollback an image update, simply delete the newest image. The next newest image with
 a tag matching ``amp_image_tag`` will be selected.
 
+Building amphora images locally
+===============================
+
+You can also build Amphora images locally.
+With your kayobe environment activated, you can build a new amphora image with:
+
+.. code-block:: console
+
+  kayobe playbook run ${KAYOBE_CONFIG_PATH}/ansible/octavia-amphora-image-build.yml
+
+The resultant image is based on Ubuntu. By default the image will be built on the
+seed, but it is possible to change the group in the ansible inventory using the
+``amphora_builder_group`` variable.
+
+To register locally built image, set ``download_amphora_from_ark`` to ``false`` in
+``stackhpc.yml``
+
+.. code-block:: yaml
+  :caption: ``stackhpc.yml``
+
+  # Whether or not to download Octavia Amphora image from Ark. Default is true.
+  download_amphora_from_ark: false
+
+Then copy the image to your first controller host and run the image register playbook.
+The path to the image in the controller needs to be set as an extra variable.
+The default image path is ``/tmp/amphora-x64-haproxy.qcow2``.
+
+.. code-block:: console
+
+  kayobe playbook run ${KAYOBE_CONFIG_PATH}/ansible/octavia-amphora-image-register.yml -e image_path="<path-to-amphora-image>"
+
+
 Manually deleting broken load balancers
 =======================================
 
diff --git a/doc/source/operations/upgrading-openstack.rst b/doc/source/operations/upgrading-openstack.rst
index ee91ae326..2bdb04128 100644
--- a/doc/source/operations/upgrading-openstack.rst
+++ b/doc/source/operations/upgrading-openstack.rst
@@ -1132,7 +1132,7 @@ scope of the upgrade:
 Updating the Octavia Amphora Image
 ----------------------------------
 
-If using Octavia with the Amphora driver, you should :ref:`build a new amphora
+If using Octavia with the Amphora driver, you should :ref:`update the amphora
 image <Amphora image>`.
 
 Testing