vineyardctl
#
vineyardctl is the command-line tool for interact with the Vineyard Operator.
Synopsis#
vineyardctl is the command-line tool for working with the Vineyard Operator. It supports creating, deleting and checking status of Vineyard Operator. It also supports managing the vineyard relevant components such as vineyardd and pluggable drivers.
SEE ALSO
vineyardctl create - Create a vineyard jobs on kubernetes
vineyardctl delete - Delete the vineyard components from kubernetes
vineyardctl deploy - Deploy the vineyard components on kubernetes
vineyardctl inject - Inject the vineyard sidecar container into a workload
vineyardctl manager - Start the manager of vineyard operator
vineyardctl schedule - Schedule a workload or a workflow to existing vineyard cluster.
Options#
--create-namespace create the namespace if it does not exist, default false
-j, --dump-usage Dump usage in JSON
-g, --gen-doc Generate reference docs, e.g., "./cmd/README.md"
-h, --help help for vineyardctl
--kubeconfig string kubeconfig path for the kubernetes cluster (default "$HOME/.kube/config")
-n, --namespace string the namespace for operation (default "vineyard-system")
-v, --version version for vineyardctl
--wait wait for the kubernetes resource to be ready, default true (default true)
vineyardctl create
#
Create a vineyard jobs on kubernetes
SEE ALSO
vineyardctl - vineyardctl is the command-line tool for interact with the Vineyard Operator.
vineyardctl create backup - Create a backup cr to backup the current vineyard cluster on kubernetes
vineyardctl create operation - Insert an operation in a workflow based on vineyard cluster
vineyardctl create recover - Create a recover cr to recover the current vineyard cluster on kubernetes
Examples#
# create the backup job on kubernetes
vineyardctl create backup --vineyardd-name vineyardd-sample --vineyardd-namespace vineyard-system
# create the recover job on kubernetes
vineyardctl create recover --backup-name vineyardd-sample -n vineyard-system
# create the operation job on kubernetes
vineyardctl create operation --name assembly \
--type local \
--require job1 \
--target job2 \
--timeoutSeconds 600
Options#
-h, --help help for create
vineyardctl create backup
#
Create a backup cr to backup the current vineyard cluster on kubernetes
Synopsis#
Backup the current vineyard cluster on kubernetes. You could backup all objects of the current vineyard cluster quickly. For persistent storage, you could specify the pv spec and pv spec.
Notice, the command is used to create a backup cr for the vineyard operator and you must deploy the vineyard operator and vineyard cluster before using it.
vineyardctl create backup [flags]
SEE ALSO
vineyardctl create - Create a vineyard jobs on kubernetes
Examples#
# create a backup cr for the vineyard cluster on kubernetes
# you could define the pv and pvc spec from json string as follows
vineyardctl create backup \
--vineyardd-name vineyardd-sample \
--vineyardd-namespace vineyard-system \
--limit 1000 \
--path /var/vineyard/dump \
--pv-pvc-spec '{
"pv-spec": {
"capacity": {
"storage": "1Gi"
},
"accessModes": [
"ReadWriteOnce"
],
"storageClassName": "manual",
"hostPath": {
"path": "/var/vineyard/dump"
}
},
"pvc-spec": {
"storageClassName": "manual",
"accessModes": [
"ReadWriteOnce"
],
"resources": {
"requests": {
"storage": "1Gi"
}
}
}
}'
# create a backup cr for the vineyard cluster on kubernetes
# you could define the pv and pvc spec from yaml string as follows
vineyardctl create backup \
--vineyardd-name vineyardd-sample \
--vineyardd-namespace vineyard-system \
--limit 1000 --path /var/vineyard/dump \
--pv-pvc-spec \
'
pv-spec:
capacity:
storage: 1Gi
accessModes:
- ReadWriteOnce
storageClassName: manual
hostPath:
path: "/var/vineyard/dump"
pvc-spec:
storageClassName: manual
accessModes:
- ReadWriteOnce
resources:
requests:
storage: 1Gi
'
# create a backup cr for the vineyard cluster on kubernetes
# you could define the pv and pvc spec from json file as follows
# also you could use yaml file instead of json file
cat pv-pvc.json | vineyardctl create backup \
--vineyardd-name vineyardd-sample \
--vineyardd-namespace vineyard-system \
--limit 1000 --path /var/vineyard/dump \
-
Options#
--backup-name string the name of backup job (default "vineyard-backup")
-h, --help help for backup
--objectIDs strings the specific objects to be backed up
--path string the path of the backup data
--pv-pvc-spec string the PersistentVolume and PersistentVolumeClaim of the backup data
--vineyardd-name string the name of vineyardd
--vineyardd-namespace string the namespace of vineyardd
vineyardctl create operation
#
Insert an operation in a workflow based on vineyard cluster
Synopsis#
Insert an operation in a workflow based on vineyard cluster. You could create a assembly or repartition operation in a workflow. Usually, the operation should be created between the workloads: job1 -> operation -> job2.
vineyardctl create operation [flags]
SEE ALSO
vineyardctl create - Create a vineyard jobs on kubernetes
Examples#
# create a local assembly operation between job1 and job2
vineyardctl create operation --name assembly \
--type local \
--require job1 \
--target job2 \
--timeoutSeconds 600
# create a distributed assembly operation between job1 and job2
vineyardctl create operation --name assembly \
--type distributed \
--require job1 \
--target job2 \
--timeoutSeconds 600
# create a dask repartition operation between job1 and job2
vineyardctl create operation --name repartition \
--type dask \
--require job1 \
--target job2 \
--timeoutSeconds 600
Options#
-h, --help help for operation
--kind string the kind of operation, including "assembly" and "repartition"
--name string the name of operation
--require string the job that need an operation to be executed
--target string the job that need to be executed before this operation
--timeoutSeconds int the timeout seconds of operation (default 600)
--type string the type of operation: for assembly, it can be "local" or "distributed"; for repartition, it can be "dask"
vineyardctl create recover
#
Create a recover cr to recover the current vineyard cluster on kubernetes
Synopsis#
Recover the current vineyard cluster on kubernetes. You could recover all objects from a backup of vineyard cluster. Usually, the recover crd should be created in the same namespace of the backup job.
Notice, the command is used to create a recover cr for the vineyard operator and you must deploy the vineyard operator and vineyard cluster before using it.
vineyardctl create recover [flags]
SEE ALSO
vineyardctl create - Create a vineyard jobs on kubernetes
Examples#
# create a recover cr for a backup job in the same namespace
vineyardctl create recover --backup-name vineyardd-sample -n vineyard-system
Options#
--backup-name string the name of backup job (default "vineyard-backup")
-h, --help help for recover
--recover-name string the name of recover job (default "vineyard-recover")
vineyardctl delete
#
Delete the vineyard components from kubernetes
SEE ALSO
vineyardctl - vineyardctl is the command-line tool for interact with the Vineyard Operator.
vineyardctl delete backup - Delete the backup job on kubernetes
vineyardctl delete cert-manager - Delete the cert-manager on kubernetes
vineyardctl delete operation - Delete the operation from kubernetes
vineyardctl delete operator - Delete the vineyard operator from kubernetes
vineyardctl delete recover - Delete the recover job from kubernetes
vineyardctl delete vineyard-cluster - Delete the vineyard cluster from kubernetes
vineyardctl delete vineyard-deployment - delete vineyard-deployment will delete the vineyard deployment without vineyard operator
vineyardctl delete vineyardd - Delete the vineyardd cluster from kubernetes
Examples#
# delete the default vineyard cluster on kubernetes
vineyardctl -n vineyard-system --kubeconfig $HOME/.kube/config delete
# delete the default vineyard operator on kubernetes
vineyardctl -n vineyard-system --kubeconfig $HOME/.kube/config delete operator
# delete the default cert-manager on kubernetes
vineyardctl -n vineyard-system --kubeconfig $HOME/.kube/config delete cert-manager
# delete the default vineyardd on kubernetes
vineyardctl -n vineyard-system --kubeconfig $HOME/.kube/config delete vineyardd
Options#
-h, --help help for delete
vineyardctl delete backup
#
Delete the backup job on kubernetes
Synopsis#
Delete the backup job on kubernetes.
vineyardctl delete backup [flags]
SEE ALSO
vineyardctl delete - Delete the vineyard components from kubernetes
Examples#
# delete the default backup job
vineyardctl delete backup
Options#
--backup-name string the name of backup job (default "vineyard-backup")
-h, --help help for backup
vineyardctl delete cert-manager
#
Delete the cert-manager on kubernetes
Synopsis#
Delete the cert-manager in the cert-manager namespace. The default version of cert-manager is v1.9.1.
vineyardctl delete cert-manager [flags]
SEE ALSO
vineyardctl delete - Delete the vineyard components from kubernetes
Examples#
# delete the default version(v1.9.1) of cert-manager
vineyardctl --kubeconfig $HOME/.kube/config delete cert-manager
Options#
-h, --help help for cert-manager
vineyardctl delete operation
#
Delete the operation from kubernetes
vineyardctl delete operation [flags]
SEE ALSO
vineyardctl delete - Delete the vineyard components from kubernetes
Examples#
# delete the operation named "assembly-test" in the "vineyard-system" namespace
vineyardctl delete operation --name assembly-test
Options#
-h, --help help for operation
--name string the name of operation
vineyardctl delete operator
#
Delete the vineyard operator from kubernetes
vineyardctl delete operator [flags]
SEE ALSO
vineyardctl delete - Delete the vineyard components from kubernetes
Examples#
# delete the default vineyard operator in the vineyard-system namespace
vineyardctl delete operator
# delete the specific version of vineyard operator in the vineyard-system namespace
vineyardctl -n vineyard-system --kubeconfig $HOME/.kube/config delete operator -v 0.12.2
# delete the vineyard operator from local kustomize dir in the vineyard-system namespace
vineyardctl -n vineyard-system --kubeconfig $HOME/.kube/config delete operator \
--local ../config/default
Options#
-h, --help help for operator
-l, --local string the local kustomize dir
-v, --version string the version of kustomize dir from github repo (default "dev")
vineyardctl delete recover
#
Delete the recover job from kubernetes
vineyardctl delete recover [flags]
SEE ALSO
vineyardctl delete - Delete the vineyard components from kubernetes
Examples#
# delete the default recover job on kubernetes
vineyardctl delete recover
Options#
-h, --help help for recover
--recover-name string the name of recover job (default "vineyard-recover")
vineyardctl delete vineyard-cluster
#
Delete the vineyard cluster from kubernetes
vineyardctl delete vineyard-cluster [flags]
SEE ALSO
vineyardctl delete - Delete the vineyard components from kubernetes
Examples#
# delete the default vineyard cluster on kubernetes
vineyardctl delete vineyard-cluster
Options#
-h, --help help for vineyard-cluster
vineyardctl delete vineyard-deployment
#
delete vineyard-deployment will delete the vineyard deployment without vineyard operator
vineyardctl delete vineyard-deployment [flags]
SEE ALSO
vineyardctl delete - Delete the vineyard components from kubernetes
Examples#
# delete the default vineyard deployment in the vineyard-system namespace
vineyardctl -n vineyard-system --kubeconfig $HOME/.kube/config delete vineyard-deployment
# delete the vineyard deployment with specific name in the vineyard-system namespace
vineyardctl -n vineyard-system --kubeconfig $HOME/.kube/config delete vineyard-deployment \
--name vineyardd-0
Options#
-h, --help help for vineyard-deployment
--name string the name of vineyardd (default "vineyardd-sample")
vineyardctl delete vineyardd
#
Delete the vineyardd cluster from kubernetes
vineyardctl delete vineyardd [flags]
SEE ALSO
vineyardctl delete - Delete the vineyard components from kubernetes
Examples#
# delete the default vineyardd cluster(vineyardd-sample) in the default namespace
vineyardctl delete vineyardd
# delete the specific vineyardd cluster in the vineyard-system namespace
vineyardctl -n vineyard-system delete vineyardd --name vineyardd-test
Options#
-h, --help help for vineyardd
--name string the name of vineyardd (default "vineyardd-sample")
vineyardctl deploy
#
Deploy the vineyard components on kubernetes
SEE ALSO
vineyardctl - vineyardctl is the command-line tool for interact with the Vineyard Operator.
vineyardctl deploy backup-job - Deploy a backup job of vineyard cluster on kubernetes
vineyardctl deploy cert-manager - Deploy the cert-manager on kubernetes
vineyardctl deploy operator - Deploy the vineyard operator on kubernetes
vineyardctl deploy recover-job - Deploy a recover job to recover a backup of current vineyard cluster on kubernetes
vineyardctl deploy vineyard-cluster - Deploy the vineyard cluster from kubernetes
vineyardctl deploy vineyard-deployment - DeployVineyardDeployment builds and deploy the yaml file of vineyardd without vineyard operator
vineyardctl deploy vineyardd - Deploy the vineyardd on kubernetes
Examples#
# deploy the default vineyard cluster on kubernetes
vineyardctl --kubeconfig $HOME/.kube/config deploy vineyard-cluster
# deploy the vineyard operator on kubernetes
vineyardctl -n vineyard-system --kubeconfig $HOME/.kube/config deploy operator
# deploy the cert-manager on kubernetes
vineyardctl -n vineyard-system --kubeconfig $HOME/.kube/config deploy cert-manager
# deploy the vineyardd on kubernetes
vineyardctl -n vineyard-system --kubeconfig $HOME/.kube/config deploy vineyardd
Options#
-h, --help help for deploy
vineyardctl deploy backup-job
#
Deploy a backup job of vineyard cluster on kubernetes
Synopsis#
Deploy the backup job for the vineyard cluster on kubernetes, which will backup all objects of the current vineyard cluster quickly. For persistent storage, you could specify the pv spec and pv spec and the related pv and pvc will be created automatically. Also, you could also specify the existing pv and pvc name to use
vineyardctl deploy backup-job [flags]
SEE ALSO
vineyardctl deploy - Deploy the vineyard components on kubernetes
Examples#
# deploy a backup job for all vineyard objects of the vineyard
# cluster on kubernetes and you could define the pv and pvc
# spec from json string as follows
vineyardctl deploy backup-job \
--vineyard-deployment-name vineyardd-sample \
--vineyard-deployment-namespace vineyard-system \
--path /var/vineyard/dump \
--pv-pvc-spec '{
"pv-spec": {
"capacity": {
"storage": "1Gi"
},
"accessModes": [
"ReadWriteOnce"
],
"storageClassName": "manual",
"hostPath": {
"path": "/var/vineyard/dump"
}
},
"pvc-spec": {
"storageClassName": "manual",
"accessModes": [
"ReadWriteOnce"
],
"resources": {
"requests": {
"storage": "1Gi"
}
}
}
}'
# deploy a backup job for the vineyard cluster on kubernetes
# you could define the pv and pvc spec from yaml string as follows
vineyardctl deploy backup-job \
--vineyard-deployment-name vineyardd-sample \
--vineyard-deployment-namespace vineyard-system \
--path /var/vineyard/dump \
--pv-pvc-spec \
'
pv-spec:
capacity:
storage: 1Gi
accessModes:
- ReadWriteOnce
storageClassName: manual
hostPath:
path: "/var/vineyard/dump"
pvc-spec:
storageClassName: manual
accessModes:
- ReadWriteOnce
resources:
requests:
storage: 1Gi
'
# deploy a backup job for specific vineyard objects of the vineyard
# cluster on kubernetes.
cat pv-pvc.json | vineyardctl deploy backup-job \
--vineyard-deployment-name vineyardd-sample \
--vineyard-deployment-namespace vineyard-system \
--objectIDs "o000018d29207fd01,o000018d80d264010" \
--path /var/vineyard/dump
# Assume you have already deployed a pvc named "pvc-sample", you
# could use them as the backend storage for the backup job as follows
vineyardctl deploy backup-job \
--vineyard-deployment-name vineyardd-sample \
--vineyard-deployment-namespace vineyard-system \
--path /var/vineyard/dump \
--pvc-name pvc-sample
# The namespace to deploy the backup and recover job must be the same
# as the vineyard cluster namespace.
# Assume the vineyard cluster is deployed in the namespace "test", you
# could deploy the backup job as follows
vineyardctl deploy backup-job \
--vineyard-deployment-name vineyardd-sample \
--vineyard-deployment-namespace test \
--namespace test \
--path /var/vineyard/dump \
--pvc-name pvc-sample
Options#
--backup-name string the name of backup job (default "vineyard-backup")
-h, --help help for backup-job
--objectIDs strings the specific objects to be backed up
--path string the path of the backup data
--pv-pvc-spec string the PersistentVolume and PersistentVolumeClaim of the backup data
--pvc-name string the name of an existing PersistentVolumeClaim
--vineyard-deployment-name string the name of vineyard deployment
--vineyard-deployment-namespace string the namespace of vineyard deployment
vineyardctl deploy cert-manager
#
Deploy the cert-manager on kubernetes
Synopsis#
Deploy the cert-manager in the cert-manager namespace. The default version of cert-manager is v1.9.1.
vineyardctl deploy cert-manager [flags]
SEE ALSO
vineyardctl deploy - Deploy the vineyard components on kubernetes
Examples#
# install the default version(v1.9.1) in the cert-manager namespace
# wait for the cert-manager to be ready(default option)
vineyardctl --kubeconfig $HOME/.kube/config deploy cert-manager
# install the default version(v1.9.1) in the cert-manager namespace
# not to wait for the cert-manager to be ready, but we does not recommend
# to do this, because there may be errors caused by the cert-manager
# not ready
vineyardctl --kubeconfig $HOME/.kube/config deploy cert-manager \
--wait=false
Options#
-h, --help help for cert-manager
vineyardctl deploy operator
#
Deploy the vineyard operator on kubernetes
Synopsis#
Deploy the vineyard operator on kubernetes. You could specify a stable or development version of the operator. The default kustomize dir is development version from github repo. Also, you can install the stable version from github repo or a local kustomize dir. Besides, you can also deploy the vineyard operator in an existing namespace.
vineyardctl deploy operator [flags]
SEE ALSO
vineyardctl deploy - Deploy the vineyard components on kubernetes
Examples#
# install the development version in the vineyard-system namespace
# the default kustomize dir is the development version from github repo
# (https://github.com/v6d-io/v6d/k8s/config/default\?submodules=false)
# and the default namespace is vineyard-system
# wait for the vineyard operator to be ready(default option)
vineyardctl deploy operator
# not to wait for the vineyard operator to be ready
vineyardctl deploy operator --wait=false
# install the stable version from github repo in the test namespace
# the kustomize dir is
# (https://github.com/v6d-io/v6d/k8s/config/default\?submodules=false&ref=v0.12.2)
vineyardctl -n test --kubeconfig $HOME/.kube/config deploy operator -v 0.12.2
# install the local kustomize dir
vineyardctl --kubeconfig $HOME/.kube/config deploy operator --local ../config/default
Options#
-h, --help help for operator
-l, --local string the local kustomize dir
-v, --version string the version of kustomize dir from github repo (default "dev")
vineyardctl deploy recover-job
#
Deploy a recover job to recover a backup of current vineyard cluster on kubernetes
Synopsis#
Deploy the recover job for vineyard cluster on kubernetes, which will recover all objects from a backup of vineyard cluster. Usually, the recover job should be created in the same namespace of the backup job.
vineyardctl deploy recover-job [flags]
SEE ALSO
vineyardctl deploy - Deploy the vineyard components on kubernetes
Examples#
# Deploy a recover job for the vineyard deployment in the same namespace.
# After the recover job finished, the command will create a kubernetes
# configmap named [recover-name]+"-mapping-table" that contains the
# mapping table from the old vineyard objects to the new ones.
#
# If you create the recover job as follows, you can get the mapping table via
# "kubectl get configmap vineyard-recover-mapping-table -n vineyard-system -o yaml"
# the left column is the old object id, and the right column is the new object id.
vineyardctl deploy recover-job \
--vineyard-deployment-name vineyardd-sample \
--vineyard-deployment-namespace vineyard-system \
--recover-path /var/vineyard/dump \
--pvc-name vineyard-backup
Options#
-h, --help help for recover-job
--pvc-name string the name of an existing PersistentVolumeClaim
--recover-name string the name of recover job (default "vineyard-recover")
--recover-path string the path of recover job
--vineyard-deployment-name string the name of vineyard deployment
--vineyard-deployment-namespace string the namespace of vineyard deployment
vineyardctl deploy vineyard-cluster
#
Deploy the vineyard cluster from kubernetes
vineyardctl deploy vineyard-cluster [flags]
SEE ALSO
vineyardctl deploy - Deploy the vineyard components on kubernetes
Examples#
# deploy the default vineyard cluster on kubernetes
vineyardctl deploy vineyard-cluster
Options#
-h, --help help for vineyard-cluster
vineyardctl deploy vineyard-deployment
#
DeployVineyardDeployment builds and deploy the yaml file of vineyardd without vineyard operator
Synopsis#
Builds and deploy the yaml file of vineyardd the vineyardd without vineyard operator. You could deploy a customized vineyardd from stdin or file.
vineyardctl deploy vineyard-deployment [flags]
SEE ALSO
vineyardctl deploy - Deploy the vineyard components on kubernetes
Examples#
# deploy the default vineyard deployment on kubernetes
vineyardctl -n vineyard-system --kubeconfig $HOME/.kube/config \
deploy vineyard-deployment
# deploy the vineyard deployment with customized image
vineyardctl -n vineyard-system --kubeconfig $HOME/.kube/config \
deploy vineyard-deployment --image vineyardd:v0.12.2
Options#
-f, --file string the path of vineyardd
-h, --help help for vineyard-deployment
--name string the name of vineyardd (default "vineyardd-sample")
--owner-references string The owner reference of all vineyard deployment resources
--pluginImage.backupImage string the backup image of vineyardd (default "ghcr.io/v6d-io/v6d/backup-job")
--pluginImage.daskRepartitionImage string the dask repartition image of vineyardd workflow (default "ghcr.io/v6d-io/v6d/dask-repartition")
--pluginImage.distributedAssemblyImage string the distributed image of vineyard workflow (default "ghcr.io/v6d-io/v6d/distributed-assembly")
--pluginImage.localAssemblyImage string the local assembly image of vineyardd workflow (default "ghcr.io/v6d-io/v6d/local-assembly")
--pluginImage.recoverImage string the recover image of vineyardd (default "ghcr.io/v6d-io/v6d/recover-job")
--vineyard.etcd.replicas int the number of etcd replicas in a vineyard cluster (default 1)
--vineyard.replicas int the number of vineyardd replicas (default 3)
--vineyardd.cpu string the cpu requests and limits of vineyard container
--vineyardd.envs strings The environment variables of vineyardd
--vineyardd.image string the image of vineyardd (default "vineyardcloudnative/vineyardd:latest")
--vineyardd.imagePullPolicy string the imagePullPolicy of vineyardd (default "IfNotPresent")
--vineyardd.memory string the memory requests and limits of vineyard container
--vineyardd.metric.enable enable metrics of vineyardd
--vineyardd.metric.image string the metic image of vineyardd (default "vineyardcloudnative/vineyard-grok-exporter:latest")
--vineyardd.metric.imagePullPolicy string the imagePullPolicy of the metric image (default "IfNotPresent")
--vineyardd.reserve_memory Reserving enough physical memory pages for vineyardd
--vineyardd.service.port int the service port of vineyard service (default 9600)
--vineyardd.service.type string the service type of vineyard service (default "ClusterIP")
--vineyardd.size string The size of vineyardd. You can use the power-of-two equivalents: Ei, Pi, Ti, Gi, Mi, Ki. (default "256Mi")
--vineyardd.socket string The directory on host for the IPC socket file. The namespace and name will be replaced with your vineyard config (default "/var/run/vineyard-kubernetes/{{.Namespace}}/{{.Name}}")
--vineyardd.spill.config string If you want to enable the spill mechanism, please set the name of spill config
--vineyardd.spill.path string The path of spill config
--vineyardd.spill.pv-pvc-spec string the json string of the persistent volume and persistent volume claim
--vineyardd.spill.spillLowerRate string The low watermark of spilling memory (default "0.3")
--vineyardd.spill.spillUpperRate string The high watermark of spilling memory (default "0.8")
--vineyardd.streamThreshold int memory threshold of streams (percentage of total memory) (default 80)
--vineyardd.syncCRDs enable metrics of vineyardd (default true)
--vineyardd.volume.mountPath string Set the mount path for the pvc
--vineyardd.volume.pvcname string Set the pvc name for storing the vineyard objects persistently,
vineyardctl deploy vineyardd
#
Deploy the vineyardd on kubernetes
Synopsis#
Deploy the vineyardd on kubernetes. You could deploy a customized vineyardd from stdin or file.
vineyardctl deploy vineyardd [flags]
SEE ALSO
vineyardctl deploy - Deploy the vineyard components on kubernetes
Examples#
# deploy the default vineyard on kubernetes
# wait for the vineyardd to be ready(default option)
vineyardctl -n vineyard-system --kubeconfig $HOME/.kube/config deploy vineyardd
# not to wait for the vineyardd to be ready
vineyardctl -n vineyard-system --kubeconfig $HOME/.kube/config deploy vineyardd \
--wait=false
# deploy the vineyardd from a yaml file
vineyardctl --kubeconfig $HOME/.kube/config deploy vineyardd --file vineyardd.yaml
# deploy the vineyardd with customized image
vineyardctl -n vineyard-system --kubeconfig $HOME/.kube/config deploy vineyardd \
--image vineyardd:v0.12.2
# deploy the vineyardd with spill mechanism on persistent storage from json string
vineyardctl -n vineyard-system --kubeconfig $HOME/.kube/config deploy vineyardd \
--vineyardd.spill.config spill-path \
--vineyardd.spill.path /var/vineyard/spill \
--vineyardd.spill.pv-pvc-spec '{
"pv-spec": {
"capacity": {
"storage": "1Gi"
},
"accessModes": [
"ReadWriteOnce"
],
"storageClassName": "manual",
"hostPath": {
"path": "/var/vineyard/spill"
}
},
"pvc-spec": {
"storageClassName": "manual",
"accessModes": [
"ReadWriteOnce"
],
"resources": {
"requests": {
"storage": "512Mi"
}
}
}
}'
# deploy the vineyardd with spill mechanism on persistent storage from yaml string
vineyardctl -n vineyard-system --kubeconfig $HOME/.kube/config deploy vineyardd \
--vineyardd.spill.config spill-path \
--vineyardd.spill.path /var/vineyard/spill \
--vineyardd.spill.pv-pvc-spec \
'
pv-spec:
capacity:
storage: 1Gi
accessModes:
- ReadWriteOnce
storageClassName: manual
hostPath:
path: "/var/vineyard/spill"
pvc-spec:
storageClassName: manual
accessModes:
- ReadWriteOnce
resources:
requests:
storage: 512Mi
'
# deploy the vineyardd with spill mechanism on persistent storage from json file
# also you could use the yaml file
cat pv-pvc.json | vineyardctl -n vineyard-system --kubeconfig $HOME/.kube/config deploy vineyardd \
--vineyardd.spill.config spill-path \
--vineyardd.spill.path /var/vineyard/spill \
-
Options#
-f, --file string the path of vineyardd
-h, --help help for vineyardd
--name string the name of vineyardd (default "vineyardd-sample")
--pluginImage.backupImage string the backup image of vineyardd (default "ghcr.io/v6d-io/v6d/backup-job")
--pluginImage.daskRepartitionImage string the dask repartition image of vineyardd workflow (default "ghcr.io/v6d-io/v6d/dask-repartition")
--pluginImage.distributedAssemblyImage string the distributed image of vineyard workflow (default "ghcr.io/v6d-io/v6d/distributed-assembly")
--pluginImage.localAssemblyImage string the local assembly image of vineyardd workflow (default "ghcr.io/v6d-io/v6d/local-assembly")
--pluginImage.recoverImage string the recover image of vineyardd (default "ghcr.io/v6d-io/v6d/recover-job")
--vineyard.etcd.replicas int the number of etcd replicas in a vineyard cluster (default 1)
--vineyard.replicas int the number of vineyardd replicas (default 3)
--vineyardd.cpu string the cpu requests and limits of vineyard container
--vineyardd.envs strings The environment variables of vineyardd
--vineyardd.image string the image of vineyardd (default "vineyardcloudnative/vineyardd:latest")
--vineyardd.imagePullPolicy string the imagePullPolicy of vineyardd (default "IfNotPresent")
--vineyardd.memory string the memory requests and limits of vineyard container
--vineyardd.metric.enable enable metrics of vineyardd
--vineyardd.metric.image string the metic image of vineyardd (default "vineyardcloudnative/vineyard-grok-exporter:latest")
--vineyardd.metric.imagePullPolicy string the imagePullPolicy of the metric image (default "IfNotPresent")
--vineyardd.reserve_memory Reserving enough physical memory pages for vineyardd
--vineyardd.service.port int the service port of vineyard service (default 9600)
--vineyardd.service.type string the service type of vineyard service (default "ClusterIP")
--vineyardd.size string The size of vineyardd. You can use the power-of-two equivalents: Ei, Pi, Ti, Gi, Mi, Ki. (default "256Mi")
--vineyardd.socket string The directory on host for the IPC socket file. The namespace and name will be replaced with your vineyard config (default "/var/run/vineyard-kubernetes/{{.Namespace}}/{{.Name}}")
--vineyardd.spill.config string If you want to enable the spill mechanism, please set the name of spill config
--vineyardd.spill.path string The path of spill config
--vineyardd.spill.pv-pvc-spec string the json string of the persistent volume and persistent volume claim
--vineyardd.spill.spillLowerRate string The low watermark of spilling memory (default "0.3")
--vineyardd.spill.spillUpperRate string The high watermark of spilling memory (default "0.8")
--vineyardd.streamThreshold int memory threshold of streams (percentage of total memory) (default 80)
--vineyardd.syncCRDs enable metrics of vineyardd (default true)
--vineyardd.volume.mountPath string Set the mount path for the pvc
--vineyardd.volume.pvcname string Set the pvc name for storing the vineyard objects persistently,
vineyardctl inject
#
Inject the vineyard sidecar container into a workload
Synopsis#
Inject the vineyard sidecar container into a workload. You can input a workload yaml or a workload json and then get the injected workload and some etcd manifests from the output.
The output is a set of manifests that includes the injected workload, the rpc service, the etcd service and the etcd cluster(e.g. several pods and services). Next, we will introduce a simple example to show the injection.
Assume you have the following workload yaml:
apiVersion: apps/v1
kind: Deployment
metadata:
name: nginx-deployment
# Notice, you must set the namespace here
namespace: vineyard-job
spec:
selector:
matchLabels:
app: nginx
template:
metadata:
labels:
app: nginx
spec:
containers:
- name: nginx
image: nginx:1.14.2
ports:
- containerPort: 80
Then, you can use the following command to inject the vineyard sidecar
$ vineyardctl inject -f workload.yaml –apply-resources
After running the command, the main output(removed some unnecessary fields) is as follows:
apiVersion: apps/v1
kind: Deployment
metadata:
creationTimestamp: null
name: nginx-deployment
namespace: vineyard-job
spec:
selector:
matchLabels:
app: nginx
template:
metadata:
labels:
app: nginx
# the default sidecar name is vineyard-sidecar
app.vineyard.io/name: vineyard-sidecar
spec:
containers:
- command: null
image: nginx:1.14.2
name: nginx
ports:
- containerPort: 80
volumeMounts:
- mountPath: /var/run
name: vineyard-socket
- command:
- /bin/bash
- -c
- |
/usr/bin/wait-for-it.sh -t 60 vineyard-sidecar-etcd-service.vineyard-job.svc.cluster.local:2379; \
sleep 1; /usr/local/bin/vineyardd --sync_crds true --socket /var/run/vineyard.sock --size 256Mi \
--stream_threshold 80 --etcd_cmd etcd --etcd_prefix /vineyard \
--etcd_endpoint http://vineyard-sidecar-etcd-service:2379
env:
- name: VINEYARDD_UID
value: null
- name: VINEYARDD_NAME
value: vineyard-sidecar
- name: VINEYARDD_NAMESPACE
value: vineyard-job
image: vineyardcloudnative/vineyardd:latest
imagePullPolicy: IfNotPresent
name: vineyard-sidecar
ports:
- containerPort: 9600
name: vineyard-rpc
protocol: TCP
volumeMounts:
- mountPath: /var/run
name: vineyard-socket
volumes:
- emptyDir: {}
name: vineyard-socket
The sidecar template can be accessed from the following link: https://github.com/v6d-io/v6d/blob/main/k8s/pkg/templates/sidecar/injection-template.yaml also you can get some inspiration from the doc link: https://v6d.io/notes/cloud-native/vineyard-operator.html#installing-vineyard-as-sidecar
vineyardctl inject [flags]
SEE ALSO
vineyardctl - vineyardctl is the command-line tool for interact with the Vineyard Operator.
Examples#
# use json format to output the injected workload
# notice that the output is a json string of all manifests
# it looks like:
# {
# "workload": "workload json string",
# "rpc_service": "rpc service json string",
# "etcd_service": "etcd service json string",
# "etcd_internal_service": [
# "etcd internal service json string 1",
# "etcd internal service json string 2",
# "etcd internal service json string 3"
# ],
# "etcd_pod": [
# "etcd pod json string 1",
# "etcd pod json string 2",
# "etcd pod json string 3"
# ]
# }
vineyardctl inject -f workload.yaml -o json
# inject the default vineyard sidecar container into a workload
# output all injected manifests and then deploy them
vineyardctl inject -f workload.yaml | kubectl apply -f -
# if you only want to get the injected workload yaml rather than
# all manifests that includes the etcd cluster and the rpc service,
# you can enable the apply-resources and then the manifests will be
# created during the injection, finally you will get the injected
# workload yaml
vineyardctl inject -f workload.yaml --apply-resources
Options#
--apply-resources Whether to apply the resources including the etcd cluster and the rpc service if you enable this flag, the etcd cluster and the rpc service will be created during the injection
--etcd-replicas int The number of etcd replicas (default 1)
-f, --file string The yaml of workload
-h, --help help for inject
--name string The name of sidecar (default "vineyard-sidecar")
-o, --output string The output format of the command, support yaml and json (default "yaml")
--owner-references string The owner reference of all injectied resources
--resource string The resource of workload
--sidecar.cpu string the cpu requests and limits of vineyard container
--sidecar.envs strings The environment variables of vineyardd
--sidecar.image string the image of vineyardd (default "vineyardcloudnative/vineyardd:latest")
--sidecar.imagePullPolicy string the imagePullPolicy of vineyardd (default "IfNotPresent")
--sidecar.memory string the memory requests and limits of vineyard container
--sidecar.metric.enable enable metrics of vineyardd
--sidecar.metric.image string the metic image of vineyardd (default "vineyardcloudnative/vineyard-grok-exporter:latest")
--sidecar.metric.imagePullPolicy string the imagePullPolicy of the metric image (default "IfNotPresent")
--sidecar.reserve_memory Reserving enough physical memory pages for vineyardd
--sidecar.service.port int the service port of vineyard service (default 9600)
--sidecar.service.type string the service type of vineyard service (default "ClusterIP")
--sidecar.size string The size of vineyardd. You can use the power-of-two equivalents: Ei, Pi, Ti, Gi, Mi, Ki. (default "256Mi")
--sidecar.socket string The directory on host for the IPC socket file. The namespace and name will be replaced with your vineyard config (default "/var/run/vineyard-kubernetes/{{.Namespace}}/{{.Name}}")
--sidecar.spill.config string If you want to enable the spill mechanism, please set the name of spill config
--sidecar.spill.path string The path of spill config
--sidecar.spill.pv-pvc-spec string the json string of the persistent volume and persistent volume claim
--sidecar.spill.spillLowerRate string The low watermark of spilling memory (default "0.3")
--sidecar.spill.spillUpperRate string The high watermark of spilling memory (default "0.8")
--sidecar.streamThreshold int memory threshold of streams (percentage of total memory) (default 80)
--sidecar.syncCRDs enable metrics of vineyardd (default true)
--sidecar.volume.mountPath string Set the mount path for the pvc
--sidecar.volume.pvcname string Set the pvc name for storing the vineyard objects persistently,
vineyardctl manager
#
Start the manager of vineyard operator
vineyardctl manager [flags]
SEE ALSO
vineyardctl - vineyardctl is the command-line tool for interact with the Vineyard Operator.
Examples#
# start the manager of vineyard operator with default configuration
# (Enable the controller, webhooks and scheduler)
vineyardctl manager
# start the manager of vineyard operator without webhooks
vineyardctl manager --enable-webhook=false
# start the manager of vineyard operator without scheduler
vineyardctl manager --enable-scheduler=false
# only start the controller
vineyardctl manager --enable-webhook=false --enable-scheduler=false
Options#
--enable-scheduler Enable scheduler for controller manager. (default true)
--enable-webhook Enable webhook for controller manager. (default true)
--health-probe-bind-address string The address the probe endpoint binds to. (default ":8081")
-h, --help help for manager
--leader-elect Enable leader election for controller manager. Enabling this will ensure there is only one active controller manager.
--metrics-bind-address string The address the metric endpoint binds to. (default "127.0.0.1:8080")
--scheduler-config-file string The location of scheduler plugin's configuration file. (default "/etc/kubernetes/scheduler.yaml")
vineyardctl schedule
#
Schedule a workload or a workflow to existing vineyard cluster.
SEE ALSO
vineyardctl - vineyardctl is the command-line tool for interact with the Vineyard Operator.
vineyardctl schedule workflow - Schedule a workflow based on the vineyard cluster
vineyardctl schedule workload - Schedule the workload to a vineyard cluster
Examples#
# Schedule a workload to a vineyard cluster
# it will add PodAffinity to the workload
vineyardctl schedule workload --resource '{kubernetes workload json string}'
# schedule a workflow to the vineyard cluster
vineyardctl schedule workflow --file workflow.yaml
Options#
-h, --help help for schedule
vineyardctl schedule workflow
#
Schedule a workflow based on the vineyard cluster
Synopsis#
Schedule a workflow based on the vineyard cluster. It will apply the workflow to kubernetes cluster and deploy the workload of the workflow on the vineyard cluster with the best-fit strategy.
vineyardctl schedule workflow [flags]
SEE ALSO
vineyardctl schedule - Schedule a workload or a workflow to existing vineyard cluster.
Examples#
# schedule a workflow to the vineyard cluster with the best-fit strategy
vineyardctl schedule workflow --file workflow.yaml
Options#
-f, --file string the path of workflow file
-h, --help help for workflow
vineyardctl schedule workload
#
Schedule the workload to a vineyard cluster
Synopsis#
Schedule the workload to a vineyard cluster. It will add the podAffinity to the workload so that the workload will be scheduled to the vineyard cluster.
vineyardctl schedule workload [flags]
SEE ALSO
vineyardctl schedule - Schedule a workload or a workflow to existing vineyard cluster.
Examples#
# Add the podAffinity to the workload for the specific vineyard cluster
vineyardctl schedule workload --resource '{
"apiVersion": "apps/v1",
"kind": "Deployment",
"metadata": {
"name": "web-server"
},
"spec": {
"selector": {
"matchLabels": {
"app": "web-store"
}
},
"replicas": 3,
"template": {
"metadata": {
"labels": {
"app": "web-store"
}
},
"spec": {
"affinity": {
"podAntiAffinity": {
"requiredDuringSchedulingIgnoredDuringExecution": [
{
"labelSelector": {
"matchExpressions": [
{
"key": "app",
"operator": "In",
"values": [
"web-store"
]
}
]
},
"topologyKey": "kubernetes.io/hostname"
}
]
},
"podAffinity": {
"requiredDuringSchedulingIgnoredDuringExecution": [
{
"labelSelector": {
"matchExpressions": [
{
"key": "app",
"operator": "In",
"values": [
"store"
]
}
]
},
"topologyKey": "kubernetes.io/hostname"
}
]
}
},
"containers": [
{
"name": "web-app",
"image": "nginx:1.16-alpine"
}
]
}
}
}
}' \
--vineyardd-name vineyardd-sample \
--vineyardd-namespace vineyard-system
Options#
-h, --help help for workload
--resource string the json string of kubernetes workload
--vineyardd-name string the namespace of vineyard cluster (default "vineyardd-sample")
--vineyardd-namespace string the namespace of vineyard cluster (default "vineyard-system")