Argo volcano job plugin

About The Project

官方描述背景

As issue-7860 says:

It is expensive as it requires one pod per resource. 当前argo创建 K8s Resource需要单独启动1个pod来管理resource的生命周期代价有些高。
It only supports a single resource.
Resource manifests must come from the workflow. Resource定义必须来源于workflow定义中
Resources are strings, not structured YAML

Why this plugin?

当前和volcano CRD JOB结合时有以下问题:

If volcano job is Pending status because of some reasons such as lack of resource, the workflow status is Running (with a pod running).
If volcano job status is success or failed, the success condition or failedCondition is not very flexible in argo.

So I have make this project: A specified Plugin for Volcano Job

Built with

Open Source software stands on the shoulders of giants. It wouldn't have been possible to build this tool with very little extra work without the authors of these lovely projects below.

Gin Golang HTTP FrameWork
[Volcano API]

Getting Started

Todo here

Prerequisites

* This guide assumes you have a working Argo Workflows installation with v3.3.4 or newer.

rely on pr: pr-8194
rely on pr: pr-8176

* You will need to install the Argo CLI with v3.3.0 or newer.

You just need argo version with v3.3.5 or newer , they are fully supported ...

kubectl must be available and configured to access the Kubernetes cluster where Argo Workflows is installed.

Installation

Clone the repository and change to the argo-plugin/ directory:

git https://github.com/xfyun/argo-volcano-executor-plugin
cd argo-volcano-executor-plugin/install

Build the plugin ConfigMap: [you can also directly edit volcano-executor-plugin-configmap.yaml]
```
# This step is not required if don't understand here...
argo executor-plugin build .
```
Register the plugin with Argo in your cluster:

Ensure to specify --namespace if you didn't install Argo in the default namespace.
```
kubectl apply -f volcano-executor-plugin-configmap.yaml
```
other rbac config and sa config in rbac_dir

Usage

Now that the plugin is registered in Argo, you can run workflow steps as Volcano modules by simply calling the volcano plugin:

apiVersion: argoproj.io/v1alpha1
kind: Workflow
metadata:
  generateName: hello-
spec:
  automountServiceAccountToken: true
  entrypoint: main
  templates:
    - name: main
      executor:
        serviceAccountName: volcano-executor-plugin
      plugin:
        volcano:
          job:
            apiVersion: batch.volcano.sh/v1alpha1
            kind: Job
            metadata:
              name: "{{workflow.name}}"
              namespace: "{{workflow.namespace}}"
              ownerReferences:
                - apiVersion: argoproj.io/v1alpha1
                  blockOwnerDeletion: true
                  controller: true
                  kind: Workflow
                  name: "{{workflow.name}}"
                  uid: "{{workflow.uid}}"
            spec:
              minAvailable: 3
              schedulerName: volcano
              plugins:
                env: []
                svc: []
              queue: default
              policies:
                - event: PodEvicted
                  action: RestartJob
                - event: TaskCompleted
                  action: CompleteJob
              tasks:
                - replicas: 1
                  name: ps
                  template:
                    spec:
                      containers:
                        - command:
                            - sh
                            - -c
                            - |
                              PS_HOST=`cat /etc/volcano/ps.host | sed 's/$/&:2222/g' | sed 's/^/"/;s/$/"/' | tr "\n" ","`;
                              WORKER_HOST=`cat /etc/volcano/worker.host | sed 's/$/&:2222/g' | sed 's/^/"/;s/$/"/' | tr "\n" ","`;
                              export TF_CONFIG={\"cluster\":{\"ps\":[${PS_HOST}],\"worker\":[${WORKER_HOST}]},\"task\":{\"type\":\"ps\",\"index\":${VK_TASK_INDEX}},\"environment\":\"cloud\"};
                              python /var/tf_dist_mnist/dist_mnist.py
                          image: volcanosh/dist-mnist-tf-example:0.0.1
                          name: tensorflow
                          ports:
                            - containerPort: 2222
                              name: tfjob-port
                          resources: {}
                      restartPolicy: Never
                - replicas: 2
                  name: worker
                  policies:
                    - event: TaskCompleted
                      action: CompleteJob
                  template:
                    spec:
                      containers:
                        - command:
                            - sh
                            - -c
                            - |
                              PS_HOST=`cat /etc/volcano/ps.host | sed 's/$/&:2222/g' | sed 's/^/"/;s/$/"/' | tr "\n" ","`;
                              WORKER_HOST=`cat /etc/volcano/worker.host | sed 's/$/&:2222/g' | sed 's/^/"/;s/$/"/' | tr "\n" ","`;
                              export TF_CONFIG={\"cluster\":{\"ps\":[${PS_HOST}],\"worker\":[${WORKER_HOST}]},\"task\":{\"type\":\"worker\",\"index\":${VK_TASK_INDEX}},\"environment\":\"cloud\"};
                              python /var/tf_dist_mnist/dist_mnist.py
                          image: volcanosh/dist-mnist-tf-example:0.0.1
                          name: tensorflow
                          ports:
                            - containerPort: 2222
                              name: tfjob-port
                          resources: {}
                      restartPolicy: Never

The volcano template will produce vcjob that you can use command kubect get vcjob to browse them .

Current Issue && Limits

you need the argo version > v3.3.1 [not include v3.3.1] I modified the argo as pr-8104 did.

Tested Argo Version

v3.3.5 or newer

Roadmap

[ * ] Support config service account

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

Fork the Project
Create your Feature Branch (git checkout -b feature/AmazingFeature)
Commit your Changes (git commit -m 'Add some AmazingFeature')
Push to the Branch (git push origin feature/AmazingFeature)
Open a Pull Request

Contact

Project Link: https://github.com/xfyun/argo-volcano-executor-plugin

iflytek/argo-volcano-executor-plugin