Skip to content

Commit

Permalink
Update doc to reflect the latest Kube changes (#775)
Browse files Browse the repository at this point in the history
  • Loading branch information
rgrandl authored Jun 20, 2024
1 parent b814810 commit 3701bd6
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions website/docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -2247,6 +2247,7 @@ You can configure the `Kube` deployer using the knobs exported in the [config fi
| Field | Required? | Description |
|----------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| appConfig | required | Path to the Service Weaver application config file. |
| baseImage | optional | Name of the base image used to build the application container image. If absent, the base image is `ubuntu:rolling`. |
| image | optional | Name of the container image `Kube` creates. If absent, the image name defaults to `<app_name>:<app_version>`. |
| repo | optional | Name of the repository where the container image is uploaded. If empty, the image is not pushed to a repository. |
| namespace | optional | Name of the Kubernetes namespace where the application should be deployed. Defaults to `default`. |
Expand All @@ -2258,6 +2259,7 @@ You can configure the `Kube` deployer using the knobs exported in the [config fi
| probeSpec | optional | Configure Kubernetes [probes][kubernetes_probes] to monitor the healthiness, liveness and readiness of the pods. Should satisfy the Kubernetes [probes format][kubernetes_probes]. If absent, no probe is configured. |
| storageSpec | optional | Options to configure Kubernetes [volumes][kubernetes_volumes] and [volume mounts][kubernetes_volumes]. If absent, no storage is configured. |
| useHostNetwork | optional | If true, application listeners use the underlying nodes' network. This behavior is generally discouraged, but it may be useful when running the application in a minikube environment. |
| telemetry | optional | Various options how to export telemetry to your telemetry plugins. |

For more details on specific subfields of each configuration knob, please check
all the [configuration options][kube_config_file].
Expand Down

0 comments on commit 3701bd6

Please sign in to comment.