tokers commented on a change in pull request #112: URL: https://github.com/apache/apisix-helm-chart/pull/112#discussion_r667593176
########## File path: docs/en/latest/apisix-dashboard.md ########## @@ -31,10 +31,38 @@ $ helm repo update $ helm install apisix-dashboard apisix/apisix-dashboard ``` +- Configure the custom plug-in JSONSchema [How to get jsonschema?](https://apisix.apache.org/docs/dashboard/FAQ/#4-after-modifying-the-plugin-schema-or-creating-a-custom-plugin-in-apache-apisix-why-cant-i-find-it-on-the-dashboard) + +```shell +helm install <name> apisix/apisix-dashboard . -n <namespace> --set-file config.schema=./schema.json +``` + ## Uninstall To uninstall/delete the `apisix-dashboard` release: ```shell $ helm uninstall apisix-dashboard ``` + +## Configuration + +Parameter | Description | Default +------------ | ------------- | ------------- + Config.conf | | + config.conf.listen.host | the address on which the `Manager API` should listen. | 0.0.0.0 + config.conf.listen.port | The port on which the `Manager API` should listen. | 9000 + config.conf.etcd.endpoints | upports defining multiple etcd host addresses for an etcd cluster | [apisix-etcd:2379] + config.conf.etcd.prefix | apisix config's prefix in etcd | /apisix + config.conf.etcd.username | ignore etcd username if not enable etcd auth | nil + config.conf.etcd.password | ignore etcd password if not enable etcd auth | nil + config.conf.log.errorLog.level | supports levels, lower to higher: debug, info, warn, error, panic, fatal | warn + config.conf.log.errorLog.filePath | supports relative path, absolute path, standard output | /dev/stderr + config.conf.log.accessLog.filePath | supports relative path, absolute path, standard output | /dev/stdout + Config.authentication | | Review comment: Ditto. ########## File path: docs/en/latest/apisix-dashboard.md ########## @@ -31,10 +31,38 @@ $ helm repo update $ helm install apisix-dashboard apisix/apisix-dashboard ``` +- Configure the custom plug-in JSONSchema [How to get jsonschema?](https://apisix.apache.org/docs/dashboard/FAQ/#4-after-modifying-the-plugin-schema-or-creating-a-custom-plugin-in-apache-apisix-why-cant-i-find-it-on-the-dashboard) + +```shell +helm install <name> apisix/apisix-dashboard . -n <namespace> --set-file config.schema=./schema.json +``` + ## Uninstall To uninstall/delete the `apisix-dashboard` release: ```shell $ helm uninstall apisix-dashboard ``` + +## Configuration + +Parameter | Description | Default +------------ | ------------- | ------------- + Config.conf | | Review comment: `config`? ########## File path: docs/en/latest/apisix-dashboard.md ########## @@ -31,10 +31,38 @@ $ helm repo update $ helm install apisix-dashboard apisix/apisix-dashboard ``` +- Configure the custom plug-in JSONSchema [How to get jsonschema?](https://apisix.apache.org/docs/dashboard/FAQ/#4-after-modifying-the-plugin-schema-or-creating-a-custom-plugin-in-apache-apisix-why-cant-i-find-it-on-the-dashboard) + +```shell +helm install <name> apisix/apisix-dashboard . -n <namespace> --set-file config.schema=./schema.json +``` + ## Uninstall To uninstall/delete the `apisix-dashboard` release: ```shell $ helm uninstall apisix-dashboard ``` + +## Configuration + +Parameter | Description | Default +------------ | ------------- | ------------- + Config.conf | | + config.conf.listen.host | the address on which the `Manager API` should listen. | 0.0.0.0 + config.conf.listen.port | The port on which the `Manager API` should listen. | 9000 + config.conf.etcd.endpoints | upports defining multiple etcd host addresses for an etcd cluster | [apisix-etcd:2379] + config.conf.etcd.prefix | apisix config's prefix in etcd | /apisix + config.conf.etcd.username | ignore etcd username if not enable etcd auth | nil + config.conf.etcd.password | ignore etcd password if not enable etcd auth | nil + config.conf.log.errorLog.level | supports levels, lower to higher: debug, info, warn, error, panic, fatal | warn + config.conf.log.errorLog.filePath | supports relative path, absolute path, standard output | /dev/stderr + config.conf.log.accessLog.filePath | supports relative path, absolute path, standard output | /dev/stdout + Config.authentication | | + config.authentication.secert | secret for jwt token generation. | secert + config.authentication.expireTime | jwt token expire time, in second | 3600 + config.authentication.users | username and password for login `Manager API` | + Config.schema | | Review comment: Ditto. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
