Skip to content

Commit 16bdc92

Browse files
author
Anna Jung (VMware)
committed
Add katib controller flags to developers guide
Signed-off-by: Anna Jung (VMware) <[email protected]>
1 parent fe64c18 commit 16bdc92

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

docs/developer-guide.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
- [Requirements](#requirements)
66
- [Build from source code](#build-from-source-code)
77
- [Modify controller APIs](#modify-controller-apis)
8+
- [Controller Flags](#controller-flags)
89
- [Workflow design](#workflow-design)
910
- [Implement a new algorithm and use it in Katib](#implement-a-new-algorithm-and-use-it-in-katib)
1011
- [Algorithm settings documentation](#algorithm-settings-documentation)
@@ -60,6 +61,21 @@ You can update necessary files as follows:
6061
make generate
6162
```
6263

64+
## Controller Flags
65+
66+
Below is a list of command-line flags accepted by Katib controller:
67+
68+
| Name | Type | Default | Description |
69+
| ------------------------------- | ----------- | ------------------- | ----------------------------------------------------------------------------------------------------------------------- |
70+
| cert-localfs | bool | false | Store the webhook cert in local file system |
71+
| enable-grpc-probe-in-suggestion | bool | true | Enable grpc probe in suggestions |
72+
| experiment-suggestion-name | string | "default" | The implementation of suggestion interface in experiment controller |
73+
| metrics-addr | string | ":8080" | The address the metric endpoint binds to |
74+
| trial-resources | value | null | The list of resources that can be used as trial template, in the form: Kind.version.group (e.g. TFJob.v1.kubeflow.org) |
75+
| webhook-inject-securitycontext | bool | false | Inject the securityContext of container[0] in the sidecar |
76+
| webhook-port | int | 8443 | The port number to be used for admission webhook server |
77+
| webhook-service-name | string | "katib-controller" | The service name which will be used in webhook |
78+
6379
## Workflow design
6480

6581
Please see [workflow-design.md](./workflow-design.md).

0 commit comments

Comments
 (0)