From 805e00ac546787a25a486653d54431fb5cdb764d Mon Sep 17 00:00:00 2001 From: Gerardo Gomez Date: Thu, 14 Jul 2022 17:03:31 +0200 Subject: [PATCH] docs(fl-operator): document how to add new apis inside the fl-operator --- components/fl-operator/README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 components/fl-operator/README.md diff --git a/components/fl-operator/README.md b/components/fl-operator/README.md new file mode 100644 index 0000000..e60a420 --- /dev/null +++ b/components/fl-operator/README.md @@ -0,0 +1,19 @@ +# FL Operator + +Kubernetes operator in charge of scheduling federated learning clients (e.g flower-clients) on-demand based on running +fl-suite workflows. + +## Development + +This project follows the [operator-sdk project layout](https://sdk.operatorframework.io/docs/overview/project-layout/#operator-sdk-project-layout). + +### Create a new API + +The `operator-sdk` is used to generate new APIs. For installation instructions check the [documentation](https://sdk.operatorframework.io/docs/installation/). + +To create a new API with resources and controllers use the following command: + +```shell +# Replace $KIND_NAME with the new API name +operator-sdk create api --verbose --group fl --version v1alpha1 --kind $KIND_NAME --resource --controller +```