Skip to content

Commit

Permalink
Fix the wrong vineyardctl installation address (#1874)
Browse files Browse the repository at this point in the history
Fixes #1854

Signed-off-by: Ye Cao <[email protected]>
  • Loading branch information
dashanji authored Apr 19, 2024
1 parent 22424b6 commit 58b44e6
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 10 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ as follows.
# create the namespace
$ kubectl create ns vineyard-test
# get all injected resources
$ vineyardctl inject -f pod.yaml | kubectl apply -f -
$ python3 -m vineyard.ctl inject -f pod.yaml | kubectl apply -f -
pod/vineyard-sidecar-etcd-0 created
service/vineyard-sidecar-etcd-0 created
service/vineyard-sidecar-etcd-service created
Expand Down Expand Up @@ -135,7 +135,7 @@ Deploy the vineyard deployment (default is 3 replicas) as follows.
# create the namespace if not exists
$ kubectl create ns vineyard-test
# create the vineyard deployment
$ vineyardctl deploy vineyard-deployment --name vineyardd-sample -n vineyard-test
$ python3 -m vineyard.ctl deploy vineyard-deployment --name vineyardd-sample -n vineyard-test
2023-07-21T15:42:25.981+0800 INFO vineyard cluster deployed successfully
Check the vineyard deployment status and the three vineyardd pods should run on the different nodes.
Expand Down Expand Up @@ -239,12 +239,12 @@ Use the `vineyardctl` to schedule the two workloads on the vineyard cluster.
.. code:: bash
# schedule the producer workload to the vineyard cluster and apply it to the kubernetes cluster
$ vineyardctl schedule workload -f producer.yaml --vineyardd-name vineyardd-sample \
$ python3 -m vineyard.ctl schedule workload -f producer.yaml --vineyardd-name vineyardd-sample \
--vineyardd-namespace vineyard-test -o yaml | kubectl apply -f -
deployment.apps/producer created
# schedule the consumer workload to the vineyard cluster and apply it to the kubernetes cluster
$ vineyardctl schedule workload -f consumer.yaml --vineyardd-name vineyardd-sample \
$ python3 -m vineyard.ctl schedule workload -f consumer.yaml --vineyardd-name vineyardd-sample \
--vineyardd-namespace vineyard-test -o yaml | kubectl apply -f -
deployment.apps/consumer created
Expand All @@ -265,5 +265,5 @@ As the consumer may be scheduled to different node from the producer with the de
should get the remote object id by name and then fetch it from other vineyard nodes. For more details, please refer to
the `vineyard objects`_.
.. _vineyardctl installation: https://v6d.io/notes/developers/build-from-source.html#install-vineyardctl
.. _vineyardctl installation: https://v6d.io/notes/cloud-native/deploy-kubernetes.html#quick-start
.. _vineyard objects: https://v6d.io/notes/key-concepts/objects.html#transient-vs-persistent
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Deploy the Vineyard Cluster

.. code:: bash
$ vineyardctl deploy vineyard-cluster --create-namespace
$ python3 -m vineyard.ctl deploy vineyard-cluster --create-namespace
This command will create a vineyard cluster in the namespace `vineyard-system`.
You can check as follows:
Expand Down Expand Up @@ -57,7 +57,7 @@ Then deploy the vineyard csi driver which specifies the vineyard cluster to use:

.. code:: bash
$ vineyardctl deploy csidriver --clusters vineyard-system/vineyardd-sample
$ python3 -m vineyard.ctl deploy csidriver --clusters vineyard-system/vineyardd-sample
Then check the status of the Vineyard CSI Driver:

Expand Down Expand Up @@ -551,7 +551,7 @@ Delete the vineyard cluster:

.. code:: bash
$ vineyardctl delete vineyard-cluster
$ python3 -m vineyard.ctl delete vineyard-cluster
Delete the data volume:

Expand All @@ -568,5 +568,5 @@ Delete the kubeflow namespace:
.. _Kubeflow Pipeline: https://github.com/kubeflow/kubeflow
.. _Argo Workflow: https://github.com/argoproj/argo-workflows
.. _Initialize Kubernetes Cluster: https://v6d.io/tutorials/kubernetes/using-vineyard-operator.html#step-0-optional-initialize-kubernetes-cluster
.. _Vineyardctl: https://v6d.io/notes/developers/build-from-source.html#install-vineyardctl
.. _Vineyardctl: https://v6d.io/notes/cloud-native/deploy-kubernetes.html#quick-start
.. _Argo Workflow CLI: https://github.com/argoproj/argo-workflows/releases/
3 changes: 2 additions & 1 deletion python/vineyard/contrib/airflow/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,9 +170,10 @@ Next, we will show how to deploy airflow with vineyard on Kubernetes using the h

You are supposed to deploy the vineyard cluster on the
kubernetes cluster first. For example, you can deploy a vineyard cluster with the [vineyardctl command](https://github.com/v6d-io/v6d/tree/main/k8s/cmd#vineyardctl).
Before using it, please [install the vineyardctl](https://v6d.io/notes/cloud-native/deploy-kubernetes.html#quick-start) first.

```bash
$ vineyardctl deploy vineyard-deployment --create-namespace
$ python3 -m vineyard.ctl deploy vineyard-deployment --create-namespace
```

The [values.yaml](./values.yaml) mainly tweak the following settings:
Expand Down

0 comments on commit 58b44e6

Please sign in to comment.