diff --git a/docs/contributing/getting-started.md b/docs/contributing/getting-started.md index 4187e39a42..82976ee6d8 100644 --- a/docs/contributing/getting-started.md +++ b/docs/contributing/getting-started.md @@ -31,7 +31,7 @@ make build.docker ExternalDNS's sources of DNS records live in package [source](../../source). They implement the `Source` interface that has a single method `Endpoints` which returns the represented source's objects converted to `Endpoints`. Endpoints are just a tuple of DNS name and target where target can be an IP or another hostname. -For example, the `ServiceSource` returns all Services converted to `Endpoints` where the hostname is the value of the `external-dns.alpha.kubernetes.io/hostname` annotation and the target is the IP of the load balancer or where the hostname is the value of the `external-dns.alpha.kubernetes.io/internal-hostname` annotation and the target is the IP of the service CLusterIP. +For example, the `ServiceSource` returns all Services converted to `Endpoints` where the hostname is the value of the `external-dns.alpha.kubernetes.io/hostname` annotation and the target is the IP of the load balancer or where the hostname is the value of the `external-dns.alpha.kubernetes.io/internal-hostname` annotation and the target is the IP of the service ClusterIP. This list of endpoints is passed to the [Plan](../../plan) which determines the difference between the current DNS records and the desired list of `Endpoints`. diff --git a/docs/release.md b/docs/release.md index e4ce413b5c..ff1521011b 100644 --- a/docs/release.md +++ b/docs/release.md @@ -28,7 +28,7 @@ You must be an official maintainer of the project to be able to do a release. - The step above will trigger the Kubernetes based CI/CD system [Prow](https://prow.k8s.io/?repo=kubernetes-sigs%2Fexternal-dns). Verify that a new image was built and uploaded to `gcr.io/k8s-staging-external-dns/external-dns`. - Create a PR in the [k8s.io repo](https://github.com/kubernetes/k8s.io) (see https://github.com/kubernetes/k8s.io/pull/540 for reference) by taking the current staging image using the sha256 digest. Once the PR is merged, the image will be live with the corresponding tag specified in the PR. - Verify that the image is pullable with the given tag (i.e. `v0.7.5`). -- Branch out from the default branch and run `scripts/kustomize-version-udapter.sh` to update the image tag used in the kustomization.yaml. +- Branch out from the default branch and run `scripts/kustomize-version-updater.sh` to update the image tag used in the kustomization.yaml. - Create an issue to release the corresponding Helm chart via the chart release process (below) assigned to a chart maintainer - Create a PR with the kustomize change. - Once the PR is merged, all is done :-) diff --git a/scripts/kustomize-version-udapter.sh b/scripts/kustomize-version-updater.sh similarity index 100% rename from scripts/kustomize-version-udapter.sh rename to scripts/kustomize-version-updater.sh