Add katib controller flags to developers guide (#1449)

Signed-off-by: Anna Jung (VMware) <antheaj@vmware.com>
kubeflow · Feb 26, 2021 · 90a99a8 · 90a99a8
1 parent fe64c18
commit 90a99a8
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/docs/developer-guide.md b/docs/developer-guide.md
@@ -5,6 +5,7 @@
   - [Requirements](#requirements)
   - [Build from source code](#build-from-source-code)
   - [Modify controller APIs](#modify-controller-apis)
+  - [Controller Flags](#controller-flags)
   - [Workflow design](#workflow-design)
   - [Implement a new algorithm and use it in Katib](#implement-a-new-algorithm-and-use-it-in-katib)
   - [Algorithm settings documentation](#algorithm-settings-documentation)
@@ -60,6 +61,21 @@ You can update necessary files as follows:
 make generate
 ```
 
+## Controller Flags
+
+Below is a list of command-line flags accepted by Katib controller:
+
+| Name                            | Type                        | Default             | Description                                                                                                             |
+| ------------------------------- | --------------------------- | ------------------- | ----------------------------------------------------------------------------------------------------------------------- |
+| cert-localfs                    | bool                        | false               | Store the webhook cert in local file system                                                                             |
+| enable-grpc-probe-in-suggestion | bool                        | true                | Enable grpc probe in suggestions                                                                                        |
+| experiment-suggestion-name      | string                      | "default"           | The implementation of suggestion interface in experiment controller                                                     |
+| metrics-addr                    | string                      | ":8080"             | The address the metric endpoint binds to                                                                                |
+| trial-resources                 | []schema.GroupVersionKind   | null                | The list of resources that can be used as trial template, in the form: Kind.version.group (e.g. TFJob.v1.kubeflow.org)  |
+| webhook-inject-securitycontext  | bool                        | false               | Inject the securityContext of container[0] in the sidecar                                                               |
+| webhook-port                    | int                         | 8443                | The port number to be used for admission webhook server                                                                 |
+| webhook-service-name            | string                      | "katib-controller"  | The service name which will be used in webhook                                                                          |
+
 ## Workflow design
 
 Please see [workflow-design.md](./workflow-design.md).