Skip to content

Commit 427ce80

Browse files
committed
docs: fix nested list indentation for sane_lists extension
- Fixed nested indentation to use 4-space in README.md, deprecation.md, version-update-playbook.md, coredns-etcd.md, and aws.md
1 parent dd10769 commit 427ce80

File tree

5 files changed

+49
-49
lines changed

5 files changed

+49
-49
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -192,11 +192,11 @@ The following tutorials are provided:
192192
- [Akamai Edge DNS](docs/tutorials/akamai-edgedns.md)
193193
- [Alibaba Cloud](docs/tutorials/alibabacloud.md)
194194
- AWS
195-
- [AWS Load Balancer Controller](docs/tutorials/aws-load-balancer-controller.md)
196-
- [Route53](docs/tutorials/aws.md)
197-
- [Same domain for public and private Route53 zones](docs/tutorials/aws-public-private-route53.md)
198-
- [Cloud Map](docs/tutorials/aws-sd.md)
199-
- [Kube Ingress AWS Controller](docs/tutorials/kube-ingress-aws.md)
195+
- [AWS Load Balancer Controller](docs/tutorials/aws-load-balancer-controller.md)
196+
- [Route53](docs/tutorials/aws.md)
197+
- [Same domain for public and private Route53 zones](docs/tutorials/aws-public-private-route53.md)
198+
- [Cloud Map](docs/tutorials/aws-sd.md)
199+
- [Kube Ingress AWS Controller](docs/tutorials/kube-ingress-aws.md)
200200
- [Azure DNS](docs/tutorials/azure.md)
201201
- [Azure Private DNS](docs/tutorials/azure-private-dns.md)
202202
- [Civo](docs/tutorials/civo.md)
@@ -207,8 +207,8 @@ The following tutorials are provided:
207207
- [Exoscale](docs/tutorials/exoscale.md)
208208
- [ExternalName Services](docs/tutorials/externalname.md)
209209
- Google Kubernetes Engine
210-
- [Using Google's Default Ingress Controller](docs/tutorials/gke.md)
211-
- [Using the Nginx Ingress Controller](docs/tutorials/gke-nginx.md)
210+
- [Using Google's Default Ingress Controller](docs/tutorials/gke.md)
211+
- [Using the Nginx Ingress Controller](docs/tutorials/gke-nginx.md)
212212
- [Headless Services](docs/tutorials/hostport.md)
213213
- [IONOS Cloud](docs/tutorials/ionoscloud.md)
214214
- [Istio Gateway Source](docs/sources/istio.md)

docs/deprecation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ Votes may be conducted asynchronously, with a reasonable deadline for responses
6969
Upon approval, the proposing maintainer is responsible for implementing the changes required to mark the feature as deprecated. This includes:
7070

7171
* Updating the codebase with deprecation warnings where applicable.
72-
* log.Warn("The XXX is on the path of ***DEPRECATION***. We recommend that you use YYY (link to docs)")
72+
* log.Warn("The XXX is on the path of ***DEPRECATION***. We recommend that you use YYY (link to docs)")
7373
* Documenting the deprecation in release notes and relevant documentation.
7474
* Updating APIs, metrics, or behaviors per the Kubernetes Deprecation Policy if in scope.
7575
* If the feature is entirely deprecated, archival of any associated repositories (external provider as example).
@@ -80,7 +80,7 @@ Deprecation must be introduced in the next release. The release must follow sema
8080

8181
* If the project is in the 0.x stage, a `minor` version `bump` is required.
8282
* For projects 1.x and beyond, a major version bump is required. For the features completely removed.
83-
* If it's a flag change/flip, the `minor` version `bump` is acceptable
83+
* If it's a flag change/flip, the `minor` version `bump` is acceptable
8484

8585
### Full Deprecation and Removal
8686

docs/tutorials/aws.md

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1013,14 +1013,14 @@ For any given DNS name, only **one** of the following routing policies can be us
10131013
- Latency-based routing: `external-dns.alpha.kubernetes.io/aws-region`
10141014
- Failover:`external-dns.alpha.kubernetes.io/aws-failover`
10151015
- Geolocation-based routing:
1016-
- `external-dns.alpha.kubernetes.io/aws-geolocation-continent-code`
1017-
- `external-dns.alpha.kubernetes.io/aws-geolocation-country-code`
1018-
- `external-dns.alpha.kubernetes.io/aws-geolocation-subdivision-code`
1016+
- `external-dns.alpha.kubernetes.io/aws-geolocation-continent-code`
1017+
- `external-dns.alpha.kubernetes.io/aws-geolocation-country-code`
1018+
- `external-dns.alpha.kubernetes.io/aws-geolocation-subdivision-code`
10191019
- Geoproximity routing:
1020-
- `external-dns.alpha.kubernetes.io/aws-geoproximity-region`
1021-
- `external-dns.alpha.kubernetes.io/aws-geoproximity-local-zone-group`
1022-
- `external-dns.alpha.kubernetes.io/aws-geoproximity-coordinates`
1023-
- `external-dns.alpha.kubernetes.io/aws-geoproximity-bias`
1020+
- `external-dns.alpha.kubernetes.io/aws-geoproximity-region`
1021+
- `external-dns.alpha.kubernetes.io/aws-geoproximity-local-zone-group`
1022+
- `external-dns.alpha.kubernetes.io/aws-geoproximity-coordinates`
1023+
- `external-dns.alpha.kubernetes.io/aws-geoproximity-bias`
10241024
- Multi-value answer:`external-dns.alpha.kubernetes.io/aws-multi-value-answer`
10251025

10261026
### Associating DNS records with healthchecks
@@ -1059,7 +1059,7 @@ args:
10591059
```
10601060

10611061
- The first two changes are needed if you use Route53 in Govcloud, which only supports private zones. There are also no cross account IAM whatsoever between Govcloud and commercial AWS accounts.
1062-
- If services and ingresses need to make Route 53 entries to an public zone in a commercial account, you will have set env variables of `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` with a key and secret to the commercial account that has the sufficient rights.
1062+
- If services and ingresses need to make Route 53 entries to an public zone in a commercial account, you will have set env variables of `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` with a key and secret to the commercial account that has the sufficient rights.
10631063

10641064
```yaml
10651065
env:
@@ -1137,33 +1137,33 @@ Route53 has a [5 API requests per second per account hard quota](https://docs.aw
11371137
Running several fast polling ExternalDNS instances in a given account can easily hit that limit. Some ways to reduce the request rate include:
11381138

11391139
- Reduce the polling loop's synchronization interval at the possible cost of slower change propagation (but see `--events` below to reduce the impact).
1140-
- `--interval=5m` (default `1m`)
1140+
- `--interval=5m` (default `1m`)
11411141
- Enable a Cache to store the zone records list. It comes with a cost: slower propagation when the zone gets modified from other sources such as the AWS console, terraform, cloudformation or anything similar.
1142-
- `--provider-cache-time=15m` (default `0m`)
1142+
- `--provider-cache-time=15m` (default `0m`)
11431143
- Trigger the polling loop on changes to K8s objects, rather than only at `interval` and ensure a minimum of time between events, to have responsive updates with long poll intervals
1144-
- `--events`
1145-
- `--min-event-sync-interval=5m` (default `5s`)
1144+
- `--events`
1145+
- `--min-event-sync-interval=5m` (default `5s`)
11461146
- Limit the [sources watched](https://github.com/kubernetes-sigs/external-dns/blob/master/pkg/apis/externaldns/types.go#L364) when the `--events` flag is specified to specific types, namespaces, labels, or annotations
1147-
- `--source=ingress --source=service` - specify multiple times for multiple sources
1148-
- `--namespace=my-app`
1149-
- `--label-filter=app in (my-app)`
1150-
- `--ingress-class=nginx-external`
1147+
- `--source=ingress --source=service` - specify multiple times for multiple sources
1148+
- `--namespace=my-app`
1149+
- `--label-filter=app in (my-app)`
1150+
- `--ingress-class=nginx-external`
11511151
- Limit services watched by type (not applicable to ingress or other types)
1152-
- `--service-type-filter=LoadBalancer` default `all`
1152+
- `--service-type-filter=LoadBalancer` default `all`
11531153
- Limit the hosted zones considered
1154-
- `--zone-id-filter=ABCDEF12345678` - specify multiple times if needed
1155-
- `--domain-filter=example.com` by domain suffix - specify multiple times if needed
1156-
- `--regex-domain-filter=example*` by domain suffix but as a regex - overrides domain-filter
1157-
- `--exclude-domains=ignore.this.example.com` to exclude a domain or subdomain
1158-
- `--regex-domain-exclusion=ignore*` subtracts it's matches from `regex-domain-filter`'s matches
1159-
- `--aws-zone-type=public` only sync zones of this type `[public|private]`
1160-
- `--aws-zone-tags=owner=k8s` only sync zones with this tag
1154+
- `--zone-id-filter=ABCDEF12345678` - specify multiple times if needed
1155+
- `--domain-filter=example.com` by domain suffix - specify multiple times if needed
1156+
- `--regex-domain-filter=example*` by domain suffix but as a regex - overrides domain-filter
1157+
- `--exclude-domains=ignore.this.example.com` to exclude a domain or subdomain
1158+
- `--regex-domain-exclusion=ignore*` subtracts it's matches from `regex-domain-filter`'s matches
1159+
- `--aws-zone-type=public` only sync zones of this type `[public|private]`
1160+
- `--aws-zone-tags=owner=k8s` only sync zones with this tag
11611161
- If the list of zones managed by ExternalDNS doesn't change frequently, cache it by setting a TTL.
1162-
- `--aws-zones-cache-duration=3h` (default `0` - disabled)
1162+
- `--aws-zones-cache-duration=3h` (default `0` - disabled)
11631163
- Increase the number of changes applied to Route53 in each batch
1164-
- `--aws-batch-change-size=4000` (default `1000`)
1164+
- `--aws-batch-change-size=4000` (default `1000`)
11651165
- Increase the interval between changes
1166-
- `--aws-batch-change-interval=10s` (default `1s`)
1166+
- `--aws-batch-change-interval=10s` (default `1s`)
11671167
- Introducing some jitter to the pod initialization, so that when multiple instances of ExternalDNS are updated at the same time they do not make their requests on the same second.
11681168

11691169
A simple way to implement randomised startup is with an init container:
@@ -1203,11 +1203,11 @@ If the change can't fit into any batch - *it will be skipped.*
12031203
There are 3 options to control batch size for AWS provider:
12041204

12051205
- Maximum amount of changes added to one batch
1206-
- `--aws-batch-change-size` (default `1000`)
1206+
- `--aws-batch-change-size` (default `1000`)
12071207
- Maximum size of changes in bytes added to one batch
1208-
- `--aws-batch-change-size-bytes` (default `32000`)
1208+
- `--aws-batch-change-size-bytes` (default `32000`)
12091209
- Maximum value count of changes added to one batch
1210-
- `aws-batch-change-size-values` (default `1000`)
1210+
- `aws-batch-change-size-values` (default `1000`)
12111211

12121212
`aws-batch-change-size` can be very useful for throttling purposes and can be set to any value.
12131213

docs/tutorials/coredns-etcd.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,13 @@ After completing this lab, you will have a Kubernetes environment running as con
2121
Before you start, ensure you have:
2222

2323
- A running kubernetes cluster.
24-
- In this tutorial we are going to use [kind](https://kind.sigs.k8s.io/)
24+
- In this tutorial we are going to use [kind](https://kind.sigs.k8s.io/)
2525
- [`kubectl`](https://kubernetes.io/docs/tasks/tools/) and [`helm`](https://helm.sh/)
2626
- `external-dns` source code or [helm chart](https://github.com/kubernetes-sigs/external-dns/tree/master/charts/external-dns)
2727
- `CoreDNS` [helm chart](https://github.com/coredns/helm)
2828
- Optional
29-
- `dnstools` container for testing
30-
- `etcdctl` to interat with [etcd](https://etcd.io/docs/v3.4/dev-guide/interacting_v3/)
29+
- `dnstools` container for testing
30+
- `etcdctl` to interat with [etcd](https://etcd.io/docs/v3.4/dev-guide/interacting_v3/)
3131

3232
## Bootstrap Environment
3333

docs/version-update-playbook.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@ Upgrading External-DNS involves validating configuration compatibility, testing
1616
- Visit the official [External-DNS Releases](https://github.com/kubernetes-sigs/external-dns/releases).
1717
- Review all versions between your current and target release.
1818
- Pay attention to:
19-
- **Breaking changes** (flags, CRD fields, provider behaviors). Not all changes could be captured as breaking changes.
20-
- **Deprecations**
21-
- **Provider-specific updates**
22-
- **Bug fixes**
19+
- **Breaking changes** (flags, CRD fields, provider behaviors). Not all changes could be captured as breaking changes.
20+
- **Deprecations**
21+
- **Provider-specific updates**
22+
- **Bug fixes**
2323

2424
> ⚠️ Breaking CLI flag or annotation changes are common in `0.x` releases.
2525
@@ -31,9 +31,9 @@ If using Helm:
3131

3232
- Compare your Helm chart version to the version supporting the new app release.
3333
- Check for:
34-
- `values.yaml` structural changes
35-
- Default arguments under `extraArgs`
36-
- Updates to RBAC, ServiceAccounts, or Deployment templates
34+
- `values.yaml` structural changes
35+
- Default arguments under `extraArgs`
36+
- Updates to RBAC, ServiceAccounts, or Deployment templates
3737

3838
---
3939

0 commit comments

Comments
 (0)