-
Notifications
You must be signed in to change notification settings - Fork 23
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add doc for configuring dns provider
- Loading branch information
Showing
6 changed files
with
94 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
# Configuring a DNS Provider | ||
|
||
In order to be able to interact with supported DNS providers, Kuadrant needs a credential that it can use. This credential is leveraged by the multi-cluster gateway controller in order to create and manage DNS records within zones used by the listeners defined in your gateways. | ||
|
||
|
||
## Supported Providers | ||
|
||
Kuadrant Supports the following DNS providers currently | ||
|
||
- AWS route 53 | ||
- Google DNS | ||
|
||
|
||
|
||
## Configuring an AWS Route 53 provider | ||
|
||
Kuadant expects a secret with a credential. Below is an example for route 53 | ||
|
||
``` | ||
apiVersion: v1 | ||
data: | ||
AWS_ACCESS_KEY_ID: XXXXX | ||
AWS_REGION: XXXXX | ||
AWS_SECRET_ACCESS_KEY: XXXXX | ||
kind: Secret | ||
metadata: | ||
name: aws-credentials | ||
namespace: multicluster-gateway-controller-system | ||
type: kuadrant.io/aws | ||
``` | ||
|
||
## IAM permissions required | ||
We have tested using the available policy `AmazonRoute53FullAccess` however it should also be possible to restrict the credential down to a particular zone. More info can be found in the AWS docs | ||
https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/access-control-managing-permissions.html | ||
|
||
## Configuring a Google DNS provider | ||
|
||
``` | ||
apiVersion: v1 | ||
data: | ||
GOOGLE: {"client_id": "00000000-00000000000000.apps.googleusercontent.com","client_secret": "d-FL95Q00000000000000","refresh_token": "00000aaaaa00000000-AAAAAAAAAAAAKFGJFJDFKDK","type": "authorized_user"} | ||
PROJECT_ID: "my-project" | ||
kind: Secret | ||
metadata: | ||
name: aws-credentials | ||
namespace: multicluster-gateway-controller-system | ||
type: kuadrant.io/aws | ||
``` | ||
|
||
|
||
### Access permissions required | ||
https://cloud.google.com/dns/docs/access-control#dns.admin | ||
|
||
|
||
Now that we have the credential created we have a DNSProvdier ready to go. | ||
|
||
## Using a credential | ||
|
||
Once a secret like the one shown above is created, in order for it to be used, it needs to be associated with a `ManagedZone`. | ||
|
||
See [ManagedZone](managedZone.md) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters