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 2022/12/19 08:28:19 UTC
[GitHub] [apisix] shreemaan-abhishek opened a new pull request, #8536: docs: add missing `kubectl exec` step in the installation guide.
shreemaan-abhishek opened a new pull request, #8536:
URL: https://github.com/apache/apisix/pull/8536
### Description
<!-- Please include a summary of the change and which issue is fixed. -->
<!-- Please also include relevant motivation and context. -->
Fixes #8530
Slack discussion: https://the-asf.slack.com/archives/CUC5MN17A/p1671152569546829
### Checklist
- [x] I have explained the need for this PR and the problem it solves. (Check the issue description)
- [ ] I have explained the changes or the new features added to this PR. (Irrelevant)
- [ ] I have added tests corresponding to this change. (NA)
- [x] I have updated the documentation to reflect this change.
- [x] I have verified that this change is backward compatible (If not, please discuss on the [APISIX mailing list](https://github.com/apache/apisix/tree/master#community) first)
<!--
Note
1. Mark the PR as draft until it's ready to be reviewed.
2. Always add/update tests for any changes unless you have a good reason.
3. Always update the documentation to reflect the changes made in the PR.
4. Make a new commit to resolve conversations instead of `push -f`.
5. To resolve merge conflicts, merge master instead of rebasing.
6. Use "request review" to notify the reviewer after making changes.
7. Only a reviewer can mark a conversation as resolved.
-->
--
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] navendu-pottekkat commented on pull request #8536: docs: add missing `kubectl exec` step in the installation guide.
Posted by GitBox <gi...@apache.org>.
navendu-pottekkat commented on PR #8536:
URL: https://github.com/apache/apisix/pull/8536#issuecomment-1365650815
@tokers @bzp2010 please review and merge.
--
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] tokers commented on a diff in pull request #8536: docs: add missing `kubectl exec` step in the installation guide.
Posted by GitBox <gi...@apache.org>.
tokers commented on code in PR #8536:
URL: https://github.com/apache/apisix/pull/8536#discussion_r1051981621
##########
docs/en/latest/installation-guide.md:
##########
@@ -216,6 +216,12 @@ brew services start etcd
### Configuring APISIX
+If you install APISIX via Docker, please exec into the apisix pod first:
Review Comment:
Got it.
--
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] navendu-pottekkat commented on a diff in pull request #8536: docs: add missing `kubectl exec` step in the installation guide.
Posted by GitBox <gi...@apache.org>.
navendu-pottekkat commented on code in PR #8536:
URL: https://github.com/apache/apisix/pull/8536#discussion_r1051976989
##########
docs/en/latest/installation-guide.md:
##########
@@ -216,6 +216,11 @@ brew services start etcd
### Configuring APISIX
+If you install APISIX via Docker, please exec into the apisix pod first:
+```shell
+kubectl exec -it <name-of-apisix-pod> -n <namespace-running-apisix> -- sh
+```
+
Review Comment:
Yes, that should be fine I think. Unless there is a better way.
--
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] navendu-pottekkat commented on a diff in pull request #8536: docs: add missing `kubectl exec` step in the installation guide.
Posted by GitBox <gi...@apache.org>.
navendu-pottekkat commented on code in PR #8536:
URL: https://github.com/apache/apisix/pull/8536#discussion_r1051980605
##########
docs/en/latest/installation-guide.md:
##########
@@ -216,6 +216,12 @@ brew services start etcd
### Configuring APISIX
+If you install APISIX via Docker, please exec into the apisix pod first:
Review Comment:
@tokers Please see this suggestion to this problem: https://github.com/apache/apisix/pull/8536#discussion_r1051960354
--
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] navendu-pottekkat commented on a diff in pull request #8536: docs: add missing `kubectl exec` step in the installation guide.
Posted by GitBox <gi...@apache.org>.
navendu-pottekkat commented on code in PR #8536:
URL: https://github.com/apache/apisix/pull/8536#discussion_r1051960354
##########
docs/en/latest/installation-guide.md:
##########
@@ -216,6 +216,11 @@ brew services start etcd
### Configuring APISIX
+If you install APISIX via Docker, please exec into the apisix pod first:
+```shell
+kubectl exec -it <name-of-apisix-pod> -n <namespace-running-apisix> -- sh
+```
+
Review Comment:
Can you highlight this as a note? You can use the admonition `:::note`.
Please add spaces around the code blocks (between ```shell and the text). There should be a failing lint check otherwise.
If you install APISIX via Docker, you need to exec into the "apisix" container to run the `apisix` command:
```
command to exec into Docker container from host machine and running the apisix command
```
In Kubernetes, you can do this by running:
```
existing command mentioned in the PR
```
--
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] shreemaan-abhishek commented on a diff in pull request #8536: docs: add missing `kubectl exec` step in the installation guide.
Posted by GitBox <gi...@apache.org>.
shreemaan-abhishek commented on code in PR #8536:
URL: https://github.com/apache/apisix/pull/8536#discussion_r1051978303
##########
docs/en/latest/installation-guide.md:
##########
@@ -216,6 +216,12 @@ brew services start etcd
### Configuring APISIX
+If you install APISIX via Docker, please exec into the apisix pod first:
Review Comment:
I think the appropriate prompt would be: "If you have done the kubernetes/docker/helm-based installation" WDYT?
--
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] shreemaan-abhishek commented on a diff in pull request #8536: docs: add missing `kubectl exec` step in the installation guide.
Posted by GitBox <gi...@apache.org>.
shreemaan-abhishek commented on code in PR #8536:
URL: https://github.com/apache/apisix/pull/8536#discussion_r1051972936
##########
docs/en/latest/installation-guide.md:
##########
@@ -216,6 +216,11 @@ brew services start etcd
### Configuring APISIX
+If you install APISIX via Docker, please exec into the apisix pod first:
+```shell
+kubectl exec -it <name-of-apisix-pod> -n <namespace-running-apisix> -- sh
+```
+
Review Comment:
I should highlight the entire new addition with the admonition `::note`? 🤔
--
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] juzhiyuan commented on a diff in pull request #8536: docs: add missing `kubectl exec` step in the installation guide.
Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on code in PR #8536:
URL: https://github.com/apache/apisix/pull/8536#discussion_r1051935403
##########
docs/en/latest/installation-guide.md:
##########
@@ -216,6 +216,11 @@ brew services start etcd
### Configuring APISIX
+First exec into the apisix pod:
Review Comment:
```suggestion
If you install APISIX via Docker, please exec into the apisix pod 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.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] shreemaan-abhishek commented on a diff in pull request #8536: docs: add missing `kubectl exec` step in the installation guide.
Posted by GitBox <gi...@apache.org>.
shreemaan-abhishek commented on code in PR #8536:
URL: https://github.com/apache/apisix/pull/8536#discussion_r1051974240
##########
docs/en/latest/installation-guide.md:
##########
@@ -216,6 +216,12 @@ brew services start etcd
### Configuring APISIX
+If you install APISIX via Docker, please exec into the apisix pod first:
Review Comment:
@tokers I meant this type of installation using docker:
<img width="748" alt="image" src="https://user-images.githubusercontent.com/61597896/208391871-c1cc7d47-fc41-4551-9bce-def0260e3c86.png">
--
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] shreemaan-abhishek commented on pull request #8536: docs: add missing `kubectl exec` step in the installation guide.
Posted by GitBox <gi...@apache.org>.
shreemaan-abhishek commented on PR #8536:
URL: https://github.com/apache/apisix/pull/8536#issuecomment-1357371651
Could someone please re-request a review from bzp2010? I think I mistakenly removed request from them.
--
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] tokers commented on a diff in pull request #8536: docs: add missing `kubectl exec` step in the installation guide.
Posted by GitBox <gi...@apache.org>.
tokers commented on code in PR #8536:
URL: https://github.com/apache/apisix/pull/8536#discussion_r1051978857
##########
docs/en/latest/installation-guide.md:
##########
@@ -216,6 +216,12 @@ brew services start etcd
### Configuring APISIX
+If you install APISIX via Docker, please exec into the apisix pod first:
Review Comment:
Then why do users need to execute `kubectl`? It should be `docker`.
--
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] navendu-pottekkat commented on a diff in pull request #8536: docs: add missing `kubectl exec` step in the installation guide.
Posted by GitBox <gi...@apache.org>.
navendu-pottekkat commented on code in PR #8536:
URL: https://github.com/apache/apisix/pull/8536#discussion_r1057434216
##########
docs/en/latest/installation-guide.md:
##########
@@ -216,6 +216,22 @@ brew services start etcd
### Configuring APISIX
+:::note
+
+If you have done the Docker based installation, you need to exec into the `apisix` docker container to run the `apisix` command:
+
+```shell
+docker exec -it <name-of-container/container-id> sh
+```
+
+If you have installed via helm, you need to exec into the `apisix` kubernetes pod to run the `apisix` command:
+
+```shell
+kubectl exec -it <name-of-apisix-pod> -n <namespace-running-apisix> -- sh
+```
+
+:::
Review Comment:
Last ask, could you move this to after point "2"? It makes more sense to mention this after we mention "running the apisix command."
--
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] tokers commented on a diff in pull request #8536: docs: add missing `kubectl exec` step in the installation guide.
Posted by GitBox <gi...@apache.org>.
tokers commented on code in PR #8536:
URL: https://github.com/apache/apisix/pull/8536#discussion_r1051970843
##########
docs/en/latest/installation-guide.md:
##########
@@ -216,6 +216,12 @@ brew services start etcd
### Configuring APISIX
+If you install APISIX via Docker, please exec into the apisix pod first:
Review Comment:
Docker? The command is `kubectl`.
--
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] juzhiyuan merged pull request #8536: docs: add missing `kubectl exec` step in the installation guide.
Posted by GitBox <gi...@apache.org>.
juzhiyuan merged PR #8536:
URL: https://github.com/apache/apisix/pull/8536
--
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] shreemaan-abhishek commented on pull request #8536: docs: add missing `kubectl exec` step in the installation guide.
Posted by GitBox <gi...@apache.org>.
shreemaan-abhishek commented on PR #8536:
URL: https://github.com/apache/apisix/pull/8536#issuecomment-1357288369
whoops! I'll run the linting command once again from my local. 😓
--
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