You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by GitBox <gi...@apache.org> on 2021/07/07 17:39:49 UTC

[GitHub] [apisix-helm-chart] dickens7 opened a new pull request #112: feat: Optimize configuration items, add etcd.prefix and schema

dickens7 opened a new pull request #112:
URL: https://github.com/apache/apisix-helm-chart/pull/112


   #111


-- 
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: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [apisix-helm-chart] dickens7 closed pull request #112: feat: Optimize configuration items, add etcd.prefix and schema for dashboard

Posted by GitBox <gi...@apache.org>.
dickens7 closed pull request #112:
URL: https://github.com/apache/apisix-helm-chart/pull/112


   


-- 
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: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [apisix-helm-chart] dickens7 commented on a change in pull request #112: feat: Optimize configuration items, add etcd.prefix and schema for dashboard

Posted by GitBox <gi...@apache.org>.
dickens7 commented on a change in pull request #112:
URL: https://github.com/apache/apisix-helm-chart/pull/112#discussion_r671081283



##########
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:
       Here is a separator to separate configuration items




-- 
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: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [apisix-helm-chart] dickens7 commented on a change in pull request #112: feat: Optimize configuration items, add etcd.prefix and schema for dashboard

Posted by GitBox <gi...@apache.org>.
dickens7 commented on a change in pull request #112:
URL: https://github.com/apache/apisix-helm-chart/pull/112#discussion_r667337329



##########
File path: docs/en/latest/apisix-dashboard.md
##########
@@ -31,10 +31,42 @@ $ helm repo update
 $ helm install apisix-dashboard apisix/apisix-dashboard
 ```
 
+- Configure the custom plug-in JSONSchema
+
+```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
 ```
+
+First Header | Second Header
+------------ | -------------
+Content from cell 1 | Content from cell 2
+Content in the first column | Content in the second column

Review comment:
       fixed




-- 
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: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [apisix-helm-chart] nic-chen commented on a change in pull request #112: feat: Optimize configuration items, add etcd.prefix and schema for dashboard

Posted by GitBox <gi...@apache.org>.
nic-chen commented on a change in pull request #112:
URL: https://github.com/apache/apisix-helm-chart/pull/112#discussion_r667285342



##########
File path: docs/en/latest/apisix-dashboard.md
##########
@@ -31,10 +31,42 @@ $ helm repo update
 $ helm install apisix-dashboard apisix/apisix-dashboard
 ```
 
+- Configure the custom plug-in JSONSchema
+
+```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
 ```
+
+First Header | Second Header
+------------ | -------------
+Content from cell 1 | Content from cell 2
+Content in the first column | Content in the second column
+
+## 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 |  |  
+ config.schema | Configure the custom plug-in JSONSchema | 

Review comment:
       It should be the entire JSONSchema, not just the custom plug-in JSONSchema
   




-- 
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: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [apisix-helm-chart] dickens7 commented on a change in pull request #112: feat: Optimize configuration items, add etcd.prefix and schema for dashboard

Posted by GitBox <gi...@apache.org>.
dickens7 commented on a change in pull request #112:
URL: https://github.com/apache/apisix-helm-chart/pull/112#discussion_r667337343



##########
File path: charts/apisix-dashboard/templates/configmap.yaml
##########
@@ -60,3 +63,7 @@ data:
           password: {{ .password }}
         {{- end }}
     {{- end }}
+  {{ if .Values.config.schema }}
+  schema.json: |-
+{{ .Values.config.schema | indent 4 }}
+  {{ end }}

Review comment:
       fixed




-- 
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: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [apisix-helm-chart] nic-chen commented on a change in pull request #112: feat: Optimize configuration items, add etcd.prefix and schema for dashboard

Posted by GitBox <gi...@apache.org>.
nic-chen commented on a change in pull request #112:
URL: https://github.com/apache/apisix-helm-chart/pull/112#discussion_r667285206



##########
File path: docs/en/latest/apisix-dashboard.md
##########
@@ -31,10 +31,42 @@ $ helm repo update
 $ helm install apisix-dashboard apisix/apisix-dashboard
 ```
 
+- Configure the custom plug-in JSONSchema
+
+```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
 ```
+
+First Header | Second Header
+------------ | -------------
+Content from cell 1 | Content from cell 2
+Content in the first column | Content in the second column
+
+## 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` | 

Review comment:
       ```suggestion
    config.authentication.users | username and password for login `Manager API` | 
   ```




-- 
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: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [apisix-helm-chart] tokers commented on a change in pull request #112: feat: Optimize configuration items, add etcd.prefix and schema for dashboard

Posted by GitBox <gi...@apache.org>.
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: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [apisix-helm-chart] dickens7 commented on a change in pull request #112: feat: Optimize configuration items, add etcd.prefix and schema for dashboard

Posted by GitBox <gi...@apache.org>.
dickens7 commented on a change in pull request #112:
URL: https://github.com/apache/apisix-helm-chart/pull/112#discussion_r667337510



##########
File path: docs/en/latest/apisix-dashboard.md
##########
@@ -31,10 +31,42 @@ $ helm repo update
 $ helm install apisix-dashboard apisix/apisix-dashboard
 ```
 
+- Configure the custom plug-in JSONSchema
+
+```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
 ```
+
+First Header | Second Header
+------------ | -------------
+Content from cell 1 | Content from cell 2
+Content in the first column | Content in the second column
+
+## 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 |  |  
+ config.schema | Configure the custom plug-in JSONSchema | 

Review comment:
       This configuration parameter description has been optimized




-- 
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: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [apisix-helm-chart] tokers commented on a change in pull request #112: feat: Optimize configuration items, add etcd.prefix and schema for dashboard

Posted by GitBox <gi...@apache.org>.
tokers commented on a change in pull request #112:
URL: https://github.com/apache/apisix-helm-chart/pull/112#discussion_r667284312



##########
File path: charts/apisix-dashboard/templates/configmap.yaml
##########
@@ -60,3 +63,7 @@ data:
           password: {{ .password }}
         {{- end }}
     {{- end }}
+  {{ if .Values.config.schema }}
+  schema.json: |-
+{{ .Values.config.schema | indent 4 }}
+  {{ end }}

Review comment:
       Missing the EOS symbol.




-- 
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: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [apisix-helm-chart] starsz commented on a change in pull request #112: feat: Optimize configuration items, add etcd.prefix and schema for dashboard

Posted by GitBox <gi...@apache.org>.
starsz commented on a change in pull request #112:
URL: https://github.com/apache/apisix-helm-chart/pull/112#discussion_r667284553



##########
File path: docs/en/latest/apisix-dashboard.md
##########
@@ -31,10 +31,42 @@ $ helm repo update
 $ helm install apisix-dashboard apisix/apisix-dashboard
 ```
 
+- Configure the custom plug-in JSONSchema
+
+```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
 ```
+
+First Header | Second Header
+------------ | -------------
+Content from cell 1 | Content from cell 2
+Content in the first column | Content in the second column

Review comment:
       Hello. What's this?




-- 
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: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org