Skip to content
This repository has been archived by the owner on Sep 16, 2019. It is now read-only.

Commit

Permalink
Merge pull request #66 from zalando-incubator/update-readme
Browse files Browse the repository at this point in the history
update docs
  • Loading branch information
linki authored Jan 17, 2017
2 parents c27c153 + be273d8 commit d8b09b1
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,10 @@ $ mate \

For each exposed service Mate will create two records in Route53:

1. A record - An Alias to the ELB with the name inferred from `kubernetes-format` and `kubernetes-domain`. So if you create an nginx service named `my-nginx` in the `default` namespace and use a `example.com` as domain the registered record will have a hostname of `default-my-nginx.example.com`. You can, however, overwrite the generated DNS name by using an annotation on the service (`zalando.org/dnsname`). When using ingress DNS records based on the hostnames in your rules will be created.
1. A record - An Alias to the ELB with the name inferred from `kubernetes-format` or `zalando.org/dnsname` annotation.
When using ingress DNS records based on the hostnames in your rules will be created.

2. TXT record - A TXT record that will have the same name as an A record (`default-my-nginx.example.com`) and a special identifier with an embedded `aws-record-group-id` value. This helps to identify which records are created via Mate and makes it safe not to overwrite manually created records.
2. TXT record - A TXT record that will have the same name as an A record and a special identifier with an embedded `aws-record-group-id` value. This helps to identify which records are created via Mate and makes it safe not to overwrite manually created records.

### Google

Expand Down
8 changes: 4 additions & 4 deletions examples/aws/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ spec:
- --consumer=aws
- --aws-record-group-id=my-cluster
```
*Note*: `example.com` from the manifest should be changed to the real hosted zone existing in your AWS account.
*Note*: `example.com` is a hosted zone where records are created. Mate does not create hosted zones, and it assumes there exist at least one hosted zone where the record with a given DNS can be placed.
## Service

Create a service using the following manifest [service](service.yaml):
Expand All @@ -50,7 +50,7 @@ If you have `aws-cli` installed, this can be verified with (change `example.com`

`aws route53 list-resource-record-sets --hosted-zone-id=*my-zone-id* --query "ResourceRecordSets[?Name == 'default-nginx-service.example.com.']"`

If you do not wish to use a template approach, or want to create a record in another hosted-zone, this can be achieved by specifying desired DNS
If you do not wish to use a template approach, or want to create a record in another hosted-zone (different from specified in Mate deployment manifest), this can be achieved by specifying desired DNS
in service annotations, e.g.:
```
...
Expand Down Expand Up @@ -92,8 +92,8 @@ https://github.com/kubernetes/contrib/tree/master/ingress/controllers


Your Ingress controller should provision a Load Balancer (both ELB and ALB are supported by Mate) and update the ingress resource.
Once LB is created Mate will create a DNS records, as specified in `rules.Host` fields, e.g. in the specified example it will create
two records in two separate hosted zones `bar-app.example.com` and `foo-app.foo.com`.
Once LB is created Mate will create a DNS records, as specified in `rules.Host` field of created ingress resource, e.g. in the specified example it will create
two records in two separate hosted zones `bar-app.example.com` and `foo-app.foo.com` (assuming both exist in your AWS account).

### Permissions

Expand Down

0 comments on commit d8b09b1

Please sign in to comment.