diff --git a/README.md b/README.md index e8c8c36..f352287 100644 --- a/README.md +++ b/README.md @@ -12,4 +12,18 @@ If default Swagger page is displayed instead of tyour api, change url in swagger url: "swagger.json" Note on particular process : -- set a bookin delete all related workflow booking before creating new ones. (no update of existing ones) \ No newline at end of file +- set a bookin delete all related workflow booking before creating new ones. (no update of existing ones) + +## 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 \ No newline at end of file diff --git a/controllers/admiralty.go b/controllers/admiralty.go new file mode 100644 index 0000000..f0fb480 --- /dev/null +++ b/controllers/admiralty.go @@ -0,0 +1,18 @@ +package controllers + +import ( + beego "github.com/beego/beego/v2/server/web" +) + +// Operations about the admiralty objects of the datacenter +type AdmiraltyController struct { + beego.Controller +} + +// @Title GetAllTargets +// @Description find all Admiralty Target +// @Success 200 {booking} models.booking +// @router /admiralty/targets [get] +func (c *AdmiraltyController) GetAllTargets() { + +} \ No newline at end of file