From 63a5124f57060cc4aeeac638a6efd768699bc18b Mon Sep 17 00:00:00 2001 From: eshon <1017762+eshon@users.noreply.github.com> Date: Fri, 24 Jan 2020 21:47:14 +0100 Subject: [PATCH] Moving lotus PR 745 into a tools/dockers/ directory and adding some other examples --- tools/dockers/README.md | 3 ++ tools/dockers/docker-examples/README.md | 34 +++++++++++++++++++ .../api-hosted-debian-nginx/README.md | 10 ++++++ .../docker-examples/api-local-arch/README.md | 8 +++++ .../basic-miner-busybox/Dockerfile | 0 .../basic-miner-busybox/README.md | 4 +++ 6 files changed, 59 insertions(+) create mode 100644 tools/dockers/README.md create mode 100644 tools/dockers/docker-examples/README.md create mode 100644 tools/dockers/docker-examples/api-hosted-debian-nginx/README.md create mode 100644 tools/dockers/docker-examples/api-local-arch/README.md rename Dockerfile => tools/dockers/docker-examples/basic-miner-busybox/Dockerfile (100%) create mode 100644 tools/dockers/docker-examples/basic-miner-busybox/README.md diff --git a/tools/dockers/README.md b/tools/dockers/README.md new file mode 100644 index 000000000..66bfdc2e3 --- /dev/null +++ b/tools/dockers/README.md @@ -0,0 +1,3 @@ +## About + +In [docker-examples/](docker-examples/) are community-contributed Docker and Docker Compose examples. diff --git a/tools/dockers/docker-examples/README.md b/tools/dockers/docker-examples/README.md new file mode 100644 index 000000000..24a6c3d2f --- /dev/null +++ b/tools/dockers/docker-examples/README.md @@ -0,0 +1,34 @@ +## About + +In this `docker-examples/` directory are community-contributed Docker and Docker Compose examples. + +#### Example Use Cases + +- **For a miner** + - basic storage miner (`miner-basic-`) + - distributed storage miner +- **For API endpoints for building apps** + - local node for a developer (`api-local-`) + - hosted endpoint for apps / multiple developers (`api-hosted-`) +- **For a local devnet or shared devnet** + - basic local devnet (also see [lotus docs on setting up a local devnet](https://lotu.sh/en+setup-local-dev-net)) + - shared devnet + + +## Contributions + +- `miner-basic-busybox` - from @ldoublewood ([lotus PR 745](https://github.com/filecoin-project/lotus/pull/745)) +- `api-local-arch` - from @mateodelnorte +- `api-hosted-debian-nginx` - from @RTradeLtd + +#### More examples: +- [Issue 1143](https://github.com/filecoin-project/lotus/issues/1143) +- [PR 1047](https://github.com/filecoin-project/lotus/pull/1047/files) + +## Contributing + +:whale: Have a new type of Docker to share? + +Make a PR with a new folder for it, describe its purpose and link to the repo or provide the Docker files. Add it to *Contributions* above. + +:beetle: See a bug? File an Issue so we can keep these up-to-date. diff --git a/tools/dockers/docker-examples/api-hosted-debian-nginx/README.md b/tools/dockers/docker-examples/api-hosted-debian-nginx/README.md new file mode 100644 index 000000000..b41e399d4 --- /dev/null +++ b/tools/dockers/docker-examples/api-hosted-debian-nginx/README.md @@ -0,0 +1,10 @@ +## Description + +- **For API endpoints for building apps** + - hosted endpoint for multiple developers + +Another container spins up a simple block explorer. + +## Repo + +https://github.com/RTradeLtd/lotus-infra \ No newline at end of file diff --git a/tools/dockers/docker-examples/api-local-arch/README.md b/tools/dockers/docker-examples/api-local-arch/README.md new file mode 100644 index 000000000..a31403f68 --- /dev/null +++ b/tools/dockers/docker-examples/api-local-arch/README.md @@ -0,0 +1,8 @@ +## Description + +- **For API endpoints for building apps** + - local node for a developer + +## Repo + +https://github.com/mateodelnorte/filecoin-lotus-docker \ No newline at end of file diff --git a/Dockerfile b/tools/dockers/docker-examples/basic-miner-busybox/Dockerfile similarity index 100% rename from Dockerfile rename to tools/dockers/docker-examples/basic-miner-busybox/Dockerfile diff --git a/tools/dockers/docker-examples/basic-miner-busybox/README.md b/tools/dockers/docker-examples/basic-miner-busybox/README.md new file mode 100644 index 000000000..067f87d10 --- /dev/null +++ b/tools/dockers/docker-examples/basic-miner-busybox/README.md @@ -0,0 +1,4 @@ +## Description + +- **For a miner** + - basic storage miner