## ConstellixProvider provider for octoDNS
An [octoDNS](https://github.com/octodns/octodns/) provider that targets [Constellix](https://constellix.com/).
### Installation
#### Command line
```
pip install octodns-constellix
```
#### requirements.txt/setup.py
Pinning specific versions or SHAs is recommended to avoid unplanned upgrades.
##### Versions
```
# Start with the latest versions and don't just copy what's here
octodns==0.9.14
octodns-constellix==0.0.1
```
##### SHAs
```
# Start with the latest/specific versions and don't just copy what's here
-e git+https://git@github.com/octodns/octodns.git@9da19749e28f68407a1c246dfdf65663cdc1c422#egg=octodns
-e git+https://git@github.com/octodns/octodns-constellix.git@ec9661f8b335241ae4746eea467a8509205e6a30#egg=octodns_constellix
```
### Configuration
```yaml
providers:
constellix:
class: octodns_constellix.ConstellixProvider
# Your Contellix api key (required)
api_key: env/CONSTELLIX_API_KEY
# Your Constellix secret key (required)
secret_key: env/CONSTELLIX_SECRET_KEY
# Amount of time to wait between requests to avoid
# ratelimit (optional)
ratelimit_delay: 0.0
```
### Support Information
#### Records
ConstellixProvider supports A, AAAA, ALIAS (ANAME), CAA, CNAME, MX, NS, PTR, SPF, SRV, and TXT. There are some restrictions on CAA tags support.
#### Dynamic
ConstellixProvider supports dynamic records.
#### Health Check Options
See https://github.com/octodns/octodns/blob/master/docs/dynamic_records.md#health-checks for information on health checking for dynamic records. ConstellixProvider supports the following options:
| Key | Description | Default |
|--|--|--|
| sonar_interval | Sonar check interval | ONEMINUTE |
| sonar_port | Sonar check port | 80 |
| sonar_regions | Sonar check regions for a check. WORLD or a list of values | WORLD |
| sonar_type | Sonar check type TCP/HTTP | TCP |
Sonar check interval (sonar_interval) possible values:
* FIVESECONDS
* THIRTYSECONDS
* ONEMINUTE
* TWOMINUTES
* THREEMINUTES
* FOURMINUTES
* FIVEMINUTES
* TENMINUTES
* THIRTYMINUTES
* HALFDAY
* DAY
Sonar check regions (sonar_regions) possible values:
* ASIAPAC
* EUROPE
* NACENTRAL
* NAEAST
* NAWEST
* OCEANIA
* SOUTHAMERICA
```yaml
---
octodns:
constellix:
healthcheck:
sonar_interval: DAY
sonar_port: 80
sonar_regions:
- ASIAPAC
- EUROPE
sonar_type: TCP
```
### Development
See the [/script/](/script/) directory for some tools to help with the development process. They generally follow the [Script to rule them all](https://github.com/github/scripts-to-rule-them-all) pattern. Most useful is `./script/bootstrap` which will create a venv and install both the runtime and development related requirements. It will also hook up a pre-commit hook that covers most of what's run by CI.
Raw data
{
"_id": null,
"home_page": "https://github.com/octodns/octodns-constellix",
"name": "octodns-constellix",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "Ross McFarland",
"author_email": "rwmcfa1@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/7f/5b/be0fb0546e864c2fab8f3976b460b86db9f48bc3b50cc65364072c27adb9/octodns-constellix-0.0.4.tar.gz",
"platform": null,
"description": "## ConstellixProvider provider for octoDNS\n\nAn [octoDNS](https://github.com/octodns/octodns/) provider that targets [Constellix](https://constellix.com/).\n\n### Installation\n\n#### Command line\n\n```\npip install octodns-constellix\n```\n\n#### requirements.txt/setup.py\n\nPinning specific versions or SHAs is recommended to avoid unplanned upgrades.\n\n##### Versions\n\n```\n# Start with the latest versions and don't just copy what's here\noctodns==0.9.14\noctodns-constellix==0.0.1\n```\n\n##### SHAs\n\n```\n# Start with the latest/specific versions and don't just copy what's here\n-e git+https://git@github.com/octodns/octodns.git@9da19749e28f68407a1c246dfdf65663cdc1c422#egg=octodns\n-e git+https://git@github.com/octodns/octodns-constellix.git@ec9661f8b335241ae4746eea467a8509205e6a30#egg=octodns_constellix\n```\n\n### Configuration\n\n```yaml\nproviders:\n constellix:\n class: octodns_constellix.ConstellixProvider\n # Your Contellix api key (required)\n api_key: env/CONSTELLIX_API_KEY\n # Your Constellix secret key (required)\n secret_key: env/CONSTELLIX_SECRET_KEY\n # Amount of time to wait between requests to avoid\n # ratelimit (optional)\n ratelimit_delay: 0.0\n```\n\n### Support Information\n\n#### Records\n\nConstellixProvider supports A, AAAA, ALIAS (ANAME), CAA, CNAME, MX, NS, PTR, SPF, SRV, and TXT. There are some restrictions on CAA tags support.\n\n#### Dynamic\n\nConstellixProvider supports dynamic records.\n\n#### Health Check Options\n\nSee https://github.com/octodns/octodns/blob/master/docs/dynamic_records.md#health-checks for information on health checking for dynamic records. ConstellixProvider supports the following options:\n\n| Key | Description | Default |\n|--|--|--|\n| sonar_interval | Sonar check interval | ONEMINUTE |\n| sonar_port | Sonar check port | 80 |\n| sonar_regions | Sonar check regions for a check. WORLD or a list of values | WORLD |\n| sonar_type | Sonar check type TCP/HTTP | TCP |\n\nSonar check interval (sonar_interval) possible values:\n\n* FIVESECONDS\n* THIRTYSECONDS\n* ONEMINUTE\n* TWOMINUTES\n* THREEMINUTES\n* FOURMINUTES\n* FIVEMINUTES\n* TENMINUTES\n* THIRTYMINUTES\n* HALFDAY\n* DAY\n\nSonar check regions (sonar_regions) possible values:\n\n* ASIAPAC\n* EUROPE\n* NACENTRAL\n* NAEAST\n* NAWEST\n* OCEANIA\n* SOUTHAMERICA\n\n```yaml\n---\n octodns:\n constellix:\n healthcheck:\n sonar_interval: DAY\n sonar_port: 80\n sonar_regions:\n - ASIAPAC\n - EUROPE\n sonar_type: TCP\n```\n\n### Development\n\nSee the [/script/](/script/) directory for some tools to help with the development process. They generally follow the [Script to rule them all](https://github.com/github/scripts-to-rule-them-all) pattern. Most useful is `./script/bootstrap` which will create a venv and install both the runtime and development related requirements. It will also hook up a pre-commit hook that covers most of what's run by CI.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "ConstellixProvider provider for octoDNS",
"version": "0.0.4",
"project_urls": {
"Homepage": "https://github.com/octodns/octodns-constellix"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7cdd31cc34fe31946ac8a2cb9e02e4e9c83d27b15cf5a3ea71513d358c7e85aa",
"md5": "04200f44846a5d97e4fba71d7f392025",
"sha256": "2f640175776efdaa6de61bc748120c615f24a610f493787e20a148905e17af7b"
},
"downloads": -1,
"filename": "octodns_constellix-0.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "04200f44846a5d97e4fba71d7f392025",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 11341,
"upload_time": "2023-09-24T19:24:40",
"upload_time_iso_8601": "2023-09-24T19:24:40.875984Z",
"url": "https://files.pythonhosted.org/packages/7c/dd/31cc34fe31946ac8a2cb9e02e4e9c83d27b15cf5a3ea71513d358c7e85aa/octodns_constellix-0.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7f5bbe0fb0546e864c2fab8f3976b460b86db9f48bc3b50cc65364072c27adb9",
"md5": "2787d1f11727918bd4c536aa854e4963",
"sha256": "042daa3c9e3da984bed06b22bb983a91809d45aceb965abfb9c210f5af14fa01"
},
"downloads": -1,
"filename": "octodns-constellix-0.0.4.tar.gz",
"has_sig": false,
"md5_digest": "2787d1f11727918bd4c536aa854e4963",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 20988,
"upload_time": "2023-09-24T19:24:42",
"upload_time_iso_8601": "2023-09-24T19:24:42.250073Z",
"url": "https://files.pythonhosted.org/packages/7f/5b/be0fb0546e864c2fab8f3976b460b86db9f48bc3b50cc65364072c27adb9/octodns-constellix-0.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-24 19:24:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "octodns",
"github_project": "octodns-constellix",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "octodns-constellix"
}
JSON
