Open luckury opened 9 months ago
This probably needs the label "missing docs"
Thanks, without this I was getting lost, this definitely needs to go into official docs
The Kubernetes project currently lacks enough contributors to adequately respond to all issues.
This bot triages un-triaged issues according to the following rules:
lifecycle/stale
is appliedlifecycle/stale
was applied, lifecycle/rotten
is appliedlifecycle/rotten
was applied, the issue is closedYou can:
/remove-lifecycle stale
/close
Please send feedback to sig-contributor-experience at kubernetes/community.
/lifecycle stale
/remove-lifecycle stale
--txt-encrypt-enabled
or --txt-encrypt=true
?
What would you like to be added: Documentation for the supported flags for external-dns. Why is this needed: Really struggling to understand what all the features of external-dns are and how to configure the app. In the source-code there are all the flags specified here: https://github.com/kubernetes-sigs/external-dns/blob/master/pkg/apis/externaldns/types.go. I think we should extract them and put them on a dedicated doc page.
Here is a table for other people looking for this in the meantime:
externaldns.k8s.io/v1alpha1
, valid only when using crd sourcearn:aws:iam::123455567:role/external-dns
(optional)Flag defaults
```go APIServerURL: "", KubeConfig: "", RequestTimeout: time.Second * 30, DefaultTargets: []string{}, GlooNamespaces: []string{"gloo-system"}, SkipperRouteGroupVersion: "zalando.org/v1", Sources: nil, Namespace: "", AnnotationFilter: "", LabelFilter: labels.Everything().String(), IngressClassNames: nil, FQDNTemplate: "", CombineFQDNAndAnnotation: false, IgnoreHostnameAnnotation: false, IgnoreIngressTLSSpec: false, IgnoreIngressRulesSpec: false, GatewayNamespace: "", GatewayLabelFilter: "", Compatibility: "", PublishInternal: false, PublishHostIP: false, ConnectorSourceServer: "localhost:8080", Provider: "", GoogleProject: "", GoogleBatchChangeSize: 1000, GoogleBatchChangeInterval: time.Second, GoogleZoneVisibility: "", DomainFilter: []string{}, ZoneIDFilter: []string{}, ExcludeDomains: []string{}, RegexDomainFilter: regexp.MustCompile(""), RegexDomainExclusion: regexp.MustCompile(""), TargetNetFilter: []string{}, ExcludeTargetNets: []string{}, AlibabaCloudConfigFile: "/etc/kubernetes/alibaba-cloud.json", AWSZoneType: "", AWSZoneTagFilter: []string{}, AWSZoneMatchParent: false, AWSAssumeRole: "", AWSAssumeRoleExternalID: "", AWSBatchChangeSize: 1000, AWSBatchChangeSizeBytes: 32000, AWSBatchChangeSizeValues: 1000, AWSBatchChangeInterval: time.Second, AWSEvaluateTargetHealth: true, AWSAPIRetries: 3, AWSPreferCNAME: false, AWSZoneCacheDuration: 0 * time.Second, AWSSDServiceCleanup: false, AWSDynamoDBRegion: "", AWSDynamoDBTable: "external-dns", AzureConfigFile: "/etc/kubernetes/azure.json", AzureResourceGroup: "", AzureSubscriptionID: "", BluecatConfigFile: "/etc/kubernetes/bluecat.json", BluecatDNSDeployType: "no-deploy", CloudflareProxied: false, CloudflareDNSRecordsPerPage: 100, CoreDNSPrefix: "/skydns/", RcodezeroTXTEncrypt: false, AkamaiServiceConsumerDomain: "", AkamaiClientToken: "", AkamaiClientSecret: "", AkamaiAccessToken: "", AkamaiEdgercSection: "", AkamaiEdgercPath: "", InfobloxGridHost: "", InfobloxWapiPort: 443, InfobloxWapiUsername: "admin", InfobloxWapiPassword: "", InfobloxWapiVersion: "2.3.1", InfobloxSSLVerify: true, InfobloxView: "", InfobloxMaxResults: 0, InfobloxFQDNRegEx: "", InfobloxCreatePTR: false, InfobloxCacheDuration: 0, OCIConfigFile: "/etc/kubernetes/oci.yaml", OCIZoneScope: "GLOBAL", OCIZoneCacheDuration: 0 * time.Second, InMemoryZones: []string{}, OVHEndpoint: "ovh-eu", OVHApiRateLimit: 20, PDNSServer: "http://localhost:8081", PDNSAPIKey: "", PDNSSkipTLSVerify: false, TLSCA: "", TLSClientCert: "", TLSClientCertKey: "", Policy: "sync", Registry: "txt", TXTOwnerID: "default", TXTPrefix: "", TXTSuffix: "", TXTCacheInterval: 0, TXTWildcardReplacement: "", MinEventSyncInterval: 5 * time.Second, TXTEncryptEnabled: false, TXTEncryptAESKey: "", Interval: time.Minute, Once: false, DryRun: false, UpdateEvents: false, LogFormat: "text", MetricsAddress: ":7979", LogLevel: logrus.InfoLevel.String(), ExoscaleAPIEnvironment: "api", ExoscaleAPIZone: "ch-gva-2", ExoscaleAPIKey: "", ExoscaleAPISecret: "", CRDSourceAPIVersion: "externaldns.k8s.io/v1alpha1", CRDSourceKind: "DNSEndpoint", ServiceTypeFilter: []string{}, CFAPIEndpoint: "", CFUsername: "", CFPassword: "", RFC2136Host: "", RFC2136Port: 0, RFC2136Zone: []string{}, RFC2136Insecure: false, RFC2136GSSTSIG: false, RFC2136KerberosRealm: "", RFC2136KerberosUsername: "", RFC2136KerberosPassword: "", RFC2136TSIGKeyName: "", RFC2136TSIGSecret: "", RFC2136TSIGSecretAlg: "", RFC2136TAXFR: true, RFC2136MinTTL: 0, RFC2136BatchChangeSize: 50, NS1Endpoint: "", NS1IgnoreSSL: false, TransIPAccountName: "", TransIPPrivateKeyFile: "", DigitalOceanAPIPageSize: 50, ManagedDNSRecordTypes: []string{endpoint.RecordTypeA, endpoint.RecordTypeAAAA, endpoint.RecordTypeCNAME}, ExcludeDNSRecordTypes: []string{}, GoDaddyAPIKey: "", GoDaddySecretKey: "", GoDaddyTTL: 600, GoDaddyOTE: false, IBMCloudProxied: false, IBMCloudConfigFile: "/etc/kubernetes/ibmcloud.json", TencentCloudConfigFile: "/etc/kubernetes/tencent-cloud.json", TencentCloudZoneType: "", PiholeServer: "", PiholePassword: "", PiholeTLSInsecureSkipVerify: false, PluralCluster: "", PluralProvider: "", WebhookProviderURL: "http://localhost:8888", WebhookProviderReadTimeout: 5 * time.Second, WebhookProviderWriteTimeout: 10 * time.Second, WebhookServer: false, TraefikDisableLegacy: false, TraefikDisableNew: false, ```Flag types
```go APIServerURL string KubeConfig string RequestTimeout time.Duration DefaultTargets []string GlooNamespaces []string SkipperRouteGroupVersion string Sources []string Namespace string AnnotationFilter string LabelFilter string IngressClassNames []string FQDNTemplate string CombineFQDNAndAnnotation bool IgnoreHostnameAnnotation bool IgnoreIngressTLSSpec bool IgnoreIngressRulesSpec bool GatewayNamespace string GatewayLabelFilter string Compatibility string PublishInternal bool PublishHostIP bool AlwaysPublishNotReadyAddresses bool ConnectorSourceServer string Provider string GoogleProject string GoogleBatchChangeSize int GoogleBatchChangeInterval time.Duration GoogleZoneVisibility string DomainFilter []string ExcludeDomains []string RegexDomainFilter *regexp.Regexp RegexDomainExclusion *regexp.Regexp ZoneNameFilter []string ZoneIDFilter []string TargetNetFilter []string ExcludeTargetNets []string AlibabaCloudConfigFile string AlibabaCloudZoneType string AWSZoneType string AWSZoneTagFilter []string AWSAssumeRole string AWSAssumeRoleExternalID string AWSBatchChangeSize int AWSBatchChangeSizeBytes int AWSBatchChangeSizeValues int AWSBatchChangeInterval time.Duration AWSEvaluateTargetHealth bool AWSAPIRetries int AWSPreferCNAME bool AWSZoneCacheDuration time.Duration AWSSDServiceCleanup bool AWSZoneMatchParent bool AWSDynamoDBRegion string AWSDynamoDBTable string AzureConfigFile string AzureResourceGroup string AzureSubscriptionID string AzureUserAssignedIdentityClientID string BluecatDNSConfiguration string BluecatConfigFile string BluecatDNSView string BluecatGatewayHost string BluecatRootZone string BluecatDNSServerName string BluecatDNSDeployType string BluecatSkipTLSVerify bool CloudflareProxied bool CloudflareDNSRecordsPerPage int CoreDNSPrefix string RcodezeroTXTEncrypt bool AkamaiServiceConsumerDomain string AkamaiClientToken string AkamaiClientSecret string AkamaiAccessToken string AkamaiEdgercPath string AkamaiEdgercSection string InfobloxGridHost string InfobloxWapiPort int InfobloxWapiUsername string InfobloxWapiPassword string `secure:"yes"` InfobloxWapiVersion string InfobloxSSLVerify bool InfobloxView string InfobloxMaxResults int InfobloxFQDNRegEx string InfobloxNameRegEx string InfobloxCreatePTR bool InfobloxCacheDuration int DynCustomerName string DynUsername string DynPassword string `secure:"yes"` DynMinTTLSeconds int OCIConfigFile string OCICompartmentOCID string OCIAuthInstancePrincipal bool OCIZoneScope string OCIZoneCacheDuration time.Duration InMemoryZones []string OVHEndpoint string OVHApiRateLimit int PDNSServer string PDNSAPIKey string `secure:"yes"` PDNSSkipTLSVerify bool TLSCA string TLSClientCert string TLSClientCertKey string Policy string Registry string TXTOwnerID string TXTPrefix string TXTSuffix string TXTEncryptEnabled bool TXTEncryptAESKey string `secure:"yes"` Interval time.Duration MinEventSyncInterval time.Duration Once bool DryRun bool UpdateEvents bool LogFormat string MetricsAddress string LogLevel string TXTCacheInterval time.Duration TXTWildcardReplacement string ExoscaleEndpoint string ExoscaleAPIKey string `secure:"yes"` ExoscaleAPISecret string `secure:"yes"` ExoscaleAPIEnvironment string ExoscaleAPIZone string CRDSourceAPIVersion string CRDSourceKind string ServiceTypeFilter []string CFAPIEndpoint string CFUsername string CFPassword string ResolveServiceLoadBalancerHostname bool RFC2136Host string RFC2136Port int RFC2136Zone []string RFC2136Insecure bool RFC2136GSSTSIG bool RFC2136KerberosRealm string RFC2136KerberosUsername string RFC2136KerberosPassword string `secure:"yes"` RFC2136TSIGKeyName string RFC2136TSIGSecret string `secure:"yes"` RFC2136TSIGSecretAlg string RFC2136TAXFR bool RFC2136MinTTL time.Duration RFC2136BatchChangeSize int NS1Endpoint string NS1IgnoreSSL bool NS1MinTTLSeconds int TransIPAccountName string TransIPPrivateKeyFile string DigitalOceanAPIPageSize int ManagedDNSRecordTypes []string ExcludeDNSRecordTypes []string GoDaddyAPIKey string `secure:"yes"` GoDaddySecretKey string `secure:"yes"` GoDaddyTTL int64 GoDaddyOTE bool OCPRouterName string IBMCloudProxied bool IBMCloudConfigFile string TencentCloudConfigFile string TencentCloudZoneType string PiholeServer string PiholePassword string `secure:"yes"` PiholeTLSInsecureSkipVerify bool PluralCluster string PluralProvider string WebhookProviderURL string WebhookProviderReadTimeout time.Duration WebhookProviderWriteTimeout time.Duration WebhookServer bool TraefikDisableLegacy bool TraefikDisableNew bool ```