[](https://travis-ci.org/joeblackwaslike/couchdiscover) [](https://github.com/joeblackwaslike/couchdiscover) [](https://pypi.python.org/pypi/couchdiscover) [](https://pypi.python.org/pypi/couchdiscover) [](https://pypi.python.org/pypi/couchdiscover) [](https://pypi.python.org/pypi/couchdiscover) [](https://hub.docker.com/r/joeblackwaslike/couchdiscover/)
## Maintainer
Joe Black | <me@joeblack.nyc> | [github](https://github.com/joeblackwaslike)
## Description
Utilizes the Kubernetes and CouchDB 2.0 clustering API's for automating the process of creating a CouchDB 2.0 Cluster. The reqirements here vary significantly compared to the predecessor BigCouch.
This module has an entrypoint stub called `couchdiscover` that will be created upon installation with setuptools.
This tool is meant to be used in a kubernetes cluster as a sidecar container.
## Environment variables used by couchdiscover:
### `couchdb` container:
* `COUCHDB_ADMIN_USER`: username to use when enabling the node, required.
* `COUCHDB_ADMIN_PASS`: password to use when enabling the node, required.
* `ERLANG_COOKIE`: cookie value to use as the `.erlang.cookie`, not required, fails back to insecure cookie value when not set.
* `COUCHDB_CLUSTER_SIZE`: not required, overrides the value of `spec.replicas` in the statefulset, should rarely be necessary to set. Don't set unless you know what you're doing.
### `couchdiscover` container:
* `LOG_LEVEL`: logging level to output container logs for. Defaults to `INFO`, most logs are either INFO or WARNING level.
## How information is discovered
In order to best use something that is essentially "zero configuration," it helps to understand how the necessary information is obtained from the environment and api's.
1. Initially a great deal of information is obtained by grabbing the hostname of the container that's part of a statefulset and parsing it. This is how the namespace is determined, how hostnames are calculated later, the name of the statefulset to look for in the api, the name of the headless service, the node name, the index, whether a node is master or not, etc.
2. The kubernetes api is used to grab the statefulset and entrypoint objects. The entrypoint object is parsed to obtain the `hosts` list. Then the statefulset is parsed for the ports, then the environment is resolved, fetching any externally referenced configmaps or secrets that are necessary. Credentials are resolved by looking through the environment for the keys: `COUCHDB_ADMIN_USER`, `COUCHDB_ADMIN_PASS`. Finally the expected cluster size is set to the number of replicas in the fetched statefulset. You can override this as detailed in the above notes section, but should be completely unnecessary for most cases.
## Main logic
The main logic is performed in the `manage` module's `ClusterManager` object's `run` method. I think most of it is relatively straighforward.
```python
# couchdiscover.manage.ClusterManager
def run(self):
"""Main logic here, this is where we begin once all environment
information has been retrieved."""
log.info('Starting couchdiscover: %s', self.couch)
if self.couch.disabled:
log.info('Cluster disabled, enabling')
self.couch.enable()
elif self.couch.finished:
log.info('Cluster already finished')
self.sleep_forever()
if self.env.first_node:
log.info("Looks like I'm the first node")
if self.env.single_node_cluster:
log.info('Single node cluster detected')
self.couch.finish()
else:
log.info("Looks like I'm not the first node")
self.couch.add_to_master()
if self.env.last_node:
log.info("Looks like I'm the last node")
self.couch.finish()
else:
log.info("Looks like I'm not the last node")
self.sleep_forever()
```
Metadata
Release files for couchdiscover 0.2.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| couchdiscover-0.2.4.tar.gz | 15.3 kB | Without provenance | Details for couchdiscover-0.2.4.tar.gz |
Release files / couchdiscover-0.2.4.tar.gz
| Download URL | couchdiscover-0.2.4.tar.gz |
|---|---|
| Size | 15.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d34e72d6d2c269456f6d6ec9ca121a4f133df7ffc67edd0be411d68ea59ca0d9
|
|
BLAKE2b-256 checksum How to use checksums |
b45599b3dec5d272707f09bec4aa970ea4b3e6d7376dbe564343a8ddadfc0e4c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for couchdiscover 0.2.4
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.