Skip to content

Commit ade7c1e

Browse files
committedFeb 17, 2022
docs: Update SUPPORT.md and fix check-apiserver-connectivity documentation
1 parent dfc3eaa commit ade7c1e

File tree

2 files changed

+19
-32
lines changed

2 files changed

+19
-32
lines changed
 

‎SUPPORT.md

+7-20
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,12 @@
1-
# TODO: The maintainer of this repo has not yet edited this file
2-
3-
**REPO OWNER**: Do you want Customer Service & Support (CSS) support for this product/project?
4-
5-
- **No CSS support:** Fill out this template with information about how to file issues and get help.
6-
- **Yes CSS support:** Fill out an intake form at [aka.ms/spot](https://aka.ms/spot). CSS will work with/help you to determine next steps. More details also available at [aka.ms/onboardsupport](https://aka.ms/onboardsupport).
7-
- **Not sure?** Fill out a SPOT intake as though the answer were "Yes". CSS will help you decide.
8-
9-
*Then remove this first heading from this SUPPORT.MD file before publishing your repo.*
10-
111
# Support
122

13-
## How to file issues and get help
14-
15-
This project uses GitHub Issues to track bugs and feature requests. Please search the existing
16-
issues before filing new issues to avoid duplicates. For new issues, file your bug or
17-
feature request as a new Issue.
3+
## How to file issues and get help
184

19-
For help and questions about using this project, please **REPO MAINTAINER: INSERT INSTRUCTIONS HERE
20-
FOR HOW TO ENGAGE REPO OWNERS OR COMMUNITY FOR HELP. COULD BE A STACK OVERFLOW TAG OR OTHER
21-
CHANNEL. WHERE WILL YOU HELP PEOPLE?**.
5+
This project uses GitHub Issues to track bugs and feature requests. Please
6+
search the existing issues before filing new issues to avoid duplicates. For
7+
new issues, file your bug or feature request as a new Issue.
228

23-
## Microsoft Support Policy
9+
## Microsoft Support Policy
2410

25-
Support for this **PROJECT or PRODUCT** is limited to the resources listed above.
11+
Support for this **PROJECT or PRODUCT** is limited to the resources listed
12+
above.

‎docs/check-apiserver-connectivity.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# Check Connectivity
1+
# Check API Server Connectivity
22

3-
We can use `check-connectivity` to verify that nodes can communicate with the
4-
Kubernetes API server:
3+
We can use `check-apiserver-connectivity` to verify that nodes can communicate
4+
with the Kubernetes API server:
55

66
```bash
77
$ kubectl get nodes
@@ -26,13 +26,13 @@ $ kubectl az check-apiserver-connectivity --id "/subscriptions/$SUBSCRIPTION/res
2626
$ kubectl az check-apiserver-connectivity --subscription $SUBSCRIPTION --node-resource-group $NODERESOURCEGROUP --vmss $VMSS --instance-id $INSTANCEID
2727
```
2828

29-
The `check-connectivity` command verifies the connectivity between the nodes and
30-
the API server by executing the command `kubectl version` from the node itself.
31-
This command will try to contact the API server to get the Kubernetes version it
32-
is running, which is enough to verify the connectivity. We have to consider that
33-
`kubectl` uses the URL of the API server available in the `kubeconfig` file and
34-
not directly the IP address. It means that this connectivity check requires the
35-
DNS to be working correctly to succeed.
29+
The `check-apiserver-connectivity` command verifies the connectivity between the
30+
nodes and the API server by executing the command `kubectl version` from the
31+
node itself. This command will try to contact the API server to get the
32+
Kubernetes version it is running, which is enough to verify the connectivity. We
33+
have to consider that `kubectl` uses the URL of the API server available in the
34+
`kubeconfig` file and not directly the IP address. It means that this
35+
connectivity check requires the DNS to be working correctly to succeed.
3636

3737
We can use the flag `-v`/`--verbose` to have further details about the command
3838
that is being executed in the nodes to check connectivity:
@@ -65,7 +65,7 @@ Response:
6565
Connectivity check: succeeded
6666
```
6767

68-
Given that the `check-connectivity` command checks the connectivity by running a
69-
command on the nodes, all the
68+
Given that the `check-apiserver-connectivity` command checks the connectivity by
69+
running a command on the nodes, all the
7070
[restrictions](https://docs.microsoft.com/en-us/azure/virtual-machines/linux/run-command#restrictions)
7171
of running scripts in an Azure Linux VM also apply here.

0 commit comments

Comments
 (0)
Please sign in to comment.