Asynchronous updating of consul with zope configration
Project description
collective.zopeconsul enables asynchronous sending of zope configuration to consul. It sends the VHM domain information to consul along with port and ip address of this instance. It can also be used to set key/value pairs from buildout config options or environment variables.
Configuration
zopeconsul can be configured by adding the following to your buildout:
[instance]
eggs = collective.zopeconsul
zope-conf-additional =
<product-config zopeconsul>
consul_url http://localhost:8500
consul_prefix zope
consul_key_somename somevalue
</product-config>
Any configuration option can be overridden by an environment variable:
$ export CONSUL_URL=http://localhost:8500
$ export CONSUL_KEY_SOMENAME=somevalue
Configuration options
- consul_url
Url of the consul server to connect to. Default: http://localhost:8500
- consul_prefix
When setting key/values, this is the base key from which all values are set. Default: zope
- consul_instancename
Gives a name to the instance. Instead of values being placed in <consul_prefix>, they are placed in <consul_prefix>/instances/<instance_name> on the consul server. Useful when there are multiple instances being orchestrated from consul. Default: unset
- consul_key_[name]
Allows to set arbitrary key values with any name. Example: ``consul_key_somekey = somevalue``
- consul_ignore
Skips setting consul key values. Useful if you have multiple instances that share the same code. You can set this value on specific instances and no key/values will be set in consul.
- consul_ignorevhm
Skips individual VHM hosts from being set. This should match the first part of the vhm string (i.e. before /VirtualHostBase) e.g. CONSUL_IGNOREVHM=”test.localhost,test2.localhost” which will prevent either of the corresponding vhm values being set in consul.
Changelog
0.3 (2024-09-23)
Create new CONSUL_IGNOREVHM option [instification]
Only update VHM values if they differ from consul [instification]
0.2 (2021-09-16)
Add Python3 compatibility [instification]
0.1 (2018-02-01)
Initial setup and vhm monkeypatching [djay]
Addition of zope-additional-configuration option [instification]
Addition of key/value pairs to consul [instification]
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file collective_zopeconsul-0.3.tar.gz
.
File metadata
- Download URL: collective_zopeconsul-0.3.tar.gz
- Upload date:
- Size: 9.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.10.15
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8ecd6971e0ee1a4502a9277b18698d40e2dc29669ff7f2f163be49a9c9e63cb6 |
|
MD5 | 49e42d9d756f7180a0f460f01329e0a8 |
|
BLAKE2b-256 | 20dd264c7532e4521fb8f5e3a17d02a26b1f6fa99271d0a65d40da584b7c0243 |
File details
Details for the file collective.zopeconsul-0.3-py3-none-any.whl
.
File metadata
- Download URL: collective.zopeconsul-0.3-py3-none-any.whl
- Upload date:
- Size: 7.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.10.15
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | fc884ea9c8ef680aad9ed066595ccf88d754918fb52289b31bc68a9ce9d8afa2 |
|
MD5 | 49dbde4bd288fc67713e2a259fe81c3a |
|
BLAKE2b-256 | 430f8a05f0df8158c398f0d8300750da288f03b9cb953a0f4eb140c0fee79034 |