Merge branch 'kubernetes-sigs:master' into aws-sd-tags

kubernetes-sigs · Oct 7, 2024 · ad744bd · ad744bd
2 parents 5ac7afa + cda94eb
commit ad744bd
Show file tree

Hide file tree

Showing 30 changed files with 836 additions and 1,411 deletions.
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -21,7 +21,7 @@ jobs:
     steps:
 
     - name: Check out code into the Go module directory
-      uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+      uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0
 
     - name: Set up Go 1.x
       uses: actions/setup-go@v5

diff --git a/.github/workflows/codeql-analysis.yaml b/.github/workflows/codeql-analysis.yaml
@@ -26,7 +26,7 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+      uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0
     - name: Install go version
       uses: actions/setup-go@v5
       with:

diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml
@@ -15,7 +15,7 @@ jobs:
     name: Release Docs
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+      - uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0
         with:
           fetch-depth: 0
 

diff --git a/.github/workflows/json-yaml-validate.yml b/.github/workflows/json-yaml-validate.yml
@@ -14,7 +14,7 @@ jobs:
   json-yaml-validate:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+      - uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0
 
       - name: json-yaml-validate
         uses: GrantBirki/json-yaml-validate@v3.2.1

diff --git a/.github/workflows/lint-test-chart.yaml b/.github/workflows/lint-test-chart.yaml
@@ -14,7 +14,7 @@ jobs:
         shell: bash
     steps:
       - name: Checkout
-        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+        uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0
         with:
           fetch-depth: 0
 

diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml
@@ -22,7 +22,7 @@ jobs:
     steps:
 
     - name: Check out code into the Go module directory
-      uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+      uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0
 
     - name: Set up Go 1.x
       uses: actions/setup-go@v5

diff --git a/.github/workflows/release-chart.yaml b/.github/workflows/release-chart.yaml
@@ -20,7 +20,7 @@ jobs:
         shell: bash
     steps:
       - name: Checkout
-        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+        uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0
         with:
           fetch-depth: 0
 

diff --git a/.github/workflows/staging-image-tester.yaml b/.github/workflows/staging-image-tester.yaml
@@ -21,7 +21,7 @@ jobs:
     steps:
 
     - name: Check out code into the Go module directory
-      uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+      uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0
 
     - name: Set up Go 1.x
       uses: actions/setup-go@v5

diff --git a/README.md b/README.md
@@ -74,22 +74,23 @@ See PR #3063 for all the discussions about it.
 
 Known providers using webhooks:
 
-| Provider |  Repo |
-| -------- | ----------- |
-| Adguard Home Provider | https://github.com/muhlba91/external-dns-provider-adguard |
-| Anexia | https://github.com/ProbstenHias/external-dns-anexia-webhook |
-| Bizfly Cloud | https://github.com/bizflycloud/external-dns-bizflycloud-webhook |
-| Efficient IP | https://github.com/EfficientIP-Labs/external-dns-efficientip-webhook |
-| Gcore | https://github.com/G-Core/external-dns-gcore-webhook |
-| GleSYS | https://github.com/glesys/external-dns-glesys |
-| Hetzner | https://github.com/mconfalonieri/external-dns-hetzner-webhook |
-| IONOS | https://github.com/ionos-cloud/external-dns-ionos-webhook |
-| Infoblox | https://github.com/AbsaOSS/external-dns-infoblox-webhook |
-| Netcup | https://github.com/mrueg/external-dns-netcup-webhook |
-| Netic | https://github.com/neticdk/external-dns-tidydns-webhook |
-| RouterOS | https://github.com/benfiola/external-dns-routeros-provider |
-| STACKIT | https://github.com/stackitcloud/external-dns-stackit-webhook |
-| Unifi | https://github.com/kashalls/external-dns-unifi-webhook |
+| Provider              | Repo                                                                 |
+|-----------------------|----------------------------------------------------------------------|
+| Adguard Home Provider | https://github.com/muhlba91/external-dns-provider-adguard            |
+| Anexia                | https://github.com/ProbstenHias/external-dns-anexia-webhook          |
+| Bizfly Cloud          | https://github.com/bizflycloud/external-dns-bizflycloud-webhook      |
+| Efficient IP          | https://github.com/EfficientIP-Labs/external-dns-efficientip-webhook |
+| Gcore                 | https://github.com/G-Core/external-dns-gcore-webhook                 |
+| GleSYS                | https://github.com/glesys/external-dns-glesys                        |
+| Hetzner               | https://github.com/mconfalonieri/external-dns-hetzner-webhook        |
+| IONOS                 | https://github.com/ionos-cloud/external-dns-ionos-webhook            |
+| Infoblox              | https://github.com/AbsaOSS/external-dns-infoblox-webhook             |
+| Netcup                | https://github.com/mrueg/external-dns-netcup-webhook                 |
+| Netic                 | https://github.com/neticdk/external-dns-tidydns-webhook              |
+| RouterOS              | https://github.com/benfiola/external-dns-routeros-provider           |
+| STACKIT               | https://github.com/stackitcloud/external-dns-stackit-webhook         |
+| Unifi                 | https://github.com/kashalls/external-dns-unifi-webhook               |
+| Vultr                 | https://github.com/vultr/external-dns-vultr-webhook                  |
 
 ## Status of in-tree providers
 
@@ -125,7 +126,6 @@ The following table clarifies the current status of the providers according to t
 | RFC2136 | Alpha | |
 | NS1 | Alpha | |
 | TransIP | Alpha | |
-| RancherDNS | Alpha | |
 | OVH | Alpha | |
 | Scaleway DNS | Alpha | @Sh4d1 |
 | UltraDNS | Alpha | |
@@ -183,10 +183,10 @@ The following tutorials are provided:
 * [NS1](docs/tutorials/ns1.md)
 * [NS Record Creation with CRD Source](docs/sources/ns-record.md)
 * [MX Record Creation with CRD Source](docs/sources/mx-record.md)
+* [TXT Record Creation with CRD Source](docs/sources/txt-record.md)
 * [OpenStack Designate](docs/tutorials/designate.md)
 * [Oracle Cloud Infrastructure (OCI) DNS](docs/tutorials/oracle.md)
 * [PowerDNS](docs/tutorials/pdns.md)
-* [RancherDNS (RDNS)](docs/tutorials/rdns.md)
 * [RFC2136](docs/tutorials/rfc2136.md)
 * [TransIP](docs/tutorials/transip.md)
 * [OVH](docs/tutorials/ovh.md)

diff --git a/docs/sources/mx-record.md b/docs/sources/mx-record.md
@@ -1,12 +1,12 @@
 # MX record with CRD source
 
 You can create and manage MX records with the help of [CRD source](../contributing/crd-source.md)
-and `DNSEndpoint` CRD. Currently, this feature is only supported by `aws`, `azure`, and `google` providers.
+and `DNSEndpoint` CRD. Currently, this feature is only supported by `aws`, `azure`, `google` and `digitalocean` providers.
 
 In order to start managing MX records you need to set the `--managed-record-types MX` flag.
 
 ```console
-external-dns --source crd --provider {aws|azure|google} --managed-record-types A --managed-record-types CNAME --managed-record-types MX
+external-dns --source crd --provider {aws|azure|google|digitalocean} --managed-record-types A --managed-record-types CNAME --managed-record-types MX
 ```
 
 Targets within the CRD need to be specified according to the RFC 1034 (section 3.6.1). Below is an example of

diff --git a/docs/sources/txt-record.md b/docs/sources/txt-record.md
@@ -0,0 +1,30 @@
+# Creating TXT record with CRD source
+
+You can create and manage TXT records with the help of [CRD source](../contributing/crd-source.md)
+and `DNSEndpoint` CRD. Currently, this feature is only supported by `digitalocean` providers.
+
+In order to start managing TXT records you need to set the `--managed-record-types TXT` flag.
+
+```console
+external-dns --source crd --provider {digitalocean} --managed-record-types A --managed-record-types CNAME --managed-record-types TXT
+```
+
+Targets within the CRD need to be specified according to the RFC 1035 (section 3.3.14). Below is an example of
+`example.com` DNS TXT two records creation.
+
+**NOTE** Current implementation do not support RFC 6763 (section 6).
+
+```yaml
+apiVersion: externaldns.k8s.io/v1alpha1
+kind: DNSEndpoint
+metadata:
+  name: examplemxrecord
+spec:
+  endpoints:
+    - dnsName: example.com
+      recordTTL: 180
+      recordType: TXT
+      targets:
+        - SOMETXT
+        - ANOTHERTXT
+```
diff --git a/docs/tutorials/pdns.md b/docs/tutorials/pdns.md
@@ -47,6 +47,7 @@ spec:
         - --source=service # or ingress or both
         - --provider=pdns
         - --pdns-server={{ pdns-api-url }}
+        - --pdns-server-id={{ pdns-server-id }}
         - --pdns-api-key={{ pdns-http-api-key }}
         - --txt-owner-id={{ owner-id-for-this-external-dns }}
         - --domain-filter=external-dns-test.my-org.com # will make ExternalDNS see only the zones matching provided domain; omit to process all available zones in PowerDNS
@@ -172,3 +173,102 @@ Once the API shows the record correctly, you can double check your record using:
 ```bash
 $ dig @${PDNS_FQDN} echo.example.com.
 ```
+
+## Using CRD source to manage DNS records in PowerDNS
+
+[CRD source](https://github.com/kubernetes-sigs/external-dns/blob/master/docs/contributing/crd-source.md) provides a generic mechanism and declarative way to manage DNS records in PowerDNS using external-dns.
+
+```bash
+external-dns --source=crd --provider=pdns \
+  --pdns-server={{ pdns-api-url }} \
+  --pdns-api-key={{ pdns-api-key }} \
+  --domain-filter=example.com \
+  --managed-record-types=A \
+  --managed-record-types=CNAME \
+  --managed-record-types=TXT \
+  --managed-record-types=MX \
+  --managed-record-types=SRV
+```
+
+Not all the record types are enabled by default so we can enable the required record types using `--managed-record-types`.
+
+* Example for record type `A`
+
+```yaml
+apiVersion: externaldns.k8s.io/v1alpha1
+kind: DNSEndpoint
+metadata:
+  name: examplearecord
+spec:
+  endpoints:
+  - dnsName: example.com
+    recordTTL: 60
+    recordType: A
+    targets:
+    - 10.0.0.1
+```
+
+* Example for record type `CNAME`
+
+```yaml
+apiVersion: externaldns.k8s.io/v1alpha1
+kind: DNSEndpoint
+metadata:
+  name: examplecnamerecord
+spec:
+  endpoints:
+  - dnsName: test-a.example.com
+    recordTTL: 300
+    recordType: CNAME
+    targets:
+    - example.com
+```
+
+* Example for record type `TXT`
+
+```yaml
+apiVersion: externaldns.k8s.io/v1alpha1
+kind: DNSEndpoint
+metadata:
+  name: exampletxtrecord
+spec:
+  endpoints:
+  - dnsName: example.com
+    recordTTL: 3600
+    recordType: TXT
+    targets:
+      - '"v=spf1 include:spf.protection.example.com include:example.org -all"'
+      - '"apple-domain-verification=XXXXXXXXXXXXX"'
+```
+
+* Example for record type `MX`
+
+```yaml
+apiVersion: externaldns.k8s.io/v1alpha1
+kind: DNSEndpoint
+metadata:
+  name: examplemxrecord
+spec:
+  endpoints:
+  - dnsName: example.com
+    recordTTL: 3600
+    recordType: MX
+    targets:
+      - "10 mailhost1.example.com"
+```
+
+* Example for record type `SRV`
+
+```yaml
+apiVersion: externaldns.k8s.io/v1alpha1
+kind: DNSEndpoint
+metadata:
+  name: examplesrvrecord
+spec:
+  endpoints:
+  - dnsName: _service._tls.example.com
+    recordTTL: 180
+    recordType: SRV
+    targets:
+      - "100 1 443 service.example.com"
+```