{"id":15640040,"url":"https://github.com/alexellis/minio-kv","last_synced_at":"2025-04-30T07:24:59.443Z","repository":{"id":63796446,"uuid":"86328379","full_name":"alexellis/minio-kv","owner":"alexellis","description":"Simple KV HTTP API for Minio / S3 - store JSON documents or binary blobs","archived":false,"fork":false,"pushed_at":"2019-10-28T15:00:22.000Z","size":3245,"stargazers_count":82,"open_issues_count":5,"forks_count":15,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-30T13:51:16.366Z","etag":null,"topics":["api","docker","http","minio","rest","s3","storage"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/alexellis.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-03-27T11:41:57.000Z","updated_at":"2025-02-22T10:32:52.000Z","dependencies_parsed_at":"2022-11-26T06:31:38.820Z","dependency_job_id":null,"html_url":"https://github.com/alexellis/minio-kv","commit_stats":null,"previous_names":["alexellis/minio-db"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexellis%2Fminio-kv","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexellis%2Fminio-kv/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexellis%2Fminio-kv/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexellis%2Fminio-kv/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alexellis","download_url":"https://codeload.github.com/alexellis/minio-kv/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251659480,"owners_count":21623056,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","docker","http","minio","rest","s3","storage"],"created_at":"2024-10-03T11:30:35.568Z","updated_at":"2025-04-30T07:24:59.424Z","avatar_url":"https://github.com/alexellis.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# minio-kv\n\nminio-kv creates a simple key-value store from [Minio](https://min.io) or AWS S3. It adds a simple HTTP API for storing JSON documents and binary blobs with streaming capabilities.\n\n## Usage\n\n* Putting a JSON object:\n\n    URI: `/put/{object:[a-zA-Z0-9.-_]+}`\n\n    Request Body: contents of object\n\n* Getting a JSON object:\n\n    URI: `/get/{object:[a-zA-Z0-9.-_]+}`\n\n    Response body: contents of object if found\n\n* Putting a binary object with streaming:\n\n    URI: `/put-streaming-blob/{object:[a-zA-Z0-9.-_]+}`\n\n    Request Body: contents of object\n\n* Getting a binary object with streaming:\n\n    URI: `/put-streaming-blob/{object:[a-zA-Z0-9.-_]+}`\n\n    Response body: contents of object if found\n\n\n* Putting a binary object without streaming:\n\n    URI: `/put-blob/{object:[a-zA-Z0-9.-_]+}`\n\n    Request Body: contents of object\n\n* Getting a binary object without streaming:\n\n    URI: `/put-blob/{object:[a-zA-Z0-9.-_]+}`\n\n    Response body: contents of object if found\n\n## Status\n\nSuitable for testing and local use, authentication is not included in the HTTP API.\n\nBacklog:\n\n- [x] Add streaming modes\n- [x] Migrate to Docker / Go 1.11\n- [x] Use vendoring for dependencies\n- [ ] Add Kubernetes `Deployment` and `Service`\n- [ ] Read secrets from either env-var or from files mounted at path\n- [ ] Add auth for all HTTP APIs using shared secret Bearer token\n\n## Testing\n\n```sh\ndocker run -e MINIO_ACCESS_KEY=511e8d6c84ee65feda34efdcc5366281a22b6dfd -e MINIO_SECRET_KEY=d88b4816ac11f0ee5efcc5282d2fe9896162a1d6 --name minio -p 9000:9000 minio/minio server /tmp/\n```\n\nRun the app\n\n```sh\ngo build \u0026\u0026 port=8081 host=127.0.0.1:9000 MINIO_ACCESS_KEY=511e8d6c84ee65feda34efdcc5366281a22b6dfd MINIO_SECRET_KEY=d88b4816ac11f0\nee5efcc5282d2fe9896162a1d6 ./minio-kv\n```\n\nGet/put a big binary file:\n\n```\ncurl localhost:8081/put-blob-stream/test --data-binary @big-file.img\ncurl localhost:8081/get-blob-stream/test \u003e big-file-out.img\n\ndiff big-file.img big-file-out.img\n```\n\n## Running on Kubernetes\n\n**Create MINIO_ACCESS_KEY, MINIO_SECRET_KEY environment variables**\n```\nMINIO_ACCESS_KEY=$(head -c 12 /dev/urandom | shasum | cut -d  ' ' -f1) \\\nMINIO_SECRET_KEY=$(head -c 12 /dev/urandom | shasum | cut -d  ' ' -f1) \\\nTOKEN=$(head -c 12 /dev/urandom | shasum | cut -d  ' ' -f1)\n```\n\n**Create secrets out of the above env vars**\n```\nkubectl create secret generic minio-kv \\\n--from-literal=minio-access-key=$MINIO_ACCESS_KEY \\\n--from-literal=minio-secret-key=$MINIO_SECRET_KEY \\\n--from-literal=token=$TOKEN\n```\n\n**(If Helm is not installed)**\nFollow the instructions [here](https://github.com/openfaas/faas-netes/blob/master/HELM.md).\n\n**Install Minio with Helm**\n```\nhelm install --name minio --namespace default \\\n   --set accessKey=\"$MINIO_ACCESS_KEY\" \\\n   --set secretKey=\"$MINIO_SECRET_KEY\" \\\n   --set replicas=1 \\\n   --set persistence.enabled=false \\\n   --set service.port=9000 \\\n   --set service.type=ClusterIP \\\nstable/minio\n```\n\n**Create the kubernetes deployment and service**\n```\nkubectl apply -f yaml/\n```\n\n## License\n\nMIT, Alex Ellis 2017-2019\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falexellis%2Fminio-kv","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falexellis%2Fminio-kv","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falexellis%2Fminio-kv/lists"}