Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update accessing apps service doc #13806

Merged
merged 2 commits into from
May 17, 2022

Conversation

zhan9san
Copy link
Contributor

fix #13788 #13747

Would you kindly review this doc update?

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Mar 17, 2022
@k8s-ci-robot
Copy link
Contributor

Hi @zhan9san. Thanks for your PR.

I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@k8s-ci-robot k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Mar 17, 2022
@minikube-bot
Copy link
Collaborator

Can one of the admins verify this patch?

@@ -11,6 +11,8 @@ aliases:

There are two major categories of services in Kubernetes:

[publishing-services-service-types](https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this doesnt seem to be relevent,

it says
"
There are two major categories of services in Kubernetes:

[publishing-services-service-types]
"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @medyagh

I though it may help users to access the kubernetes service type here.

This line has been removed and the PR is rebased on master branch.

Could you kindly review it again?

@AlexIoannides
Copy link

I found the information contained in the updated docs very useful and would have appreciated it in the latest (online) version.

Copy link
Member

@spowelljr spowelljr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just grammatical and capitalization changes, I'll be happy to merge once addressed


### Example of NodePort

1. Create a kubernetes deployment
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
1. Create a kubernetes deployment
1. Create a Kubernetes deployment

kubectl create deployment hello-minikube1 --image=k8s.gcr.io/echoserver:1.4
```

2. Create a kubernetes service type NodePort
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
2. Create a kubernetes service type NodePort
2. Create a Kubernetes service type NodePort

minikube service hello-minikube1 --url
```

`minikube service hello-minikube1 --url` runs as a process, creating a [tunnel](https://en.wikipedia.org/wiki/Port_forwarding#Local_port_forwarding) to cluster. The command exposes the service directly to any program running on the host operating system.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`minikube service hello-minikube1 --url` runs as a process, creating a [tunnel](https://en.wikipedia.org/wiki/Port_forwarding#Local_port_forwarding) to cluster. The command exposes the service directly to any program running on the host operating system.
`minikube service hello-minikube1 --url` runs as a process, creating a [tunnel](https://en.wikipedia.org/wiki/Port_forwarding#Local_port_forwarding) to the cluster. The command exposes the service directly to any program running on the host operating system.

</pre>
</details>

check ssh tunnel in another terminal
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
check ssh tunnel in another terminal
Check ssh tunnel in another terminal


5. Try in your browser

open in your browser (make sure there is no proxy set)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
open in your browser (make sure there is no proxy set)
Open in your browser (ensure there is no proxy set)

http://REPLACE_WITH_EXTERNAL_IP:8080
```

Each service will get its own external ip.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Each service will get its own external ip.
Each service will get its own external IP.

## Getting the NodePort using kubectl
### Using `minikube service` with tunnel

The network is limited if you are using a Docker driver on darwin, Windows or WSL, and the Node IP is not reachable directly.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The network is limited if you are using a Docker driver on darwin, Windows or WSL, and the Node IP is not reachable directly.
The network is limited if using the Docker driver on Darwin, Windows, or WSL, and the Node IP is not reachable directly.


#### Run tunnel in a separate terminal
1. Run tunnel in a separate terminal
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
1. Run tunnel in a separate terminal
1. Run the tunnel in a separate terminal


note that without minikube tunnel, kubernetes would be showing external IP as "pending".
4. Check external IP
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
4. Check external IP
4. Check the external IP


The network is limited if you are using a Docker driver on darwin, Windows or WSL, and the Node IP is not reachable directly.

If minikube runs on Linux with Docker driver, no tunnel will be created.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If minikube runs on Linux with Docker driver, no tunnel will be created.
Running minikube on Linux with the Docker driver will result in no tunnel being created.

@zhan9san
Copy link
Contributor Author

Hi @spowelljr

Thanks for your careful review.
The suggested changes have been made.

Could you help review it again?

Copy link
Member

@spowelljr spowelljr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thank you!

@spowelljr spowelljr merged commit c38987b into kubernetes:master May 17, 2022
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: spowelljr, zhan9san

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 17, 2022
@zhan9san zhan9san deleted the feature/update-service-doc branch May 19, 2022 03:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

services running on minikube cluster are inaccessible
6 participants