diff --git a/README.md b/README.md index e044e7a..58892e4 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ Note that KubeShare 1.0 is deprecated. Refer to the [KubeShare 1.0 branch](https ## Prerequisite & Limitation -* A Kubernetes cluster with [garbage collection](https://kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/), [DNS enabled](https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/) [nvidia-continaer-runtime](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/install-guide.html)installed. +* A Kubernetes cluster with [garbage collection](https://kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/), [DNS enabled](https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/) [nvidia-container-runtime](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/install-guide.html)installed. * Only support a kubernetes cluster that uses the environment variable `NVIDIA_VISIBLE_DEVICES` to control which GPUs will be made accessible inside the container. * You also ensures that the *prometheus* is installed, because we will pull the data from it. * It can't compatible with other scheduler to manage gpu resource @@ -27,7 +27,7 @@ Note that KubeShare 1.0 is deprecated. Refer to the [KubeShare 1.0 branch](https --> ## Deployment -1. [Deploy Componments](doc/deploy.md) +1. [Deploy Components](doc/deploy.md) ## Workloads diff --git a/doc/deploy.md b/doc/deploy.md index 437ad0c..b77a2d0 100644 --- a/doc/deploy.md +++ b/doc/deploy.md @@ -135,8 +135,8 @@ kubectl apply -f deploy/aggregator.yaml kubectl apply -f deploy/collector.yaml ``` -+ **Make sure the enpoint of kubeshare-aggregator & kubeshare-collector of prometheus is up.** -+ Query the metric `gpu_capacity` , You will get the GPU specification ++ **Make sure the endpoint of kubeshare-aggregator & kubeshare-collector of prometheus is up.** ++ Query the metric `gpu_capacity`, You will get the GPU specification ``` gpu_capacity{endpoint="collector",index="0",instance="xxx.xxx.xxx.xxx:9004",job="kubeshare-collector",memory="34089730048",model="Tesla V100-PCIE-32GB",namespace="kube-system",node="ubuntu",pod="kubeshare-collector-wrrl6",service="kubeshare-collector",uuid="GPU-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"}