Package: octodns-ns1
NS1 provider for octoDNSAnoctoDNSprovider that targetsNS1.InstallationCommand linepip install octodns-ns1requirements.txt/setup.pyPinning 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-ns1==0.0.1SHAs# 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-ns1.git@ec9661f8b335241ae4746eea467a8509205e6a30#egg=octodns_ns1Configurationproviders:ns1:class:octodns_ns1.Ns1Providerapi_key:env/NS1_API_KEY# Only required if using dynamic recordsmonitor_regions:-lga# Optional. Default: false. true is Recommended, but not the default# for backwards compatibility reasons. If true, all NS1 monitors will# use a shared notify list rather than one per record & value# combination. See CHANGELOG,# https://github.com/octodns/octodns/blob/master/CHANGELOG.md, for more# information before enabling this behavior.shared_notifylist:false# Optional. Default: None. If set, back off in advance to avoid 429s# from rate-limiting. Generally this should be set to the number# of processes or workers hitting the API, e.g. the value of# `max_workers`.parallelism:11# Optional. Default: 4. Number of times to retry if a 429 response# is received.retry_count:4# Optional. Default: None. Additional options or overrides passed to# the NS1 SDK config, as key-value pairs.client_config:endpoint:my.nsone.endpoint# Default: api.nsone.netignore-ssl-errors:true# Default: falsefollow_pagination:false# Default: true# Optional. Default: false. Use modern HTTP monitor (true) or the legacy# HTTP-emulating TCP monitor (false) for HTTP(s) healthchecks.use_http_monitors:false# Optional. Default: HTTP/1.0. Default HTTP protocol to use when# health-checking dynamic record endpoints. See "Health Check Options"# README section below to override per dynamic record.# This is only supported when use_http_monitors is set to false. If it# is set to true, HTTP/1.1 will be used and it cannot be changed.default_healthcheck_http_version:HTTP/1.0Support InformationRecordsAll octoDNS record types are supported.Root NS RecordsNs1Provider supports full root NS record management.DynamicNs1Provider supports dynamic records.Subnet targetingNs1Provider supportssubnet targetingin dynamic records.Health Check OptionsSeehttps://github.com/octodns/octodns/blob/master/docs/dynamic_records.md#health-checksfor information on health checking for dynamic records. Ns1Provider supports the following options:KeyDescriptionDefaultpolicyOne of:all- down if every region is downquorum- down if majority regions are downone- down if any region is downquorumfrequencyFrequency (in seconds) of health-check60connect_timeoutTimeout (in seconds) before we give up trying to connect2response_timeoutTimeout (in seconds) after connecting to wait for output10rapid_recheckEnable or disable a second, automatic verification test before changing the status of a host. Enabling this option can help prevent false positives.Falsehttp_versionSpecify HTTP version to use when HTTP health-checking a host. Only applicable ifuse_http_monitors=False. One ofHTTP/1.0HTTP/1.1HTTP/1.0---octodns:ns1:healthcheck:policy:quorumfrequency:60connect_timeout:2response_timeout:10rapid_recheck:Truehttp_version:HTTP/1.1DevelopmentSee the/script/directory for some tools to help with the development process. They generally follow theScript to rule them allpattern. Most useful is./script/bootstrapwhich 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.