jaas - GitLite

KO | EN

gitlite — search

#javascript #hacktoberfest #react #llm #go #golang #rust #deep-learning #linux #docker #cli #pytorch #ios #openai

jaas

(★ 309)

Run jobs (tasks/one-shot containers) with Docker

파일 탐색기

최종 버전 다운로드 (.zip)

파일 수가 많아 일부만 표시됩니다. 전체 파일은 위 다운로드 버튼으로 확인해 주세요.

- ISSUE_TEMPLATE.md
- PULL_REQUEST_TEMPLATE.md
- jaas.go
- run.go
- version.go
- version_test.go
- - .gitignore
  - app.go
  - Dockerfile
  - README.md
- hashgen.sh
- install-buildx.sh
- install-docker.sh
- - task.go
- - types.go
- utils.go
.DEREK.yml
.gitignore
.travis.yml
CONTRIBUTING.md
Dockerfile
Gopkg.lock
Gopkg.toml
LICENSE
main.go
Makefile
README.md
README_RPI.md

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/alexellis/jaas

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd jaas

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Docker

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Docker Desktop 컨테이너를 빌드하고 실행하려면 필요합니다. 설치 후 실행해서 백그라운드에 켜두세요.

$ echo -n "S3_ACCESS_KEY_HERE" | docker secret create s3-access-key -

이 명령어를 터미널에 그대로 입력해 실행하세요.

✅ 터미널에 docker compose ps 를 입력해 컨테이너들이 Up 상태인지 확인하세요. README에 포트 번호가 적혀있다면 브라우저에서 http://localhost:포트번호 로 접속해보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

3. Make

보통

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Make Linux/macOS는 보통 기본 설치되어 있습니다. Windows는 별도 설치(예: MSYS2, WSL)가 필요합니다.

make

생성된 빌드 설정을 바탕으로 실제 컴파일을 진행해 실행 파일을 만듭니다.

✅ 에러 없이 끝나면 성공입니다. 생성된 실행 파일을 직접 실행해보세요.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

## Notice: archived

This project is archived, which means there are no plans for further development. If your company is using this in production, contact OpenFaaS Ltd for a commercial license and support. contact@openfaas.com

# Jobs as a Service (JaaS)

Run jobs (tasks/one-shot containers) on Docker Swarm

This project provides a simple Golang CLI tool that binds to the Docker Swarm API to create an ad-hoc/one-shot Service and then poll until it exits. Service logs can also be retrieved if the Docker daemon API version is greater than 1.29 or if the experimental feature is enabled on the Docker daemon.

[![Build Status](https://travis-ci.org/alexellis/jaas.svg?branch=master)](https://travis-ci.org/alexellis/jaas)

## Motivation and context

For a blog post covering use-cases for JaaS and more on the portions of the Docker API used see below:

* [Blog: One-shot containers on Docker Swarm](http://blog.alexellis.io/containers-on-swarm/)

Use-cases:

* Use an elastic cluster as your computer
* Clean up DB indexes
* Send emails
* Batch processing
* Replace cron scripts
* Run your server maintenance tasks
* Schedule dev-ops tasks

## Built for developers by developers

<a href="https://github.com/sponsors/alexellis/">
<img alt="Sponsor this project" src="https://github.com/alexellis/alexellis/blob/master/sponsor-today.png" width="65%" height="65%">
</a>

### See also: Serverless

If you would like to build Serverless applications with Kubernetes or Docker Swarm checkout OpenFaaS:

* [OpenFaaS.com](https://www.openfaas.com)

> The OpenFaaS project has dozens of contributors and thousands of GitHub stars - if you're here because you want to run short-lived functions then try it out today for asynchronous invocations, dashboards, scale-to-zero, and detailed metrics.

## Sponsor this project 🏆

If you want to see this project developed or are using it commercially, then please [sponsor it here](https://github.com/sponsors/alexellis)

## Get started

### Build and install the code

Pre-requisites:

* Docker 1.13 or newer (experimental mode must be enabled if accessing service logs with Docker versions >= 1.13 and < 1.29)
* [Go 1.9.2 (or Golang container)](https://golang.org/dl/)
* Enable Swarm Mode (`docker swarm init`)

**Run these commands**

```
# export GOPATH=$HOME/go
# go get -d -v github.com/alexellis/jaas
# cd $GOPATH/src/github.com/alexellis/jaas
# go install
# export PATH=$PATH:$GOPATH/bin
```

Now test `jaas` with `jaas --help`

### Running a task / batch job / one-shot container

* Run your first one-shot container with `jaas run`:

```bash
# jaas run -r --image alexellis2/cows:latest
```

The `-r` flag removes the Swarm service that was used to run your container.

> The exit code from your container will also be available, you can check it with `echo $?`

* Hiding logs

If you aren't interested in the output logs then run it with the `--show-logs=false` override:

```bash
# jaas run --image alexellis2/cows:latest --show-logs=false
```

* Override the command of the container

```bash
# jaas run --image alpine:3.12 --command "uname -a"

Printing service logs
w2018-02-06T13:40:00.131678932Z Linux f56d298c4ab9 4.9.75-linuxkit-aufs #1 SMP Tue Jan 9 10:58:17 UTC 2018 x86_64 Linux
```

You can also try the example in `examples/gotask`:

```bash
# jaas run -r --image alexellis2/go-task:2020-03-11
```

* Environment variables

Set environment variables with `--env` or `-e`:

```bash
# jaas run --image alpine:3.12 --env ENV1=val1 --env ENV2=val2 --command "env"

Service created: inspiring_elion (j90qjtc14usgps9t60tvogmts)
ID:  j90qjtc14usgps9t60tvogmts  Update at:  2018-07-14 18:02:57.147797437 +0000 UTC
...........

Exit code: 0
State: complete

Printing service logs
a2018-07-14T18:03:01.465983797Z PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
52018-07-14T18:03:01.466098037Z HOSTNAME=de0b5614fc88
)2018-07-14T18:03:01.466111965Z ENV1=val1
)2018-07-14T18:03:01.466122558Z ENV2=val2
*2018-07-14T18:03:01.466132520Z HOME=/root

Removing service...
```

* Removing service after completion

By default, the service is removed after it completes. To prevent that, run with the `--remove` or `-r` flag set to `false`:

```bash
# jaas run --image alpine:3.12 --remove=false

Service created: zen_hoover (nwf2zey3i387zkx5gp7yjk053)
ID:  nwf2zey3i387zkx5gp7yjk053  Update at:  2018-07-08 20:19:39.320494122 +0000 UTC
............

Exit code: 0
State: complete

Printing service logs

# docker service ls

ID            NAME        MODE        REPLICAS  IMAGE       PORTS
nwf2zey3i387  zen_hoover  replicated  0/1       alpine:3.7
```

* Docker authentication for registries

You can use `jaas` with Docker images in private registries or registries which require authentication.

Just run `docker login` then pass the `--registry` parameter and the encoded string you find in `~/.docker/config.json`.

If you want to encode a string manually then do the following:

```bash
$ export auth='{
    "username" : "myUserName",
    "password" : "secret",
    "email" : "my@email",
    "serveraddress" : "my.reg.domain"
  }'
$ jaas run --registry="`echo $auth | base64`" --image my.reg.domain/hello-world:latest
```

* Adding secret to service

To give the service access to an _existing secret_. run with the `--secret` or `-s` flag:

```bash
$ echo -n "S3_ACCESS_KEY_HERE" | docker secret create s3-access-key -
$ jaas run --image alpine:3.7 --secret s3-access-key --command "cat /run/secrets/s3-access-key"

Service created: priceless_tesla (f8gheat9f3b8cnnsjy9dth9y7)
ID:  f8gheat9f3b8cnnsjy9dth9y7  Update at:  2018-06-29 16:41:13.723257461 +0000 UTC
...........

Exit code: 0
State: complete

Printing service logs
(2018-06-29T16:41:19.057738088Z S3_ACCESS_KEY_HERE

Removing service...
```

_Notes on images_

You can have a multi-node swarm but make sure whatever image you choose is available in an accessible registry.

> A local image will not need to be pushed to a registry.

* Running jaas in a container

You can also run `jaas` in a container, but the syntax becomes slightly more verbose:

```
# docker run -ti -v /var/run/docker.sock:/var/run/docker.sock \
  alexellis2/jaas run --image alexellis2/cows:latest
```

## Real-life example

You can use `jaas` to get the value of your OpenFaaS gateway password on Docker Swarm. See the [OpenFaaS troubleshooting guide](https://docs.openfaas.com/deployment/troubleshooting/#swarm_1) for the usage.

### Roadmap:

Here are several features / enhancements on the roadmap, please make additional suggestions through Github issues.

* [x] Optionally delete service after fetching exit code/logs
* [x] Support passing environmental variables
* [x] Support private registry auth via `-registryAuth` flag
* [x] Move to cobra flags/args package for CLI
* [x] Support constraints on where to run tasks
* [x] Bind-mounting volumes
* [x] Overriding container command
* [x] Support optional secrets through CLI flag
* [x] Support environment variable files with `--env-file`

Todo:

* [ ] Add support for running jobs on Kubernetes
* [ ] Validation around images which are not in local library
* [ ] Extract stdout/stderr etc from logs in human readable format similar to `docker logs`
* [ ] Support incoming [jobs API for Swarm](https://github.com/moby/moby/issues/39447)

### Future:

* When task logs are available in the API this will be used instead of service logs.
* When event streams are released they will prevent the need to poll continually

## Similar tools

* [OpenFaaS](https://github.com/openfaas/faas) - OpenFaaS runs CLIs, microservices and functions on Kubernetes with built-in asynchronous invocation support
* [faasd](https://github.com/openfaas/faasd) - faasd is a tiny version of OpenFaaS that runs CLIs and functions on a single node without Kubernetes
* [kjob](https://github.com/stefanprodan/kjob) by Stefan Prodan appears to be a close variation of jaas, but for Kubernetes.
* [argo workflows](https://github.com/argoproj/argo) - argo workflows can be used to run tasks and pielines on Kubernetes

## Contributions are welcome

See the [contributing guide](CONTRIBUTING.md) and do not raise a PR unless you've read it all.