Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add katib controller flags to developers guide #1449

Merged
merged 1 commit into from
Feb 26, 2021
Merged

Add katib controller flags to developers guide #1449

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions docs/developer-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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).
Expand Down