Update docs for Function Mesh v0.1.7 release - #95
Conversation
|
✔️ Deploy Preview for function-mesh ready! 🔨 Explore the source changes: d0c6acf 🔍 Inspect the deploy log: https://app.netlify.com/sites/function-mesh/deploys/614016e41187a90007cb0ffd 😎 Browse the preview: https://deploy-preview-95--function-mesh.netlify.app |
| | `ServiceAccountName` | Specify the name of the service account which is used to run Pulsar Functions or connectors in the Function Mesh Worker service.| | ||
| | `InitContainers` | The initialization containers belonging to a Pod. A typical use case could be using an initialization container to download a remote JAR to a local path. | | ||
| | `Sidecars` | Sidecar containers run together with the main function container in a Pod. | | ||
| | `BuiltinAutoscaler` | Specify the built-in autoscaling rules. <br> - CPU-based autoscaling: auto-scale the number of Pods based on the CPU usage (80%, 50%, or 20%). <br>- Memory-based autoscaling: auto-scale the number of Pods based on the memory usage (80%, 50%, or 20%). <br> If you configure the `BuiltinAutoscaler` field, you do not need to configure the `AutoScalingMetrics` and `AutoScalingBehavior` options and vice versa.| |
There was a problem hiding this comment.
@urfreespace since Function Mesh is built on Docusaurus, should we avoid using <br> in markdown tables?
freeznet
left a comment
There was a problem hiding this comment.
Overall the docs LGTM, but i would prefer to add an additional part to show user the options of BuiltinAutoscaler, ref: https://github.com/streamnative/function-mesh/blob/master/api/v1alpha1/hpa.go
0a3195d to
46805c8
Compare
@freeznet Thanks for your comments. Doc is updated. PTAL again. |
Update docs for Function Mesh v0.1.7 release based on
doc-required/doc-updatePRs.k8s.io/api/autoscaling/v2beta2function-mesh#245enablePackagesManagementin broker.conf function-mesh#255Note: PR 261 will be updated in a follow-up PR. Here is the related issue #93