This is an automated email from the ASF dual-hosted git repository. zhaocong pushed a commit to branch init-hugegraph-computer-doc in repository https://gitbox.apache.org/repos/asf/incubator-hugegraph-doc.git
commit 5d513b8da43b719780c30d4ed9215ded0a202f94 Author: coderzc <[email protected]> AuthorDate: Fri May 27 12:46:52 2022 +0800 add hugegraph-computer quick start --- quickstart/hugegraph-computer.md | 101 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 101 insertions(+) diff --git a/quickstart/hugegraph-computer.md b/quickstart/hugegraph-computer.md new file mode 100644 index 00000000..0b56bcc8 --- /dev/null +++ b/quickstart/hugegraph-computer.md @@ -0,0 +1,101 @@ +## HugeGraph-Computer Quick Start + +### 1 Overviews + +HugeGraph-Computer is a large-scale graph computing system, basic on disk/memory & integrate with graph database HugeGraph. + +### 2 Install hugegraph-computer CRD + +```bash +# Kubernetes version >= v1.16 +kubectl apply -f https://raw.githubusercontent.com/hugegraph/hugegraph-computer/master/computer-k8s-operator/manifest/hugegraph-computer-crd.v1.yaml + +# Kubernetes version < v1.16 +kubectl apply -f https://raw.githubusercontent.com/hugegraph/hugegraph-computer/master/computer-k8s-operator/manifest/hugegraph-computer-crd.v1beta1.yaml +``` + +### 3 Show CRD + +```bash +kubectl get crd + +NAME CREATED AT +hugegraphcomputerjobs.hugegraph.baidu.com 2021-09-16T08:01:08Z +``` + +### 4 Install hugegraph-computer-operator&etcd-server + +```bash +kubectl apply -f https://raw.githubusercontent.com/hugegraph/hugegraph-computer/master/computer-k8s-operator/manifest/hugegraph-computer-operator.yaml +``` + +### 5 Wait for hugegraph-computer-operator&etcd-server deployment to complete + +```bash +kubectl get pod -n hugegraph-computer-operator-system + +NAME READY STATUS RESTARTS AGE +hugegraph-computer-operator-controller-manager-58c5545949-jqvzl 1/1 Running 0 15h +hugegraph-computer-operator-etcd-28lm67jxk5 1/1 Running 0 15h +``` + +### 6 Submit job + +```yaml +cat <<EOF | kubectl apply --filename - +apiVersion: hugegraph.baidu.com/v1 +kind: HugeGraphComputerJob +metadata: + namespace: hugegraph-computer-system + name: &jobName pagerank-sample +spec: + jobId: *jobName + algorithmName: page_rank + image: hugegraph/hugegraph-builtin-algorithms:latest # algorithm image url + jarFile: /opt/jars/hugegraph-builtin-algorithms.jar + pullPolicy: Always + workerCpu: "4" + workerMemory: "4Gi" + workerInstances: 5 + computerConf: + job.partitions_count: "20" + algorithm.params_class: com.baidu.hugegraph.computer.algorithm.centrality.pagerank.PageRankParams + hugegraph.url: http://${hugegraph-server-host}:${hugegraph-server-port} # hugegraph server url + hugegraph.name: hugegraph +EOF +``` + +### 7 Show job + +```bash +kubectl get hcjob/pagerank-sample -n hugegraph-computer-system + +NAME JOBID JOBSTATUS +pagerank-sample pagerank-sample RUNNING +``` + +### 8 Show log of running nodes + +```bash +# Show the master log +kubectl logs -l component=pagerank-sample-master -n hugegraph-computer-system + +# Show the worker log +kubectl logs -l component=pagerank-sample-worker -n hugegraph-computer-system +``` + +### 9 Show diagnostic log of a job + +> NOTE: diagnostic log exist only when the job fails, and it will only be saved for one hour. + +```bash +kubectl get event --field-selector reason=ComputerJobFailed --field-selector involvedObject.name=pagerank-sample -n hugegraph-computer-system +``` + +### 10 Show success event of a job + +> NOTE: it will only be saved for one hour + +```bash +kubectl get event --field-selector reason=ComputerJobSucceed --field-selector involvedObject.name=pagerank-sample -n hugegraph-computer-system +``` \ No newline at end of file
