diff --git a/docs/tutorials/kubernetes/efficient-data-sharing-in-kubeflow-with-vineyard-csi-driver.rst b/docs/tutorials/kubernetes/efficient-data-sharing-in-kubeflow-with-vineyard-csi-driver.rst index 86c7b8e3..675906b5 100644 --- a/docs/tutorials/kubernetes/efficient-data-sharing-in-kubeflow-with-vineyard-csi-driver.rst +++ b/docs/tutorials/kubernetes/efficient-data-sharing-in-kubeflow-with-vineyard-csi-driver.rst @@ -10,8 +10,7 @@ Next, we will show you how to use the Vineyard CSI Driver to speed up a kubeflow Prerequisites ============= -- A kubernetes cluster with version >= 1.25.10. If you don't have one by hand, you can refer to the -guide `Initialize Kubernetes Cluster`_ to create one. +- A kubernetes cluster with version >= 1.25.10. If you don't have one by hand, you can refer to the guide `Initialize Kubernetes Cluster`_ to create one. - Install the `Vineyardctl`_ by following the official guide. - Install the `Argo Workflow CLI`_ by following the official guide. @@ -50,6 +49,11 @@ deployment is ready as follows: Then deploy the vineyard csi driver which specifies the vineyard cluster to use: +.. tip:: + + If you want to look into the debug logs of the vineyard csi driver, you can add a + flag ``--verbose`` in the following command. + .. code:: bash $ vineyardctl deploy csidriver --clusters vineyard-system/vineyardd-sample @@ -138,7 +142,7 @@ kind cluster. Then apply the data volume as follows: .. tip:: If you already have nfs volume that can be accessed by the kubernetes cluster, - you can update the prepare-data.yaml to use your nfs volume. + you can update the ``prepare-data.yaml`` to use your nfs volume. .. code:: bash diff --git a/k8s/cmd/README.md b/k8s/cmd/README.md index 4fb33561..8bbb67ef 100644 --- a/k8s/cmd/README.md +++ b/k8s/cmd/README.md @@ -825,7 +825,7 @@ vineyardctl deploy csidriver [flags] --clusters strings The list of vineyard clusters. --enableToleration Enable toleration for vineyard csi driver. -h, --help help for csidriver - -i, --image string The image of vineyard csi driver. (default "vineyardcloudnative/vineyard-csi-driver") + -i, --image string The image of vineyard csi driver. (default "vineyardcloudnative/vineyard-operator") --imagePullPolicy string The image pull policy of vineyard csi driver. (default "IfNotPresent") --livenessProbeImage string The image of livenessProbe. (default "registry.k8s.io/sig-storage/livenessprobe:v2.8.0") --name string The name of the csi driver cr. (default "csidriver-sample") diff --git a/k8s/cmd/commands/flags/csidriver_flags.go b/k8s/cmd/commands/flags/csidriver_flags.go index 5b76fb7b..f168b99a 100644 --- a/k8s/cmd/commands/flags/csidriver_flags.go +++ b/k8s/cmd/commands/flags/csidriver_flags.go @@ -58,7 +58,7 @@ func ApplyCSIDriverClustersOpts(cmd *cobra.Command) { func ApplyCSIDriverOpts(cmd *cobra.Command) { ApplyCSIDriverNameOpts(cmd) cmd.Flags().StringVarP(&CSIDriverOpts.Image, "image", "i", - "vineyardcloudnative/vineyard-csi-driver", + "vineyardcloudnative/vineyard-operator", "The image of vineyard csi driver.") cmd.Flags().StringVarP(&CSIDriverOpts.ImagePullPolicy, "imagePullPolicy", "", "IfNotPresent", "The image pull policy of vineyard csi driver.") diff --git a/k8s/pkg/templates/csidriver/daemonset.yaml b/k8s/pkg/templates/csidriver/daemonset.yaml index 8e739cea..16587ada 100644 --- a/k8s/pkg/templates/csidriver/daemonset.yaml +++ b/k8s/pkg/templates/csidriver/daemonset.yaml @@ -22,7 +22,7 @@ spec: - --endpoint=$(CSI_ENDPOINT) - --nodeid=$(KUBE_NODE_NAME) - --state-file-path=/csi/state - {{ if .Spec.EnableDebugLog }} + {{ if .Spec.EnableVerboseLog }} - --verbose {{ end }} env: diff --git a/k8s/pkg/templates/csidriver/deployment.yaml b/k8s/pkg/templates/csidriver/deployment.yaml index 55d946fa..f9c14cb3 100644 --- a/k8s/pkg/templates/csidriver/deployment.yaml +++ b/k8s/pkg/templates/csidriver/deployment.yaml @@ -26,7 +26,7 @@ spec: - --endpoint=$(CSI_ENDPOINT) - --nodeid=$(KUBE_NODE_NAME) - --state-file-path=/csi/state - {{ if .Spec.EnableDebugLog }} + {{ if .Spec.EnableVerboseLog }} - --verbose {{ end }} env: