diff --git a/README.md b/README.md index 32e1a17..70faf6a 100644 --- a/README.md +++ b/README.md @@ -31,4 +31,17 @@ Once the Target is set the remote cluster appears in the output of `kubectl get # Docker Kube Settings Set up your base64 key from your ~/.kube/config. -Don't forget to set up your external IP in docker_datacenter.json \ No newline at end of file +Don't forget to set up your external IP in docker_datacenter.json +## Admiralty + +The routes in /admiralty will trigger actions on the DC's Kubernetes API to retrieve information on Admiralty resources. + +### Targets + +Remote clusters that can be used by Admiralty to delegate pods. + +To set up a target Admiralty needs to associate a `secret` which contains an edited version of the target's `kubeconfig`. + +Once the Target is set the remote cluster appears in the output of `kubectl get nodes` under the name `admiralty---*` + +**TODO** : We might need a way to test if an IP is associated to an admiralty target