aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorZuul <zuul@review.opendev.org>2025-03-24 14:13:46 +0000
committerGerrit Code Review <review@openstack.org>2025-03-24 14:13:46 +0000
commitd7c4546fce0305fd49cff54bda5bf83e02c0a32d (patch)
tree3e75e12c61cb1bdc7cd61828d2ba2e7f5c3cb8cd /doc
parenta18204bcd9b7a83a757854b2f838773beea6db87 (diff)
parentadb1a9b918e428b8ab173118c40d215db0c70ce6 (diff)
downloadkolla-ansible-d7c4546fce0305fd49cff54bda5bf83e02c0a32d.tar.gz
kolla-ansible-d7c4546fce0305fd49cff54bda5bf83e02c0a32d.zip
Merge "Remove Swift role"
Diffstat (limited to 'doc')
-rw-r--r--doc/source/admin/advanced-configuration.rst7
-rw-r--r--doc/source/admin/production-architecture-guide.rst10
-rw-r--r--doc/source/conf.py1
-rw-r--r--doc/source/reference/shared-services/glance-guide.rst15
-rw-r--r--doc/source/reference/storage/index.rst1
-rw-r--r--doc/source/reference/storage/swift-guide.rst315
6 files changed, 4 insertions, 345 deletions
diff --git a/doc/source/admin/advanced-configuration.rst b/doc/source/admin/advanced-configuration.rst
index a803467dd..2f2864cc6 100644
--- a/doc/source/admin/advanced-configuration.rst
+++ b/doc/source/admin/advanced-configuration.rst
@@ -253,7 +253,7 @@ it's advised to make above change before deploying.
Use an external Syslog server
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-By default, Fluentd is used as a syslog server to collect Swift and HAProxy
+By default, Fluentd is used as a syslog server to collect HAProxy
logs. When Fluentd is disabled or you want to use an external syslog server,
You can set syslog parameters in ``globals.yml`` file. For example:
@@ -262,12 +262,11 @@ You can set syslog parameters in ``globals.yml`` file. For example:
syslog_server: "172.29.9.145"
syslog_udp_port: "514"
-You can also set syslog facility names for Swift and HAProxy logs.
-By default, Swift and HAProxy use ``local0`` and ``local1``, respectively.
+You can also set syslog facility names for HAProxy logs.
+By default, HAProxy uses ``local1``.
.. code-block:: yaml
- syslog_swift_facility: "local0"
syslog_haproxy_facility: "local1"
If Glance TLS backend is enabled (``glance_enable_tls_backend``), the syslog
diff --git a/doc/source/admin/production-architecture-guide.rst b/doc/source/admin/production-architecture-guide.rst
index 7aa2d7e07..d1da7eaad 100644
--- a/doc/source/admin/production-architecture-guide.rst
+++ b/doc/source/admin/production-architecture-guide.rst
@@ -25,7 +25,7 @@ A basic Kolla inventory consists of several types of nodes, known in Ansible as
* Compute - Compute nodes for compute services. This is where guest VMs
live.
-* Storage - Storage nodes for cinder-volume, LVM or Swift.
+* Storage - Storage nodes for cinder-volume, LVM.
* Monitoring - Monitor nodes which host monitoring services.
@@ -54,14 +54,6 @@ In Kolla operators should configure following network interfaces:
``kolla_enable_tls_external`` is set to yes. Defaults to
``network_interface``.
-* ``swift_storage_interface`` - This interface is used by Swift for storage
- access traffic. This can be heavily utilized so it's recommended to use
- a high speed network fabric. Defaults to ``network_interface``.
-
-* ``swift_replication_interface`` - This interface is used by Swift for storage
- replication traffic. This can be heavily utilized so it's recommended to use
- a high speed network fabric. Defaults to ``swift_storage_interface``.
-
* ``tunnel_interface`` - This interface is used by Neutron for vm-to-vm traffic
over tunneled networks (like VxLan). Defaults to ``network_interface``.
diff --git a/doc/source/conf.py b/doc/source/conf.py
index f101e5514..2542686e0 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -111,7 +111,6 @@ openstack_projects = [
'oslo.messaging',
'oslotest',
'ovn-octavia-provider',
- 'swift',
'watcher',
]
diff --git a/doc/source/reference/shared-services/glance-guide.rst b/doc/source/reference/shared-services/glance-guide.rst
index 48e8774aa..03b4c7406 100644
--- a/doc/source/reference/shared-services/glance-guide.rst
+++ b/doc/source/reference/shared-services/glance-guide.rst
@@ -16,7 +16,6 @@ backends:
* file
* ceph
* vmware
-* swift
File backend
~~~~~~~~~~~~
@@ -91,20 +90,6 @@ use the following variables:
All Glance S3 configurations use these options as default values.
-Swift backend
-~~~~~~~~~~~~~
-
-To store glance images in a swift cluster, the ``swift`` backend should
-be enabled. Refer to :doc:`../storage/swift-guide` on how to configure
-swift in kolla.
-If ceph is enabled, will have higher precedence over swift as glance backend.
-
-To enable the swift backend manually:
-
-.. code-block:: yaml
-
- glance_backend_swift: "yes"
-
Upgrading glance
----------------
diff --git a/doc/source/reference/storage/index.rst b/doc/source/reference/storage/index.rst
index ad18929a6..e88494265 100644
--- a/doc/source/reference/storage/index.rst
+++ b/doc/source/reference/storage/index.rst
@@ -14,4 +14,3 @@ supported by kolla.
cinder-guide-pure
manila-guide
manila-hnas-guide
- swift-guide
diff --git a/doc/source/reference/storage/swift-guide.rst b/doc/source/reference/storage/swift-guide.rst
deleted file mode 100644
index 40e6a8258..000000000
--- a/doc/source/reference/storage/swift-guide.rst
+++ /dev/null
@@ -1,315 +0,0 @@
-.. _swift-guide:
-
-==============================
-Swift - Object storage service
-==============================
-
-Overview
-~~~~~~~~
-
-Kolla can deploy a full working Swift setup in either a **all-in-one** or
-**multinode** setup.
-
-Networking
-~~~~~~~~~~
-
-The following interfaces are used by Swift:
-
-External API interface (``kolla_external_vip_interface``)
- This interface is used by users to access the Swift public API.
-Internal API interface (``api_interface``)
- This interface is used by users to access the Swift internal API. It is also
- used by HAProxy to access the Swift proxy servers.
-Swift Storage interface (``swift_storage_interface``)
- This interface is used by the Swift proxy server to access the account,
- container and object servers.
-Swift replication interface (``swift_replication_interface``)
- This interface is used for Swift storage replication traffic.
- This is optional as the default configuration uses
- the ``swift_storage_interface`` for replication traffic.
-
-Disks with a partition table (recommended)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Swift requires block devices to be available for storage. To prepare a disk
-for use as a Swift storage device, a special partition name and filesystem
-label need to be added.
-
-The following should be done on each storage node, the example is shown
-for three disks:
-
-.. warning::
-
- ALL DATA ON DISK will be LOST!
-
-.. code-block:: console
-
- index=0
- for d in sdc sdd sde; do
- parted /dev/${d} -s -- mklabel gpt mkpart KOLLA_SWIFT_DATA 1 -1
- sudo mkfs.xfs -f -L d${index} /dev/${d}1
- (( index++ ))
- done
-
-For evaluation, loopback devices can be used in lieu of real disks:
-
-.. code-block:: console
-
- index=0
- for d in sdc sdd sde; do
- free_device=$(losetup -f)
- fallocate -l 1G /tmp/$d
- losetup $free_device /tmp/$d
- parted $free_device -s -- mklabel gpt mkpart KOLLA_SWIFT_DATA 1 -1
- sudo mkfs.xfs -f -L d${index} ${free_device}p1
- (( index++ ))
- done
-
-Disks without a partition table
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Kolla also supports unpartitioned disk (filesystem on ``/dev/sdc`` instead of
-``/dev/sdc1``) detection purely based on filesystem label. This is generally
-not a recommended practice but can be helpful for Kolla to take over Swift
-deployment already using disk like this.
-
-Given hard disks with labels swd1, swd2, swd3, use the following settings in
-``ansible/roles/swift/defaults/main.yml``.
-
-.. code-block:: yaml
-
- swift_devices_match_mode: "prefix"
- swift_devices_name: "swd"
-
-Rings
-~~~~~
-
-Before running Swift we need to generate **rings**, which are binary compressed
-files that at a high level let the various Swift services know where data is in
-the cluster. We hope to automate this process in a future release.
-
-The following example commands should be run from the ``operator`` node to
-generate rings for a demo setup. The commands work with **disks with partition
-table** example listed above. Please modify accordingly if your setup is
-different.
-
-If using a separate replication network it is necessary to add the replication
-network IP addresses to the rings. See the :swift-doc:`Swift documentation
-<replication_network.html#dedicated-replication-network>` for details on
-how to do that.
-
-Prepare for Rings generating
-----------------------------
-
-To prepare for Swift Rings generating, run the following commands to initialize
-the environment variable and create ``/etc/kolla/config/swift`` directory:
-
-.. code-block:: console
-
- STORAGE_NODES=(192.168.0.2 192.168.0.3 192.168.0.4)
- KOLLA_SWIFT_BASE_IMAGE="kolla/centos-source-swift-base:4.0.0"
- mkdir -p /etc/kolla/config/swift
-
-Generate Object Ring
---------------------
-
-To generate Swift object ring, run the following commands:
-
-.. code-block:: console
-
- docker run \
- --rm \
- -v /etc/kolla/config/swift/:/etc/kolla/config/swift/ \
- $KOLLA_SWIFT_BASE_IMAGE \
- swift-ring-builder \
- /etc/kolla/config/swift/object.builder create 10 3 1
-
- for node in ${STORAGE_NODES[@]}; do
- for i in {0..2}; do
- docker run \
- --rm \
- -v /etc/kolla/config/swift/:/etc/kolla/config/swift/ \
- $KOLLA_SWIFT_BASE_IMAGE \
- swift-ring-builder \
- /etc/kolla/config/swift/object.builder add r1z1-${node}:6000/d${i} 1;
- done
- done
-
-Generate Account Ring
----------------------
-
-To generate Swift account ring, run the following commands:
-
-.. code-block:: console
-
- docker run \
- --rm \
- -v /etc/kolla/config/swift/:/etc/kolla/config/swift/ \
- $KOLLA_SWIFT_BASE_IMAGE \
- swift-ring-builder \
- /etc/kolla/config/swift/account.builder create 10 3 1
-
- for node in ${STORAGE_NODES[@]}; do
- for i in {0..2}; do
- docker run \
- --rm \
- -v /etc/kolla/config/swift/:/etc/kolla/config/swift/ \
- $KOLLA_SWIFT_BASE_IMAGE \
- swift-ring-builder \
- /etc/kolla/config/swift/account.builder add r1z1-${node}:6001/d${i} 1;
- done
- done
-
-Generate Container Ring
------------------------
-
-To generate Swift container ring, run the following commands:
-
-.. code-block:: console
-
- docker run \
- --rm \
- -v /etc/kolla/config/swift/:/etc/kolla/config/swift/ \
- $KOLLA_SWIFT_BASE_IMAGE \
- swift-ring-builder \
- /etc/kolla/config/swift/container.builder create 10 3 1
-
- for node in ${STORAGE_NODES[@]}; do
- for i in {0..2}; do
- docker run \
- --rm \
- -v /etc/kolla/config/swift/:/etc/kolla/config/swift/ \
- $KOLLA_SWIFT_BASE_IMAGE \
- swift-ring-builder \
- /etc/kolla/config/swift/container.builder add r1z1-${node}:6002/d${i} 1;
- done
- done
-
-.. end
-
-Rebalance
----------
-
-To rebalance the ring files:
-
-.. code-block:: console
-
- for ring in object account container; do
- docker run \
- --rm \
- -v /etc/kolla/config/swift/:/etc/kolla/config/swift/ \
- $KOLLA_SWIFT_BASE_IMAGE \
- swift-ring-builder \
- /etc/kolla/config/swift/${ring}.builder rebalance;
- done
-
-For more information, see :swift-doc:`the Swift documentation
-<install/initial-rings.html>`.
-
-Deploying
-~~~~~~~~~
-
-Enable Swift in ``/etc/kolla/globals.yml``:
-
-.. code-block:: yaml
-
- enable_swift : "yes"
-
-If you are to deploy multiple policies, override the variable
-``swift_extra_ring_files`` with the list of your custom ring files, .builder
-and .ring.gz all together. This will append them to the list of default rings.
-
-.. code-block:: yaml
-
- swift_extra_ring_files:
- - object-1.builder
- - object-1.ring.gz
-
-Once the rings are in place, deploying Swift is the same as any other Kolla
-Ansible service:
-
-.. code-block:: console
-
- # kolla-ansible deploy -i <path/to/inventory-file>
-
-Verification
-~~~~~~~~~~~~
-
-A very basic smoke test:
-
-.. code-block:: console
-
- $ openstack container create mycontainer
-
- +---------------------------------------+--------------+------------------------------------+
- | account | container | x-trans-id |
- +---------------------------------------+--------------+------------------------------------+
- | AUTH_7b938156dba44de7891f311c751f91d8 | mycontainer | txb7f05fa81f244117ac1b7-005a0e7803 |
- +---------------------------------------+--------------+------------------------------------+
-
- $ openstack object create mycontainer README.rst
-
- +---------------+--------------+----------------------------------+
- | object | container | etag |
- +---------------+--------------+----------------------------------+
- | README.rst | mycontainer | 2634ecee0b9a52ba403a503cc7d8e988 |
- +---------------+--------------+----------------------------------+
-
- $ openstack container show mycontainer
-
- +--------------+---------------------------------------+
- | Field | Value |
- +--------------+---------------------------------------+
- | account | AUTH_7b938156dba44de7891f311c751f91d8 |
- | bytes_used | 6684 |
- | container | mycontainer |
- | object_count | 1 |
- +--------------+---------------------------------------+
-
- $ openstack object store account show
-
- +------------+---------------------------------------+
- | Field | Value |
- +------------+---------------------------------------+
- | Account | AUTH_7b938156dba44de7891f311c751f91d8 |
- | Bytes | 6684 |
- | Containers | 1 |
- | Objects | 1 |
- +------------+---------------------------------------+
-
-S3 API
-~~~~~~
-
-The Swift S3 API can be enabled by setting ``enable_swift_s3api`` to ``true``
-in ``globals.yml``. It is disabled by default. In order to use this API it is
-necessary to obtain EC2 credentials from Keystone. See the :swift-doc:`the
-Swift documentation
-<admin/middleware.html#module-swift.common.middleware.s3api.s3api>` for
-details.
-
-Swift Recon
-~~~~~~~~~~~
-
-Enable Swift Recon in ``/etc/kolla/globals.yml``:
-
-.. code-block:: yaml
-
- enable_swift_recon : "yes"
-
-
-The Swift role in Kolla Ansible is still using the old role format. Unlike many
-other Kolla Ansible roles, it won't automatically add the new volume to the
-containers in existing deployments when running `kolla-ansible reconfigure`.
-Instead we must use the `kolla-ansible upgrade` command, which will remove the
-existing containers and then put them back again.
-
-Example usage:
-
-.. code-block:: console
-
- $ sudo docker exec swift_object_server swift-recon --all`
-
-
-
-For more information, see :swift-doc:`the Swift documentation
-<admin/objectstorage-monitoring.html>`.