https://github.com/pevers/argo-containerless-plugin
Plugin to deploy Node/Python packages from a GH repository
https://github.com/pevers/argo-containerless-plugin
Last synced: 5 months ago
JSON representation
Plugin to deploy Node/Python packages from a GH repository
- Host: GitHub
- URL: https://github.com/pevers/argo-containerless-plugin
- Owner: pevers
- Created: 2022-09-18T14:27:03.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-09-29T10:11:15.000Z (over 3 years ago)
- Last Synced: 2024-12-29T21:45:25.164Z (over 1 year ago)
- Language: Rust
- Size: 837 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# argo-containerless-plugin
Plugin to deploy Python/Node packages directly from a git repository as Argo Workflow step.
## Example
This will run this specific Python package from the `main` branch directly as Argo Workflow step.
```yaml
apiVersion: argoproj.io/v1alpha1
kind: Workflow
metadata:
generateName: containerless-
spec:
entrypoint: main
templates:
- name: main
plugin:
containerless:
# Python >= 3.7 is supported
runtime: python-3.10
repoURL: https://github.com/pevers/example-python-step.git
targetRevision: main
args:
- "src/example.py"
- "Promaton Hackathon"
```
## Supports
- [x] Python modules that can be installed via Poetry (pyproject.toml)
- [x] Python 3.7, 3.8, 3.9, 3.10
- [ ] Other Python build tools (pipenv, conda, ...)
- [ ] Node
## How it works
The Dockerfile creates an environment having multiple Python versions. We use Poetry to create a new virtual environment per module. Poetry is also used to install all project dependencies via a `pyproject.toml` file.
## Compile and test
This requires an environment with the following tools installed.
- Python
- Git
- Poetry
- PyEnv
```rust
cargo build
RUST_LOG=info ARGO_TOKEN_PATH=test/token cargo test
```
## Deploy in a local Kubernetes cluster
The Makefile assumes a local cluster created with a local registry. For example.
```console
k3d cluster create mycluster --registry-create mycluster-registry --volume /tmp/k3dvol:/tmp/k3dvol
```
Install Argo following [this](https://argoproj.github.io/argo-workflows/quick-start/) tutorial.
Alter the Makefile so that the local registry port is known. Then use the Makefile to deploy the plugin.
```console
docker ps -f name=mycluster-registry # Extract port number and edit Makefile
make run-all-dev
```
Submit an example workflow by running.
```console
argo submit -n argo/workflow.yaml
```
## Roadmap
- [ ] Semantics should be the same as the Argo "script" step, maybe we should support the `ScriptTemplate` parameter
- [ ] Make sure all errors are propagated correctly and the user has enough information when something fails
- [ ] Make sure that the remote script execution is safe enough (restricted to plugin container?)
- [ ] Checkout remote branches automatically (instead of origin/branch-name)
- [ ] Terminating workflow steps causes a controller exception
- [ ] Artifact/Parameters should be handled correctly
- [ ] Make sure that errors are thrown for incorrect Python scripts
- [ ] Publish a first version to Docker hub
- [ ] Create Helm chart for plugin
- [ ] Support for Node modules