Skip to content

Commit

Permalink
Update weaver kube documentation (#782)
Browse files Browse the repository at this point in the history
  • Loading branch information
@rgrandl
rgrandl committed Jul 12, 2024
1 parent 95cfc9e commit a89085a
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions website/docs.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2249,6 +2249,7 @@ You can configure the `Kube` deployer using the knobs exported in the [config fi
| 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>`. |
| buildTool | optional | Name of the tool used to build the image `Kube` creates. If absent, the build tool name defaults to `docker`. |
| 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`. |
| serviceAccount | optional | Name of the Kubernetes service account under which to run the pods. If absent, it uses the default service account for your namespace. |
Expand All @@ -2258,6 +2259,7 @@ You can configure the `Kube` deployer using the knobs exported in the [config fi
| scalingSpec | optional | Specifications on how to scale the pods using the [Kubernetes Horizontal Pod Autoscaler][hpa]. Should satisfy the Kubernetes HPA [spec format][kubernetes_hpa_spec]. If absent, default options will be used (`minReplicas=1`, `maxReplicas=10`, `CPU` metric, `averageUtilization=80)`. |
| 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. |
| affinitySpec | optional | Options to configure Kubernetes [pod affinity][kubernetes_affinity]. By default, it ensures that different replicas of the same service are not scheduled on the same node. |
| 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. |

Expand Down Expand Up @@ -3638,6 +3640,7 @@ runtime benefits of microservices.
[kube_config_file]: https://github.com/ServiceWeaver/weaver-kube/blob/main/internal/impl/config.go
[kubernetes_resources]: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
[kubernetes_volumes]: https://kubernetes.io/docs/concepts/storage/volumes/
[kubernetes_affinity]: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/
[kubernetes_hpa_spec]: https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/#support-for-resource-metrics
[kubernetes_probes]: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/
[logs_explorer]: https://cloud.google.com/logging/docs/view/logs-explorer-interface
Expand Down

0 comments on commit a89085a

Please sign in to comment.