Skip to content
This repository has been archived by the owner on Jul 20, 2023. It is now read-only.

Commit

Permalink
docs(fl-operator): document how to add new apis inside the fl-operator
Browse files Browse the repository at this point in the history
  • Loading branch information
GerardoGR committed Jul 15, 2022
1 parent 4a46dce commit 805e00a
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions components/fl-operator/README.md
Original file line number Diff line number Diff line change
@@ -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
```

0 comments on commit 805e00a

Please sign in to comment.