Back to External Dns

Flags

docs/flags.md

0.21.099.5 KB
Original Source

Flags

<!-- THIS FILE MUST NOT BE EDITED BY HAND --> <!-- ON NEW FLAG ADDED PLEASE RUN 'make generate-flags-documentation' --> <!-- markdownlint-disable MD013 -->
FlagDescription
--[no-]versionShow application version.
--server=""The Kubernetes API server to connect to (default: auto-detect)
--[no-]resolve-service-load-balancer-hostnameResolve the hostname of LoadBalancer-type Service object to IP addresses in order to create DNS A/AAAA records instead of CNAMEs
--[no-]listen-endpoint-eventsTrigger a reconcile on changes to EndpointSlices, for Service source (default: false)
--gloo-namespace=gloo-systemThe Gloo Proxy namespace; specify multiple times for multiple namespaces. (default: gloo-system)
--skipper-routegroup-groupversion="zalando.org/v1"The resource version for skipper routegroup
--[no-]always-publish-not-ready-addressesAlways publish also not ready addresses for headless services (optional)
--annotation-filter=""Filter resources queried for endpoints by annotation, using label selector semantics
--annotation-prefix="external-dns.alpha.kubernetes.io/"Annotation prefix for external-dns annotations (default: external-dns.alpha.kubernetes.io/)
--compatibility=Process annotation semantics from legacy implementations (optional, options: mate, molecule, kops-dns-controller)
--connector-source-server="localhost:8080"The server to connect for connector source, valid only when using connector source
--crd-source-apiversion="externaldns.k8s.io/v1alpha1"API version of the CRD for crd source, e.g. externaldns.k8s.io/v1alpha1, valid only when using crd source
--crd-source-kind="DNSEndpoint"Kind of the CRD for the crd source in API group and version specified by crd-source-apiversion
--default-targets=DEFAULT-TARGETSSet globally default host/IP that will apply as a target instead of source addresses. Specify multiple times for multiple targets (optional)
--[no-]force-default-targetsForce the application of --default-targets, overriding any targets provided by the source (DEPRECATED: This reverts to (improved) legacy behavior which allows empty CRD targets for migration to new state)
--[no-]prefer-aliasWhen enabled, CNAME records will have the alias annotation set, signaling providers that support ALIAS records to use them instead of CNAMEs. Supported by: PowerDNS, AWS (with --aws-prefer-cname disabled)
--exclude-record-types=EXCLUDE-RECORD-TYPESRecord types to exclude from management; specify multiple times to exclude many; (optional)
--exclude-target-net=EXCLUDE-TARGET-NETExclude target nets (optional)
--[no-]exclude-unschedulableExclude nodes that are considered unschedulable (default: true)
--[no-]expose-internal-ipv6When using the node source, expose internal IPv6 addresses (optional, default: false)
--gateway-label-filter=""Filter Gateways of Route endpoints via label selector (default: all gateways)
--gateway-name=""Limit Gateways of Route endpoints to a specific name (default: all names)
--gateway-namespace=""Limit Gateways of Route endpoints to a specific namespace (default: all namespaces)
--[no-]gateway-listener-setsEnable ListenerSet support for Gateway API sources (requires Gateway API v1.5+ CRDs) (default: false)
--[no-]ignore-hostname-annotationIgnore hostname annotation when generating DNS names, valid only when --fqdn-template is set (default: false)
--[no-]ignore-ingress-rules-specIgnore the spec.rules section in Ingress resources (default: false)
--[no-]ignore-ingress-tls-specIgnore the spec.tls section in Ingress resources (default: false)
--[no-]ignore-non-host-network-podsIgnore pods not running on host network when using pod source (default: false)
--ingress-class=INGRESS-CLASSRequire an Ingress to have this class name; specify multiple times to allow more than one class (optional; defaults to any class)
--label-filter=""Filter resources queried for endpoints by label selector; currently supported by source types crd, gateway-httproute, gateway-grpcroute, gateway-tlsroute, gateway-tcproute, gateway-udproute, ingress, node, openshift-route, service and ambassador-host
--managed-record-types=A...Record types to manage; specify multiple times to include many; (default: A,AAAA,CNAME) (supported records: A, AAAA, CNAME, NS, SRV, TXT)
--namespace=""Limit resources queried for endpoints to a specific namespace (default: all namespaces)
--nat64-networks=NAT64-NETWORKSAdding an A record for each AAAA record in NAT64-enabled networks; specify multiple times for multiple possible nets (optional)
--openshift-router-name=""if source is openshift-route then you can pass the ingress controller name. Based on this name external-dns will select the respective router from the route status and map that routerCanonicalHostname to the route host while creating a CNAME record.
--pod-source-domain=""Domain to use for pods records (optional)
--[no-]publish-host-ipAllow external-dns to publish host-ip for headless services (optional)
--[no-]publish-internal-servicesAllow external-dns to publish DNS records for ClusterIP services (optional)
--service-type-filter=SERVICE-TYPE-FILTERThe service types to filter by. Specify multiple times for multiple filters to be applied. (optional, default: all, expected: ClusterIP, NodePort, LoadBalancer or ExternalName)
--target-net-filter=TARGET-NET-FILTERLimit possible targets by a net filter; specify multiple times for multiple possible nets (optional)
--[no-]traefik-enable-legacyEnable legacy listeners on Resources under the traefik.containo.us API Group
--[no-]traefik-disable-newDisable listeners on Resources under the traefik.io API Group
--unstructured-resource=UNSTRUCTURED-RESOURCEWhen using the unstructured source, specify resources in resource.version.group format (e.g., virtualmachineinstances.v1.kubevirt.io, configmap.v1); specify multiple times for multiple resources
--events-emit=EVENTS-EMITEvents that should be emitted. Specify multiple times for multiple events support (optional, default: none, expected: RecordReady, RecordDeleted, RecordError)
--provider-cache-time=0sThe time to cache the DNS provider record list requests.
--[no-]create-ptrWhen enabled, automatically create PTR records for A/AAAA records. Per-resource annotations can override this default. The provider must have authority over the reverse DNS zones (e.g. in-addr.arpa). Include reverse zones in --domain-filter.
--domain-filter=Limit possible target zones by a domain suffix; specify multiple times for multiple domains (optional)
--exclude-domains=Exclude subdomains (optional)
--regex-domain-filter=Limit possible domains and target zones by a Regex filter; Overrides domain-filter (optional)
--regex-domain-exclusion=Regex filter that excludes domains and target zones matched by regex-domain-filter (optional)
--zone-name-filter=Filter target zones by zone domain (For now, only AzureDNS provider is using this flag); specify multiple times for multiple zones (optional)
--zone-id-filter=Filter target zones by hosted zone id; specify multiple times for multiple zones (optional)
--google-project=""When using the Google provider, current project is auto-detected, when running on GCP. Specify other project with this. Must be specified when running outside GCP.
--google-batch-change-size=1000When using the Google provider, set the maximum number of changes that will be applied in each batch.
--google-batch-change-interval=1sWhen using the Google provider, set the interval between batch changes.
--google-zone-visibility=When using the Google provider, filter for zones with this visibility (optional, options: public, private)
--alibaba-cloud-config-file="/etc/kubernetes/alibaba-cloud.json"When using the Alibaba Cloud provider, specify the Alibaba Cloud configuration file (required when --provider=alibabacloud)
--alibaba-cloud-zone-type=When using the Alibaba Cloud provider, filter for zones of this type (optional, options: public, private)
--aws-zone-type=When using the AWS provider, filter for zones of this type (optional, default: any, options: public, private)
--aws-zone-tags=When using the AWS provider, filter for zones with these tags
--aws-profile=When using the AWS provider, name of the profile to use
--aws-assume-role=""When using the AWS API, assume this IAM role. Useful for hosted zones in another AWS account. Specify the full ARN, e.g. arn:aws:iam::123455567:role/external-dns (optional)
--aws-assume-role-external-id=""When using the AWS API and assuming a role then specify this external ID` (optional)
--aws-batch-change-size=1000When using the AWS provider, set the maximum number of changes that will be applied in each batch.
--aws-batch-change-size-bytes=32000When using the AWS provider, set the maximum byte size that will be applied in each batch.
--aws-batch-change-size-values=1000When using the AWS provider, set the maximum total record values that will be applied in each batch.
--aws-batch-change-interval=1sWhen using the AWS provider, set the interval between batch changes.
--[no-]aws-evaluate-target-healthWhen using the AWS provider, set whether to evaluate the health of a DNS target (default: enabled, disable with --no-aws-evaluate-target-health)
--aws-api-retries=3When using the AWS API, set the maximum number of retries before giving up.
--[no-]aws-prefer-cnameWhen using the AWS provider, prefer using CNAME instead of ALIAS (default: disabled)
--aws-zones-cache-duration=0sWhen using the AWS provider, set the zones list cache TTL (0s to disable).
--[no-]aws-zone-match-parentExpand limit possible target by sub-domains (default: disabled)
--[no-]aws-sd-service-cleanupWhen using the AWS CloudMap provider, delete empty Services without endpoints (default: disabled)
--aws-sd-create-tag=AWS-SD-CREATE-TAGWhen using the AWS CloudMap provider, add tag to created services. The flag can be used multiple times
--azure-config-file="/etc/kubernetes/azure.json"When using the Azure provider, specify the Azure configuration file (required when --provider=azure)
--azure-resource-group=""When using the Azure provider, override the Azure resource group to use (optional)
--azure-subscription-id=""When using the Azure provider, override the Azure subscription to use (optional)
--azure-user-assigned-identity-client-id=""When using the Azure provider, override the client id of user assigned identity in config file (optional)
--azure-zones-cache-duration=0sWhen using the Azure provider, set the zones list cache TTL (0s to disable).
--azure-maxretries-count=3When using the Azure provider, set the number of retries for API calls (When less than 0, it disables retries). (optional)
--batch-change-size=200Set the maximum number of DNS record changes that will be submitted to the provider in each batch (optional)
--batch-change-interval=1sSet the interval between batch changes (optional, default: 1s)
--[no-]cloudflare-proxiedWhen using the Cloudflare provider, specify if the proxy mode must be enabled (default: disabled)
--[no-]cloudflare-custom-hostnamesWhen using the Cloudflare provider, specify if the Custom Hostnames feature will be used. Requires "Cloudflare for SaaS" enabled. (default: disabled)
--cloudflare-custom-hostnames-min-tls-version=1.0When using the Cloudflare provider with the Custom Hostnames, specify which Minimum TLS Version will be used by default. (default: 1.0, options: 1.0, 1.1, 1.2, 1.3)
--cloudflare-custom-hostnames-certificate-authority=noneWhen using the Cloudflare provider with the Custom Hostnames, specify which Certificate Authority will be used. A value of none indicates no Certificate Authority will be sent to the Cloudflare API (default: none, options: google, ssl_com, lets_encrypt, none)
--cloudflare-dns-records-per-page=100When using the Cloudflare provider, specify how many DNS records listed per page, max possible 5,000 (default: 100)
--[no-]cloudflare-regional-servicesWhen using the Cloudflare provider, specify if Regional Services feature will be used (default: disabled)
--cloudflare-region-key=""When using the Cloudflare provider, specify the default region for Regional Services. Any value other than an empty string will enable the Regional Services feature (optional)
--cloudflare-record-comment=""When using the Cloudflare provider, specify the comment for the DNS records (default: '')
--coredns-prefix="/skydns/"When using the CoreDNS provider, specify the prefix name
--[no-]coredns-strictly-ownedWhen using the CoreDNS provider, store and filter strictly by txt-owner-id using an extra field inside of the etcd service (default: false)
--akamai-serviceconsumerdomain=""When using the Akamai provider, specify the base URL (required when --provider=akamai and edgerc-path not specified)
--akamai-client-token=""When using the Akamai provider, specify the client token (required when --provider=akamai and edgerc-path not specified)
--akamai-client-secret=""When using the Akamai provider, specify the client secret (required when --provider=akamai and edgerc-path not specified)
--akamai-access-token=""When using the Akamai provider, specify the access token (required when --provider=akamai and edgerc-path not specified)
--akamai-edgerc-path=""When using the Akamai provider, specify the .edgerc file path. Path must be reachable form invocation environment. (required when --provider=akamai and *-token, secret serviceconsumerdomain not specified)
--akamai-edgerc-section=""When using the Akamai provider, specify the .edgerc file path (Optional when edgerc-path is specified)
--oci-config-file="/etc/kubernetes/oci.yaml"When using the OCI provider, specify the OCI configuration file (required when --provider=oci
--oci-compartment-ocid=""When using the OCI provider, specify the OCID of the OCI compartment containing all managed zones and records. Required when using OCI IAM instance principal authentication.
--oci-zone-scope=GLOBALWhen using OCI provider, filter for zones with this scope (optional, options: GLOBAL, PRIVATE). Defaults to GLOBAL, setting to empty value will target both.
--[no-]oci-auth-instance-principalWhen using the OCI provider, specify whether OCI IAM instance principal authentication should be used (instead of key-based auth via the OCI config file).
--oci-zones-cache-duration=0sWhen using the OCI provider, set the zones list cache TTL (0s to disable).
--inmemory-zone=Provide a list of pre-configured zones for the inmemory provider; specify multiple times for multiple zones (optional)
--ovh-endpoint="ovh-eu"When using the OVH provider, specify the endpoint (default: ovh-eu)
--ovh-api-rate-limit=20When using the OVH provider, specify the API request rate limit, X operations by seconds (default: 20)
--[no-]ovh-enable-cname-relativeWhen using the OVH provider, specify if CNAME should be treated as relative on target without final dot (default: false)
--pdns-server="http://localhost:8081"When using the PowerDNS/PDNS provider, specify the URL to the pdns server (required when --provider=pdns)
--pdns-server-id="localhost"When using the PowerDNS/PDNS provider, specify the id of the server to retrieve. Should be localhost except when the server is behind a proxy (optional when --provider=pdns) (default: localhost)
--pdns-api-key=""When using the PowerDNS/PDNS provider, specify the API key to use to authorize requests (required when --provider=pdns)
--[no-]pdns-skip-tls-verifyWhen using the PowerDNS/PDNS provider, disable verification of any TLS certificates (optional when --provider=pdns) (default: false)
--ns1-endpoint=""When using the NS1 provider, specify the URL of the API endpoint to target (default: https://api.nsone.net/v1/)
--[no-]ns1-ignoresslWhen using the NS1 provider, specify whether to verify the SSL certificate (default: false)
--ns1-min-ttl=0Minimal TTL (in seconds) for records. This value will be used if the provided TTL for a service/ingress is lower than this.
--godaddy-api-key=""When using the GoDaddy provider, specify the API Key (required when --provider=godaddy)
--godaddy-api-secret=""When using the GoDaddy provider, specify the API secret (required when --provider=godaddy)
--godaddy-api-ttl=0TTL (in seconds) for records. This value will be used if the provided TTL for a service/ingress is not provided.
--[no-]godaddy-api-oteWhen using the GoDaddy provider, use OTE api (optional, default: false, when --provider=godaddy)
--tls-ca=""When using TLS communication, the path to the certificate authority to verify server communications (optionally specify --tls-client-cert for two-way TLS)
--tls-client-cert=""When using TLS communication, the path to the certificate to present as a client (not required for TLS)
--tls-client-cert-key=""When using TLS communication, the path to the certificate key to use with the client certificate (not required for TLS)
--exoscale-apienv="api"When using Exoscale provider, specify the API environment (optional)
--exoscale-apizone="ch-gva-2"When using Exoscale provider, specify the API Zone (optional)
--exoscale-apikey=""Provide your API Key for the Exoscale provider
--exoscale-apisecret=""Provide your API Secret for the Exoscale provider
--rfc2136-host=When using the RFC2136 provider, specify the host of the DNS server (optionally specify multiple times when using --rfc2136-load-balancing-strategy)
--rfc2136-port=0When using the RFC2136 provider, specify the port of the DNS server
--rfc2136-zone=RFC2136-ZONEWhen using the RFC2136 provider, specify zone entry of the DNS server to use (can be specified multiple times)
--[no-]rfc2136-insecureWhen using the RFC2136 provider, specify whether to attach TSIG or not (default: false, requires --rfc2136-tsig-keyname and rfc2136-tsig-secret)
--rfc2136-tsig-keyname=""When using the RFC2136 provider, specify the TSIG key to attached to DNS messages (required when --rfc2136-insecure=false)
--rfc2136-tsig-secret=""When using the RFC2136 provider, specify the TSIG (base64) value to attached to DNS messages (required when --rfc2136-insecure=false)
--rfc2136-tsig-secret-alg=""When using the RFC2136 provider, specify the TSIG (base64) value to attached to DNS messages (required when --rfc2136-insecure=false)
--[no-]rfc2136-tsig-axfrWhen using the RFC2136 provider, specify the TSIG (base64) value to attached to DNS messages (required when --rfc2136-insecure=false)
--rfc2136-min-ttl=0sWhen using the RFC2136 provider, specify minimal TTL (in duration format) for records. This value will be used if the provided TTL for a service/ingress is lower than this
--[no-]rfc2136-gss-tsigWhen using the RFC2136 provider, specify whether to use secure updates with GSS-TSIG using Kerberos (default: false, requires --rfc2136-kerberos-realm, --rfc2136-kerberos-username, and rfc2136-kerberos-password)
--rfc2136-kerberos-username=""When using the RFC2136 provider with GSS-TSIG, specify the username of the user with permissions to update DNS records (required when --rfc2136-gss-tsig=true)
--rfc2136-kerberos-password=""When using the RFC2136 provider with GSS-TSIG, specify the password of the user with permissions to update DNS records (required when --rfc2136-gss-tsig=true)
--rfc2136-kerberos-realm=""When using the RFC2136 provider with GSS-TSIG, specify the realm of the user with permissions to update DNS records (required when --rfc2136-gss-tsig=true)
--rfc2136-batch-change-size=50When using the RFC2136 provider, set the maximum number of changes that will be applied in each batch.
--[no-]rfc2136-use-tlsWhen using the RFC2136 provider, communicate with name server over tls
--[no-]rfc2136-skip-tls-verifyWhen using TLS with the RFC2136 provider, disable verification of any TLS certificates
--rfc2136-load-balancing-strategy=disabledWhen using the RFC2136 provider, specify the load balancing strategy (default: disabled, options: random, round-robin, disabled)
--transip-account=""When using the TransIP provider, specify the account name (required when --provider=transip)
--transip-keyfile=""When using the TransIP provider, specify the path to the private key file (required when --provider=transip)
--pihole-server=""When using the Pihole provider, the base URL of the Pihole web server (required when --provider=pihole)
--pihole-password=""When using the Pihole provider, the password to the server if it is protected
--[no-]pihole-tls-skip-verifyWhen using the Pihole provider, disable verification of any TLS certificates
--pihole-api-version="5"When using the Pihole provider, specify the pihole API version (default: 5, options: 5, 6)
--plural-cluster=""When using the plural provider, specify the cluster name you're running with
--plural-provider=""When using the plural provider, specify the provider name you're running with
--policy=syncModify how DNS records are synchronized between sources and providers (default: sync, options: sync, upsert-only, create-only)
--registry=txtThe registry implementation to use to keep track of DNS record ownership (default: txt, options: txt, noop, dynamodb, aws-sd)
--txt-owner-id="default"When using the TXT or DynamoDB registry, a name that identifies this instance of ExternalDNS (default: default)
--txt-prefix=""When using the TXT registry, a custom string that's prefixed to each ownership DNS record (optional). Could contain record type template like '%{record_type}-prefix-'. Mutual exclusive with txt-suffix!
--txt-suffix=""When using the TXT registry, a custom string that's suffixed to the host portion of each ownership DNS record (optional). Could contain record type template like '-%{record_type}-suffix'. Mutual exclusive with txt-prefix!
--txt-wildcard-replacement=""When using the TXT registry, a custom string that's used instead of an asterisk for TXT records corresponding to wildcard DNS records (optional)
--[no-]txt-encrypt-enabledWhen using the TXT registry, set if TXT records should be encrypted before stored (default: disabled)
--txt-encrypt-aes-key=""When using the TXT registry, set TXT record decryption and encryption 32 byte aes key (required when --txt-encrypt=true)
--migrate-from-txt-owner=""Old txt-owner-id that needs to be overwritten (default: default)
--dynamodb-region=""When using the DynamoDB registry, the AWS region of the DynamoDB table (optional)
--dynamodb-table="external-dns"When using the DynamoDB registry, the name of the DynamoDB table (default: "external-dns")
--txt-cache-interval=0sThe interval between cache synchronizations in duration format (default: disabled)
--interval=1m0sThe interval between two consecutive synchronizations in duration format (default: 1m)
--min-event-sync-interval=5sThe minimum interval between two consecutive synchronizations triggered from kubernetes events in duration format (default: 5s)
--[no-]onceWhen enabled, exits the synchronization loop after the first iteration (default: disabled)
--[no-]dry-runWhen enabled, prints DNS record changes rather than actually performing them (default: disabled)
--[no-]eventsWhen enabled, in addition to running every interval, the reconciliation loop will get triggered when supported sources change (default: disabled)
--min-ttl=0sConfigure global TTL for records in duration format. This value is used when the TTL for a source is not set or set to 0. (optional; examples: 1m12s, 72s, 72)
--log-format=textThe format in which log messages are printed (default: text, options: text, json)
--metrics-address=":7979"Specify where to serve the metrics and health check endpoint (default: :7979)
--log-level=infoSet the level of logging. (default: info, options: panic, debug, info, warning, error, fatal)
--webhook-provider-url="http://localhost:8888"The URL of the remote endpoint to call for the webhook provider (default: http://localhost:8888)
--webhook-provider-read-timeout=5sThe read timeout for the webhook provider in duration format (default: 5s)
--webhook-provider-write-timeout=10sThe write timeout for the webhook provider in duration format (default: 10s)
--[no-]webhook-serverWhen enabled, runs as a webhook server instead of a controller. (default: false).
--[no-]combine-fqdn-annotationCombine FQDN template and Annotations instead of overwriting (default: false)
--fqdn-template=""A templated string that's used to generate DNS names from sources that don't define a hostname themselves, or to add a hostname suffix when paired with the fake source (optional). Accepts comma separated list for multiple global FQDN.
--target-template=""A templated string used to generate DNS targets (IP or hostname) from sources that support it (optional). Accepts comma separated list for multiple targets.
--fqdn-target-template=""A template that returns host:target pairs (e.g., '{{range .Object.endpoints}}{{.targetRef.name}}.svc.example.com:{{index .addresses 0}},{{end}}'). Accepts comma separated list for multiple pairs.
--kubeconfig=""Retrieve target cluster configuration from a Kubernetes configuration file (default: auto-detect)
--request-timeout=30s[DEPRECATED: use --kube-api-request-timeout] Request timeout when calling Kubernetes APIs. 0s means no timeout
--kube-api-request-timeout=30sRequest timeout when calling Kubernetes APIs. 0s means no timeout
--kube-api-qps=5Maximum QPS to the Kubernetes API server from this client.
--kube-api-burst=10Maximum burst for throttle to the Kubernetes API server from this client.
--provider=providerThe DNS provider where the DNS records will be created (required, options: akamai, alibabacloud, aws, aws-sd, azure, azure-dns, azure-private-dns, civo, cloudflare, coredns, dnsimple, exoscale, gandi, godaddy, google, inmemory, linode, ns1, oci, ovh, pdns, pihole, plural, rfc2136, scaleway, skydns, transip, webhook)
--source=sourceThe resource types that are queried for endpoints; specify multiple times for multiple sources (required, options: service, ingress, node, pod, gateway-httproute, gateway-grpcroute, gateway-tlsroute, gateway-tcproute, gateway-udproute, istio-gateway, istio-virtualservice, contour-httpproxy, gloo-proxy, fake, connector, crd, empty, skipper-routegroup, openshift-route, ambassador-host, kong-tcpingress, f5-virtualserver, f5-transportserver, traefik-proxy, unstructured)