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 2020/11/06 08:00:16 UTC

[GitHub] [apisix-dashboard] nic-chen opened a new pull request #711: doc: fix deploy doc

nic-chen opened a new pull request #711:
URL: https://github.com/apache/apisix-dashboard/pull/711


   remove useless description
   fix config description.


----------------------------------------------------------------
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.

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

[GitHub] [apisix-dashboard] nic-chen commented on a change in pull request #711: fix: deploy doc

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



##########
File path: docs/deploy.md
##########
@@ -81,7 +81,7 @@ The bundled files are located in the root directory `/output/html`.
 
 ## Run
 
-1. According to your deploy environment, check the related configurations in `api/conf/conf.yaml`, modify those variables if needed.
+1. According to your deploy environment, check the related configurations in `output/conf/conf.yaml`, modify those variables if needed.

Review comment:
       Then he should change the config file in the directory he run. After  run `api/build.sh`, the directory of the binary file is `output`, changing `api/conf/conf.yaml` will not take effect.
   




----------------------------------------------------------------
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.

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

[GitHub] [apisix-dashboard] juzhiyuan commented on a change in pull request #711: fix: deploy doc

Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on a change in pull request #711:
URL: https://github.com/apache/apisix-dashboard/pull/711#discussion_r518849752



##########
File path: docs/deploy.md
##########
@@ -81,7 +81,7 @@ The bundled files are located in the root directory `/output/html`.
 
 ## Run
 
-1. According to your deploy environment, check the related configurations in `api/conf/conf.yaml`, modify those variables if needed.
+1. According to your deploy environment, check the related configurations in `output/conf/conf.yaml`, modify those variables if needed.

Review comment:
       According to your opinion, we should add some tips in the default config file, to let users know they can update the config only when the binary is generated.




----------------------------------------------------------------
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.

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

[GitHub] [apisix-dashboard] nic-chen commented on pull request #711: fix: deploy doc

Posted by GitBox <gi...@apache.org>.
nic-chen commented on pull request #711:
URL: https://github.com/apache/apisix-dashboard/pull/711#issuecomment-723361900


   > > @juzhiyuan @moonming
   > > Actually, users only need to care about `/output/conf/`, only developers need to care about `/api/conf/`
   > 
   > that is a bad way.
   > 
   > after build, we can generate `dag-to-lua` and `manager-api` in `/api`.
   > 
   > ```
   > $ tree ./ -L 1
   > ./
   > ├── conf
   > ├── dag-to-lua
   > ├── Dockerfile
   > ├── filter
   > ├── go.mod
   > ├── go.sum
   > ├── internal
   > ├── log
   > ├── logs
   > ├── manager-api
   > ├── README.md
   > └── test
   > ```
   
   
   We have other considerations, that is, users can directly copy the `output` directory to any location they want.
   
   
   


----------------------------------------------------------------
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.

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

[GitHub] [apisix-dashboard] juzhiyuan commented on pull request #711: fix: deploy doc

Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on pull request #711:
URL: https://github.com/apache/apisix-dashboard/pull/711#issuecomment-723364900


   Why not use a template-configuration? No matter use a standalone file or just added them to codes.


----------------------------------------------------------------
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.

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

[GitHub] [apisix-dashboard] juzhiyuan commented on a change in pull request #711: fix: deploy doc

Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on a change in pull request #711:
URL: https://github.com/apache/apisix-dashboard/pull/711#discussion_r518655405



##########
File path: docs/deploy.md
##########
@@ -81,7 +81,7 @@ The bundled files are located in the root directory `/output/html`.
 
 ## Run
 
-1. According to your deploy environment, check the related configurations in `api/conf/conf.yaml`, modify those variables if needed.
+1. According to your deploy environment, check the related configurations in `output/conf/conf.yaml`, modify those variables if needed.

Review comment:
       But we don't havr that directory in source codes, and users can choose not to run the binary file in that folder.




----------------------------------------------------------------
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.

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

[GitHub] [apisix-dashboard] membphis commented on pull request #711: fix: deploy doc

Posted by GitBox <gi...@apache.org>.
membphis commented on pull request #711:
URL: https://github.com/apache/apisix-dashboard/pull/711#issuecomment-723360929


   > @juzhiyuan @moonming
   > 
   > Actually, users only need to care about `/output/conf/`, only developers need to care about `/api/conf/`
   
   that is a bad way. 
   
   after build, we can generate `dag-to-lua` and `manager-api` in `/api`.
   
   ```
   $ tree ./ -L 1
   ./
   ├── conf
   ├── dag-to-lua
   ├── Dockerfile
   ├── filter
   ├── go.mod
   ├── go.sum
   ├── internal
   ├── log
   ├── logs
   ├── manager-api
   ├── README.md
   └── test
   ```


----------------------------------------------------------------
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.

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

[GitHub] [apisix-dashboard] juzhiyuan commented on pull request #711: fix: deploy doc

Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on pull request #711:
URL: https://github.com/apache/apisix-dashboard/pull/711#issuecomment-723364294


   @membphis Yes, we couldn't build it under the api directory due to users may copy them and move them to another place.


----------------------------------------------------------------
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.

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

[GitHub] [apisix-dashboard] nic-chen commented on pull request #711: fix: deploy doc

Posted by GitBox <gi...@apache.org>.
nic-chen commented on pull request #711:
URL: https://github.com/apache/apisix-dashboard/pull/711#issuecomment-723356469


   @juzhiyuan @moonming 
   
   Actually, users only need to care about `/output/conf/`, only developers need to care about `/api/conf/`
   
   


----------------------------------------------------------------
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.

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

[GitHub] [apisix-dashboard] gxthrj edited a comment on pull request #711: fix: deploy doc

Posted by GitBox <gi...@apache.org>.
gxthrj edited a comment on pull request #711:
URL: https://github.com/apache/apisix-dashboard/pull/711#issuecomment-723388215


   I create a new issue to improve #715 


----------------------------------------------------------------
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.

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

[GitHub] [apisix-dashboard] gxthrj commented on pull request #711: fix: deploy doc

Posted by GitBox <gi...@apache.org>.
gxthrj commented on pull request #711:
URL: https://github.com/apache/apisix-dashboard/pull/711#issuecomment-723388215


   I create a new issue to impove #715 


----------------------------------------------------------------
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.

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

[GitHub] [apisix-dashboard] juzhiyuan commented on pull request #711: fix: deploy doc

Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on pull request #711:
URL: https://github.com/apache/apisix-dashboard/pull/711#issuecomment-723358007


   > @juzhiyuan @moonming 
   > 
   > Actually, users only need to care about `/output/conf/`, only developers need to care about `/api/conf/`
   > 
   > 
   
   But users don't know 


----------------------------------------------------------------
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.

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

[GitHub] [apisix-dashboard] nic-chen closed pull request #711: fix: deploy doc

Posted by GitBox <gi...@apache.org>.
nic-chen closed pull request #711:
URL: https://github.com/apache/apisix-dashboard/pull/711


   


----------------------------------------------------------------
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.

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

[GitHub] [apisix-dashboard] juzhiyuan commented on a change in pull request #711: fix: deploy doc

Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on a change in pull request #711:
URL: https://github.com/apache/apisix-dashboard/pull/711#discussion_r518655405



##########
File path: docs/deploy.md
##########
@@ -81,7 +81,7 @@ The bundled files are located in the root directory `/output/html`.
 
 ## Run
 
-1. According to your deploy environment, check the related configurations in `api/conf/conf.yaml`, modify those variables if needed.
+1. According to your deploy environment, check the related configurations in `output/conf/conf.yaml`, modify those variables if needed.

Review comment:
       But we don't have that directory in source codes, and users can choose not to run the binary file in that folder.




----------------------------------------------------------------
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.

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

[GitHub] [apisix-dashboard] nic-chen commented on a change in pull request #711: fix: deploy doc

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



##########
File path: docs/deploy.md
##########
@@ -81,7 +81,7 @@ The bundled files are located in the root directory `/output/html`.
 
 ## Run
 
-1. According to your deploy environment, check the related configurations in `api/conf/conf.yaml`, modify those variables if needed.
+1. According to your deploy environment, check the related configurations in `output/conf/conf.yaml`, modify those variables if needed.

Review comment:
       or what's your suggestion ? @juzhiyuan 




----------------------------------------------------------------
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.

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

[GitHub] [apisix-dashboard] membphis commented on pull request #711: fix: deploy doc

Posted by GitBox <gi...@apache.org>.
membphis commented on pull request #711:
URL: https://github.com/apache/apisix-dashboard/pull/711#issuecomment-723387274


   I think we need refractory the deploy doc.
   
   Let us discuss in issue first.


----------------------------------------------------------------
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.

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

[GitHub] [apisix-dashboard] moonming commented on a change in pull request #711: fix: deploy doc

Posted by GitBox <gi...@apache.org>.
moonming commented on a change in pull request #711:
URL: https://github.com/apache/apisix-dashboard/pull/711#discussion_r519055960



##########
File path: docs/deploy.md
##########
@@ -81,7 +81,7 @@ The bundled files are located in the root directory `/output/html`.
 
 ## Run
 
-1. According to your deploy environment, check the related configurations in `api/conf/conf.yaml`, modify those variables if needed.
+1. According to your deploy environment, check the related configurations in `output/conf/conf.yaml`, modify those variables if needed.

Review comment:
       This is unacceptable, there can only be one configuration file




----------------------------------------------------------------
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.

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

[GitHub] [apisix-dashboard] nic-chen commented on a change in pull request #711: doc: fix deploy doc

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



##########
File path: docs/deploy.md
##########
@@ -81,7 +81,7 @@ The bundled files are located in the root directory `/output/html`.
 
 ## Run
 
-1. According to your deploy environment, check the related configurations in `api/conf/conf.yaml`, modify those variables if needed.
+1. According to your deploy environment, check the related configurations in `output/conf/conf.yaml`, modify those variables if needed.

Review comment:
       The binary program we run is in the `output` directory, so the config file it reads is `output/conf/conf.yaml`
   




----------------------------------------------------------------
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.

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

[GitHub] [apisix-dashboard] juzhiyuan commented on a change in pull request #711: doc: fix deploy doc

Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on a change in pull request #711:
URL: https://github.com/apache/apisix-dashboard/pull/711#discussion_r518606469



##########
File path: docs/deploy.md
##########
@@ -114,18 +113,15 @@ $ api/run.sh &
 
 ## Configuration
 
-1. `conf.dag-lib-path` MUST use absolute path, we could use `pwd` command. Only used when enable Plugin Orchestration.
+1. `conf.listen.host` is set to `127.0.0.1` so we could only visit it in private, we could change it to `0.0.0.0` to allow any visitors.
 
-2. `conf.listen.host` is set to `127.0.0.1` so we could only visit it in private, we could change it to `0.0.0.0` to allow any visitors.
-
-3. `conf.etcd.endpoints` is used to set ETCD's instances address, it supports multiple instances mode.
+2. `conf.etcd.endpoints` is used to set ETCD's instances address, it supports multiple instances mode.
 
 ```json
-{
-  "etcd": {
-    "endpoints": "127.0.0.1:2379,127.0.0.1:3379"
-  }
-}
+  etcd:
+    endpoints:
+      - 127.0.0.1:2379
+      - 127.0.0.1:3379

Review comment:
       ![image](https://user-images.githubusercontent.com/2106987/98346272-b02ace80-2050-11eb-90af-461d4c5b20c0.png)
   

##########
File path: docs/deploy.md
##########
@@ -81,7 +81,7 @@ The bundled files are located in the root directory `/output/html`.
 
 ## Run
 
-1. According to your deploy environment, check the related configurations in `api/conf/conf.yaml`, modify those variables if needed.
+1. According to your deploy environment, check the related configurations in `output/conf/conf.yaml`, modify those variables if needed.

Review comment:
       Why? The output folder is generated only when we run the shell.




----------------------------------------------------------------
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.

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

[GitHub] [apisix-dashboard] juzhiyuan edited a comment on pull request #711: fix: deploy doc

Posted by GitBox <gi...@apache.org>.
juzhiyuan edited a comment on pull request #711:
URL: https://github.com/apache/apisix-dashboard/pull/711#issuecomment-723364900


   How about using a template-configuration? No matter use a standalone file or just added them to codes.


----------------------------------------------------------------
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.

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

[GitHub] [apisix-dashboard] juzhiyuan commented on a change in pull request #711: fix: deploy doc

Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on a change in pull request #711:
URL: https://github.com/apache/apisix-dashboard/pull/711#discussion_r518737954



##########
File path: docs/deploy.md
##########
@@ -81,7 +81,7 @@ The bundled files are located in the root directory `/output/html`.
 
 ## Run
 
-1. According to your deploy environment, check the related configurations in `api/conf/conf.yaml`, modify those variables if needed.
+1. According to your deploy environment, check the related configurations in `output/conf/conf.yaml`, modify those variables if needed.

Review comment:
       1. Before building the binary file, we should update the config file under the `/api/conf/` directory, right?
   2. After building successfully, we have the output directory.
   3. When users want to update the config file without rebuilding the binary file, they must modify the file under the `/output` directory.




----------------------------------------------------------------
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.

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

[GitHub] [apisix-dashboard] nic-chen commented on pull request #711: fix: deploy doc

Posted by GitBox <gi...@apache.org>.
nic-chen commented on pull request #711:
URL: https://github.com/apache/apisix-dashboard/pull/711#issuecomment-723593497


   so this pr should be closed now.


----------------------------------------------------------------
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.

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