--- title: Charmhub | Deploy Swift Proxy using Charmhub - The Open Operator Collection description: Deploy the latest version of Swift Proxy on any cloud. url: https://charmhub.io/swift-proxy/configurations --- # Swift Proxy [OpenStack Charmers](https://charmhub.io/publisher/openstack-charmers "View all packages from OpenStack Charmers") * [OpenStack Charmers](https://charmhub.io/publisher/openstack-charmers "View all packages from OpenStack Charmers") * [Cloud](https://charmhub.io/?filter=cloud) * [Networking](https://charmhub.io/?filter=networking) Platform: 24.04 23.10 23.04 22.10 22.04 20.04 18.04 14.04 12.04 yoga/stable 180 ``` juju deploy swift-proxy --channel yoga/stable ``` [Learn to deploy on juju >](https://juju.is/docs/juju/manage-applications) * [action-managed-upgrade](https://charmhub.io/swift-proxy/configurations#action-managed-upgrade) * [auth-type](https://charmhub.io/swift-proxy/configurations#auth-type) * [bind-port](https://charmhub.io/swift-proxy/configurations#bind-port) * [debug](https://charmhub.io/swift-proxy/configurations#debug) * [delay-auth-decision](https://charmhub.io/swift-proxy/configurations#delay-auth-decision) * [disable-ring-balance](https://charmhub.io/swift-proxy/configurations#disable-ring-balance) * [dns-ha](https://charmhub.io/swift-proxy/configurations#dns-ha) * [enable-multi-region](https://charmhub.io/swift-proxy/configurations#enable-multi-region) * [ha-bindiface](https://charmhub.io/swift-proxy/configurations#ha-bindiface) * [ha-mcastport](https://charmhub.io/swift-proxy/configurations#ha-mcastport) * [haproxy-client-timeout](https://charmhub.io/swift-proxy/configurations#haproxy-client-timeout) * [haproxy-connect-timeout](https://charmhub.io/swift-proxy/configurations#haproxy-connect-timeout) * [haproxy-queue-timeout](https://charmhub.io/swift-proxy/configurations#haproxy-queue-timeout) * [haproxy-server-timeout](https://charmhub.io/swift-proxy/configurations#haproxy-server-timeout) * [harden](https://charmhub.io/swift-proxy/configurations#harden) * [keystone-admin-password](https://charmhub.io/swift-proxy/configurations#keystone-admin-password) * [keystone-admin-tenant-name](https://charmhub.io/swift-proxy/configurations#keystone-admin-tenant-name) * [keystone-admin-user](https://charmhub.io/swift-proxy/configurations#keystone-admin-user) * [keystone-auth-host](https://charmhub.io/swift-proxy/configurations#keystone-auth-host) * [keystone-auth-port](https://charmhub.io/swift-proxy/configurations#keystone-auth-port) * [keystone-auth-protocol](https://charmhub.io/swift-proxy/configurations#keystone-auth-protocol) * [log-headers](https://charmhub.io/swift-proxy/configurations#log-headers) * [min-hours](https://charmhub.io/swift-proxy/configurations#min-hours) * [nagios\_context](https://charmhub.io/swift-proxy/configurations#nagios_context) * [nagios\_servicegroups](https://charmhub.io/swift-proxy/configurations#nagios_servicegroups) * [node-timeout](https://charmhub.io/swift-proxy/configurations#node-timeout) * [openstack-origin](https://charmhub.io/swift-proxy/configurations#openstack-origin) * [operator-roles](https://charmhub.io/swift-proxy/configurations#operator-roles) * [os-admin-hostname](https://charmhub.io/swift-proxy/configurations#os-admin-hostname) * [os-admin-network](https://charmhub.io/swift-proxy/configurations#os-admin-network) * [os-internal-hostname](https://charmhub.io/swift-proxy/configurations#os-internal-hostname) * [os-internal-network](https://charmhub.io/swift-proxy/configurations#os-internal-network) * [os-public-hostname](https://charmhub.io/swift-proxy/configurations#os-public-hostname) * [os-public-network](https://charmhub.io/swift-proxy/configurations#os-public-network) * [partition-power](https://charmhub.io/swift-proxy/configurations#partition-power) * [prefer-ipv6](https://charmhub.io/swift-proxy/configurations#prefer-ipv6) * [rabbit-user](https://charmhub.io/swift-proxy/configurations#rabbit-user) * [rabbit-vhost](https://charmhub.io/swift-proxy/configurations#rabbit-vhost) * [read-affinity](https://charmhub.io/swift-proxy/configurations#read-affinity) * [recoverable-node-timeout](https://charmhub.io/swift-proxy/configurations#recoverable-node-timeout) * [region](https://charmhub.io/swift-proxy/configurations#region) * [replicas](https://charmhub.io/swift-proxy/configurations#replicas) * [replicas-account](https://charmhub.io/swift-proxy/configurations#replicas-account) * [replicas-container](https://charmhub.io/swift-proxy/configurations#replicas-container) * [ssl\_ca](https://charmhub.io/swift-proxy/configurations#ssl_ca) * [ssl\_cert](https://charmhub.io/swift-proxy/configurations#ssl_cert) * [ssl\_key](https://charmhub.io/swift-proxy/configurations#ssl_key) * [static-large-object-segments](https://charmhub.io/swift-proxy/configurations#static-large-object-segments) * [statsd-host](https://charmhub.io/swift-proxy/configurations#statsd-host) * [statsd-port](https://charmhub.io/swift-proxy/configurations#statsd-port) * [statsd-sample-rate](https://charmhub.io/swift-proxy/configurations#statsd-sample-rate) * [swauth-admin-key](https://charmhub.io/swift-proxy/configurations#swauth-admin-key) * [swift-hash](https://charmhub.io/swift-proxy/configurations#swift-hash) * [use-policyd-override](https://charmhub.io/swift-proxy/configurations#use-policyd-override) * [vip](https://charmhub.io/swift-proxy/configurations#vip) * [workers](https://charmhub.io/swift-proxy/configurations#workers) * [write-affinity](https://charmhub.io/swift-proxy/configurations#write-affinity) * [write-affinity-node-count](https://charmhub.io/swift-proxy/configurations#write-affinity-node-count) * [zone-assignment](https://charmhub.io/swift-proxy/configurations#zone-assignment) [Learn about configurations >](https://juju.is/docs/juju/configuration#heading--application-configuration) * action-managed-upgrade | boolean If True enables openstack upgrades for this charm via juju actions. You will still need to set openstack-origin to the new repository but instead of an upgrade running automatically across all units, it will wait for you to execute the openstack-upgrade action for this charm on each unit. If False it will revert to existing behavior of upgrading all units on config change. * auth-type | string Default: tempauth Auth method to use, tempauth, swauth or keystone. Note that swauth is not supported for OpenStack Train and later. * bind-port | int Default: 8080 TCP port to listen on. * debug | boolean Enable debug level logging. * delay-auth-decision | boolean Default: True Delay authentication to downstream WSGI services. * disable-ring-balance | boolean This provides similar support to min-hours but without having to modify the builders. If True, any changes to the builders will not result in a ring re-balance and sync until this value is set back to False. * dns-ha | boolean Use DNS HA with MAAS 2.0. Note if this is set do not set vip settings below. * enable-multi-region | boolean Enables Swift Global Cluster feature as described at https://docs.openstack.org/swift/latest/overview\_global\_cluster.html Should be used in conjunction with 'read-affinity', 'write-affinity' and 'write-affinity-node-count' options. * ha-bindiface | string Default: eth0 Default network interface on which HA cluster will bind to communication with the other members of the HA Cluster. * ha-mcastport | int Default: 5414 Default multicast port number that will be used to communicate between HA Cluster nodes. * haproxy-client-timeout | int Client timeout configuration in ms for haproxy, used in HA configurations. If not provided, default value of 90000ms is used. * haproxy-connect-timeout | int Connect timeout configuration in ms for haproxy, used in HA configurations. If not provided, default value of 9000ms is used. * haproxy-queue-timeout | int Queue timeout configuration in ms for haproxy, used in HA configurations. If not provided, default value of 9000ms is used. * haproxy-server-timeout | int Server timeout configuration in ms for haproxy, used in HA configurations. If not provided, default value of 90000ms is used. * harden | string Apply system hardening. Supports a space-delimited list of modules to run. Supported modules currently include os, ssh, apache and mysql. * keystone-admin-password | string Keystone admin password * keystone-admin-tenant-name | string Default: service Keystone admin tenant name * keystone-admin-user | string Keystone admin username * keystone-auth-host | string Keystone authentication host * keystone-auth-port | int Default: 35357 Keystone authentication port * keystone-auth-protocol | string Default: http Keystone authentication protocol * log-headers | boolean Enable logging of all request headers. * min-hours | int This is the Swift ring builder min\_part\_hours parameter. This setting represents the amount of time in hours that Swift will wait between subsequent ring re-balances in order to avoid large i/o loads as data is re-balanced when new devices are added to the cluster. Once your cluster has been built, you can set this to a higher value e.g. 1 (upstream default). Note that changing this value will result in an attempt to re-balance and if successful, rings will be redistributed. * nagios\_context | string Default: juju Used by the nrpe-external-master subordinate charm. A string that will be prepended to instance name to set the host name in nagios. So for instance the hostname would be something like 'juju-myservice-0'. If you are running multiple environments with the same services in them this allows you to differentiate between them. * nagios\_servicegroups | string A comma-separated list of nagios servicegroups. If left empty, the nagios\_context will be used as the servicegroup. * node-timeout | int Default: 60 How long the proxy server will wait on responses from the account/container/object servers. * openstack-origin | string Default: yoga Repository from which to install. May be one of the following: distro (default), ppa:somecustom/ppa, a deb url sources entry, or a supported Ubuntu Cloud Archive e.g. . cloud:- cloud:-/updates cloud:-/staging cloud:-/proposed . See https://wiki.ubuntu.com/OpenStack/CloudArchive for info on which cloud archives are available and supported. . NOTE: updating this setting to a source that is known to provide a later version of OpenStack will trigger a software upgrade unless action-managed-upgrade is set to True. * operator-roles | string Default: Member,Admin Comma-separated list of Swift operator roles. * os-admin-hostname | string The hostname or address of the admin endpoints created for swift-proxy in the keystone identity provider. . This value will be used for admin endpoints. For example, an os-admin-hostname set to 'files.admin.example.com' with will create the following admin endpoint for the swift-proxy: . https://files.admin.example.com:80/swift/v1 * os-admin-network | string The IP address and netmask of the OpenStack Admin network (e.g. 192.168.0.0/24) . This network will be used for admin endpoints. * os-internal-hostname | string The hostname or address of the internal endpoints created for swift-proxy in the keystone identity provider. . This value will be used for internal endpoints. For example, an os-internal-hostname set to 'files.internal.example.com' with will create the following internal endpoint for the swift-proxy: . https://files.internal.example.com:80/swift/v1 * os-internal-network | string The IP address and netmask of the OpenStack Internal network (e.g. 192.168.0.0/24) . This network will be used for internal endpoints. * os-public-hostname | string The hostname or address of the public endpoints created for swift-proxy in the keystone identity provider. This value will be used for public endpoints. For example, an os-public-hostname set to 'files.example.com' with will create the following public endpoint for the swift-proxy: https://files.example.com:80/swift/v1 * os-public-network | string The IP address and netmask of the OpenStack Public network (e.g., 192.168.0.0/24) . This network will be used for public endpoints. * partition-power | int Default: 16 This value needs to be set according to the parameters of the cluster being deployed. In order to achieve an optimal distribution of objects within your cluster without over consuming system resources it is important that this value not be too low or high but it must also be high enough to account for future expansion of your cluster since it cannot be changed once the rings have been built. A rough calculation for this value should be no less than log2(total\_disks \* 100). * prefer-ipv6 | boolean If True enables IPv6 support. The charm will expect network interfaces to be configured with an IPv6 address. If set to False (default) IPv4 is expected. . NOTE: these charms do not currently support IPv6 privacy extension. In order for this charm to function correctly, the privacy extension must be disabled and a non-temporary address must be configured/available on your network interface. * rabbit-user | string Default: swift Username used to access rabbitmq queue. * rabbit-vhost | string Default: openstack Rabbitmq vhost name. * read-affinity | string Which backend servers to prefer on reads. Format is r for region N or rz for region N, zone M. The value after the equals is the priority; lower numbers are higher priority. . For example first read from region 1 zone 1, then region 1 zone 2, then anything in region 2, then everything else - read\_affinity = r1z1=100, r1z2=200, r2=300 . Default is empty, meaning no preference. . NOTE: use only when 'enable-multi-region=True' * recoverable-node-timeout | int Default: 30 How long the proxy server will wait for an initial response and to read a chunk of data from the object servers while serving GET / HEAD requests. Timeouts from these requests can be recovered from so setting this to something lower than node-timeout would provide quicker error recovery while allowing for a longer timeout for non-recoverable requests (PUTs). * region | string Default: RegionOne OpenStack region that this swift-proxy supports. * replicas | int Default: 3 Minimum replicas for each item stored in the cluster. * replicas-account | int Minimum replicas for each account stored in the cluster. . NOTE: use only when you want to overwrite the global 'replicas' option. * replicas-container | int Minimum replicas for each container stored in the cluster. . NOTE: use only when you want to overwrite the global 'replicas' option. * ssl\_ca | string Base64-encoded SSL CA to use with the certificate and key provided - only required if you are providing a privately signed ssl\_cert and ssl\_key. * ssl\_cert | string Base64 encoded SSL certificate to install and use for API ports. . juju config swift-proxy ssl\_cert="$(cat cert | base64)" ssl\_key="$(cat key | base64)" . Setting this value (and ssl\_key) will enable reverse proxying, point Swifts's entry in the Keystone catalog to use https, and override any certficiate and key issued by Keystone (if it is configured to do so). * ssl\_key | string Base64 encoded SSL key to use with certificate specified as ssl\_cert. * static-large-object-segments | int Enable Static Large Objects (SLO) support. This allows the user to upload several object segments concurrently, after which a manifest is uploaded that describes how to concatenate them, enabling a single large object to be downloaded. . This option sets the maximum number of object segments allowed per large object, allowing control over the maximum large object size. The default minimum segment size is 1MB, while the maximum segment size corresponds to the largest object swift is configured to support (5GB by default). . Ex. Setting this to 1000 would allow up to 1000 5GB object segments to be uploaded for a maximum large object size of 5TB. * statsd-host | string Enable statsd metrics to be sent to the specified host. If this value is empty, statsd logging will be disabled. * statsd-port | int Default: 3125 Destination port on the provided statsd host to send samples to. Only takes effect if statsd-host is set. * statsd-sample-rate | float Default: 1.0 Sample rate determines what percentage of the metric points a client should send to the server. Only takes effect if statsd-host is set. * swauth-admin-key | string The secret key to use to authenticate as an swauth admin Note that swauth is not supported for OpenStack Train and later. * swift-hash | string Hash to use across all swift-proxy servers - don't lose * use-policyd-override | boolean If True then use the resource file named 'policyd-override' to install override YAML files in the service's policy.d directory. The resource file should be a ZIP file containing at least one yaml file with a .yaml or .yml extension. If False then remove the overrides. * vip | string Virtual IP(s) to use to front API services in HA configuration. . If multiple networks are being used, a VIP should be provided for each network, separated by spaces. * workers | int Number of TCP workers to launch (0 for the number of system cores). * write-affinity | string This setting lets you trade data distribution for throughput. It makes the proxy server prefer local back-end servers for object PUT requests over non-local ones. Note that only object PUT requests are affected by the write\_affinity setting; POST, GET, HEAD, DELETE, OPTIONS, and account/container PUT requests are not affected. The format is r for region N. If this is set, then when handling an object PUT request, some number (see the write\_affinity\_node\_count setting) of local backend servers will be tried before any nonlocal ones. . For example try to write to regions 1 and 2 before writing to any other nodes - write\_affinity = r1, r2 . NOTE: use only when 'enable-multi-region=True' * write-affinity-node-count | string This setting is only useful in conjunction with write\_affinity; it governs how many local object servers will be tried before falling back to non-local ones. . For example assuming 3 replicas and 'write-affinity: r1' then 'write-affinity-node-count: 2 \* replicas' will make object PUTs try storing the object’s replicas on up to 6 disks. . NOTE: use only when 'enable-multi-region=True' * zone-assignment | string Default: manual Which policy to use when assigning new storage nodes to zones. . manual - Allow swift-storage services to request zone membership. auto - Assign new swift-storage units to zones automatically. . The configured replica minimum must be met by an equal number of storage zones before the storage ring will be initially balance. Deployment requirements differ based on the zone-assignment policy configured, see this charm's README for details.