docs: Update SUPPORT.md and fix check-apiserver-connectivity documentation

This commit is contained in:
Jose Blanquicet 2022-02-17 08:30:44 +01:00
Родитель dfc3eaae64
Коммит ade7c1e027
2 изменённых файлов: 19 добавлений и 32 удалений

Просмотреть файл

@ -1,25 +1,12 @@
# TODO: The maintainer of this repo has not yet edited this file
**REPO OWNER**: Do you want Customer Service & Support (CSS) support for this product/project?
- **No CSS support:** Fill out this template with information about how to file issues and get help.
- **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).
- **Not sure?** Fill out a SPOT intake as though the answer were "Yes". CSS will help you decide.
*Then remove this first heading from this SUPPORT.MD file before publishing your repo.*
# Support
## How to file issues and get help
## How to file issues and get help
This project uses GitHub Issues to track bugs and feature requests. Please search the existing
issues before filing new issues to avoid duplicates. For new issues, file your bug or
feature request as a new Issue.
This project uses GitHub Issues to track bugs and feature requests. Please
search the existing issues before filing new issues to avoid duplicates. For
new issues, file your bug or feature request as a new Issue.
For help and questions about using this project, please **REPO MAINTAINER: INSERT INSTRUCTIONS HERE
FOR HOW TO ENGAGE REPO OWNERS OR COMMUNITY FOR HELP. COULD BE A STACK OVERFLOW TAG OR OTHER
CHANNEL. WHERE WILL YOU HELP PEOPLE?**.
## Microsoft Support Policy
## Microsoft Support Policy
Support for this **PROJECT or PRODUCT** is limited to the resources listed above.
Support for this **PROJECT or PRODUCT** is limited to the resources listed
above.

Просмотреть файл

@ -1,7 +1,7 @@
# Check Connectivity
# Check API Server Connectivity
We can use `check-connectivity` to verify that nodes can communicate with the
Kubernetes API server:
We can use `check-apiserver-connectivity` to verify that nodes can communicate
with the Kubernetes API server:
```bash
$ kubectl get nodes
@ -26,13 +26,13 @@ $ kubectl az check-apiserver-connectivity --id "/subscriptions/$SUBSCRIPTION/res
$ kubectl az check-apiserver-connectivity --subscription $SUBSCRIPTION --node-resource-group $NODERESOURCEGROUP --vmss $VMSS --instance-id $INSTANCEID
```
The `check-connectivity` command verifies the connectivity between the nodes and
the API server by executing the command `kubectl version` from the node itself.
This command will try to contact the API server to get the Kubernetes version it
is running, which is enough to verify the connectivity. We have to consider that
`kubectl` uses the URL of the API server available in the `kubeconfig` file and
not directly the IP address. It means that this connectivity check requires the
DNS to be working correctly to succeed.
The `check-apiserver-connectivity` command verifies the connectivity between the
nodes and the API server by executing the command `kubectl version` from the
node itself. This command will try to contact the API server to get the
Kubernetes version it is running, which is enough to verify the connectivity. We
have to consider that `kubectl` uses the URL of the API server available in the
`kubeconfig` file and not directly the IP address. It means that this
connectivity check requires the DNS to be working correctly to succeed.
We can use the flag `-v`/`--verbose` to have further details about the command
that is being executed in the nodes to check connectivity:
@ -65,7 +65,7 @@ Response:
Connectivity check: succeeded
```
Given that the `check-connectivity` command checks the connectivity by running a
command on the nodes, all the
Given that the `check-apiserver-connectivity` command checks the connectivity by
running a command on the nodes, all the
[restrictions](https://docs.microsoft.com/en-us/azure/virtual-machines/linux/run-command#restrictions)
of running scripts in an Azure Linux VM also apply here.