Skip to content

Commit cc65479

Browse files
committed
Update Cert Generator Doc
1 parent 8cec77c commit cc65479

File tree

1 file changed

+6
-8
lines changed

1 file changed

+6
-8
lines changed

docs/developer-guide.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ make generate
5858
Below is a list of command-line flags accepted by Katib controller:
5959

6060
| Name | Type | Default | Description |
61-
|---------------------------------|---------------------------|-------------------------------|------------------------------------------------------------------------------------------------------------------------|
61+
| ------------------------------- | ------------------------- | ----------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
6262
| enable-grpc-probe-in-suggestion | bool | true | Enable grpc probe in suggestions |
6363
| experiment-suggestion-name | string | "default" | The implementation of suggestion interface in experiment controller |
6464
| metrics-addr | string | ":8080" | The address that the metrics endpoint binds to |
@@ -74,7 +74,7 @@ Below is a list of command-line flags accepted by Katib controller:
7474
Below is a list of command-line flags accepted by Katib DB Manager:
7575

7676
| Name | Type | Default | Description |
77-
|-----------------|---------------|---------|---------------------------------------------------------|
77+
| --------------- | ------------- | ------- | ------------------------------------------------------- |
7878
| connect-timeout | time.Duration | 60s | Timeout before calling error during database connection |
7979

8080
## Workflow design
@@ -113,13 +113,11 @@ to generate certificates for the webhooks.
113113

114114
Once Katib is deployed in the Kubernetes cluster, the `cert-generator` Job follows these steps:
115115

116-
- Generate the self-signed CA certificate and private key.
116+
- Generate the self-signed certificate and private key.
117117

118-
- Generate public certificate and private key signed with the key generated in the previous step.
119-
120-
- Create a Kubernetes Secret with the signed certificate. Secret has
121-
the `katib-webhook-cert` name and `cert-generator` Job's `ownerReference` to
122-
clean-up resources once Katib is uninstalled.
118+
- Create a Kubernetes Secret with the self-signed TLS certificate and private key.
119+
Secret has the `katib-webhook-cert` name and `cert-generator` Job's
120+
`ownerReference` to clean-up resources once Katib is uninstalled.
123121

124122
Once Secret is created, the Katib controller Deployment spawns the Pod,
125123
since the controller has the `katib-webhook-cert` Secret volume.

0 commit comments

Comments
 (0)