{"id":20677759,"url":"https://github.com/clivern/peanut","last_synced_at":"2025-05-15T09:04:01.296Z","repository":{"id":37242524,"uuid":"380516029","full_name":"Clivern/Peanut","owner":"Clivern","description":"🐺 Deploy Databases and Services Easily for Development and Testing Pipelines.","archived":false,"fork":false,"pushed_at":"2025-03-26T21:08:30.000Z","size":33789,"stargazers_count":729,"open_issues_count":17,"forks_count":27,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-03-31T02:12:24.549Z","etag":null,"topics":["clivern","containerization","database","developer-tools","devops","docker","go","golang","hacktoberfest","message-broker","peanut"],"latest_commit_sha":null,"homepage":"https://clivern.github.io/Peanut/","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/Clivern.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":null,"custom":"clivern.com/sponsor/"}},"created_at":"2021-06-26T14:03:39.000Z","updated_at":"2025-02-17T16:53:57.000Z","dependencies_parsed_at":"2023-12-19T01:30:22.611Z","dependency_job_id":"4a31b582-cb11-463f-ac7f-47e277f080d0","html_url":"https://github.com/Clivern/Peanut","commit_stats":{"total_commits":497,"total_committers":7,"mean_commits":71.0,"dds":"0.23742454728370221","last_synced_commit":"b9de8a598c1687e4620909d97eaa501a60f9d582"},"previous_names":[],"tags_count":46,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Clivern%2FPeanut","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Clivern%2FPeanut/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Clivern%2FPeanut/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Clivern%2FPeanut/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Clivern","download_url":"https://codeload.github.com/Clivern/Peanut/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247584110,"owners_count":20962075,"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":["clivern","containerization","database","developer-tools","devops","docker","go","golang","hacktoberfest","message-broker","peanut"],"created_at":"2024-11-16T21:16:57.797Z","updated_at":"2025-04-07T03:17:05.033Z","avatar_url":"https://github.com/Clivern.png","language":"Go","readme":"\u003cp align=\"center\"\u003e\n    \u003cimg src=\"/static/logo.png?v=0.7.0\" width=\"240\" /\u003e\n    \u003ch3 align=\"center\"\u003ePeanut\u003c/h3\u003e\n    \u003cp align=\"center\"\u003eDeploy Databases and Services Easily for Development and Testing Pipelines.\u003c/p\u003e\n    \u003cp align=\"center\"\u003e\n        \u003ca href=\"https://github.com/Clivern/Peanut/actions/workflows/api.yml\"\u003e\n            \u003cimg src=\"https://github.com/Clivern/Peanut/actions/workflows/api.yml/badge.svg\"\u003e\n        \u003c/a\u003e\n        \u003ca href=\"https://github.com/Clivern/Peanut/actions/workflows/ui.yml\"\u003e\n            \u003cimg src=\"https://github.com/Clivern/Peanut/actions/workflows/ui.yml/badge.svg\"\u003e\n        \u003c/a\u003e\n        \u003ca href=\"https://github.com/Clivern/Peanut/actions\"\u003e\n            \u003cimg src=\"https://github.com/Clivern/Peanut/workflows/Release/badge.svg\"\u003e\n        \u003c/a\u003e\n        \u003ca href=\"https://github.com/Clivern/Peanut/releases\"\u003e\n            \u003cimg src=\"https://img.shields.io/badge/Version-0.7.0-red.svg\"\u003e\n        \u003c/a\u003e\n        \u003ca href=\"https://goreportcard.com/report/github.com/Clivern/Peanut\"\u003e\n            \u003cimg src=\"https://goreportcard.com/badge/github.com/Clivern/Peanut?v=0.7.0\"\u003e\n        \u003c/a\u003e\n        \u003ca href=\"https://godoc.org/github.com/clivern/peanut\"\u003e\n            \u003cimg src=\"https://godoc.org/github.com/clivern/peanut?status.svg\"\u003e\n        \u003c/a\u003e\n        \u003ca href=\"https://github.com/Clivern/Peanut/blob/master/LICENSE\"\u003e\n            \u003cimg src=\"https://img.shields.io/badge/LICENSE-MIT-orange.svg\"\u003e\n        \u003c/a\u003e\n    \u003c/p\u003e\n\u003c/p\u003e\n\u003cbr/\u003e\n\u003cp align=\"center\"\u003e\n    \u003cimg src=\"/static/chart.png?v=0.7.0\" width=\"80%\" /\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n    \u003ch4 align=\"center\"\u003eDashboard Screenshots\u003c/h4\u003e\n    \u003cp align=\"center\"\u003e\n        \u003cimg src=\"/static/screenshot_01.png?v=0.7.0\" width=\"90%\" /\u003e\n        \u003cimg src=\"/static/screenshot_02.png?v=0.7.0\" width=\"90%\" /\u003e\n        \u003cimg src=\"/static/screenshot_03.png?v=0.7.0\" width=\"90%\" /\u003e\n        \u003cimg src=\"/static/screenshot_04.png?v=0.7.0\" width=\"90%\" /\u003e\n    \u003c/p\u003e\n\u003c/p\u003e\n\n\nPeanut provides a REST API, Admin Dashboard and a command line tool to deploy and configure the commonly used services like databases, message brokers, graphing, tracing, caching tools ... etc. It perfectly suited for development, manual testing, automated testing pipelines where mocking is not possible and test drives.\n\nUnder the hood, it works with the containerization runtime like docker to deploy and configure the service. Destroy the service if it is a temporary one.\n\nTechnically you can achieve the same with a bunch of yaml files or using a configuration management tool or a package manager like helm but peanut is pretty small and fun to use \u0026 should speed up your workflow!\n\nSupported Services:\n\n- MySQL.\n- MariaDB.\n- PostgreSQL.\n- Redis.\n- Etcd.\n- Grafana.\n- Elasticsearch.\n- MongoDB.\n- Graphite.\n- Prometheus.\n- Zipkin.\n- Memcached.\n- Mailhog.\n- Jaeger.\n- RabbitMQ.\n- Consul.\n- Vault.\n- Cassandra.\n- Minio.\n- Docker Registry.\n- Ghost.\n- Httpbin.\n- Nagios.\n- Etherpad.\n\n\n## Documentation\n\n#### Run Peanut on Ubuntu\n\nTo run peanut on ubuntu, You can use the following bash script since it may take a while for a cold start. the script will install etcd, docker, docker-compose and peanut.\n\n```zsh\n$ bash \u003c \u003c(curl -s https://raw.githubusercontent.com/Clivern/Peanut/main/deployment/linux/install.sh)\n\n# Get The Public IP\n$ curl https://ipinfo.io/ip\nx.x.x.x\n```\n\nPeanut will be running on `80` port and UI on this URL `http://x.x.x.x`. Please open this file `/etc/peanut/config.prod.yml` and adjust the following line to be your `Public IP` or `hostname`\n\n```zsh\n# App configs\napp:\n    ...\n    # Hostname\n    hostname: ${PEANUT_API_HOSTNAME:-127.0.0.1}\n```\n\nThen Restart Peanut\n\n```zsh\n$ systemctl restart peanut\n```\n\nTo make sure peanut is running, Run the following from your laptop to run some redis instances for 10 minutes.\n\n```zsh\n# To provision redis services for 10 minutes\n$ curl -X POST http://$PUBLIC_IP/api/v1/service -d '{\"service\":\"redis\",\"configs\": {},\"deleteAfter\":\"10min\"}' -H 'x-api-key: ~api~key~here~'\n\n{\n  \"createdAt\": \"2021-07-11T09:58:11.076Z\",\n  \"id\": \"aadd5741-58c5-43c7-94fd-e6c0171fe8be\",\n  \"service\": \"a8138f52-3ebb-4a34-b403-1be6ad481daf\",\n  \"status\": \"PENDING\",\n  \"type\": \"service.deploy\"\n}\n\n\n# To list services including the host and port to use for connection\n$ curl -X GET http://$PUBLIC_IP/api/v1/service  -H 'x-api-key: ~api~key~here~'\n\n{\n  \"services\": [\n    {\n      \"id\": \"9d655cbe-caf1-4104-b8e4-b83fd569b509\",\n      \"service\": \"redis\",\n      \"configs\": {\n        \"address\": \"127.0.0.1\",\n        \"password\": \"\",\n        \"port\": \"49156\"\n      },\n      \"deleteAfter\": \"10min\",\n      \"createdAt\": \"2021-07-11T09:58:13Z\",\n      \"updatedAt\": \"2021-07-11T09:58:13Z\"\n    },\n    {\n      \"id\": \"a8138f52-3ebb-4a34-b403-1be6ad481daf\",\n      \"service\": \"redis\",\n      \"configs\": {\n        \"address\": \"127.0.0.2\",\n        \"password\": \"\",\n        \"port\": \"49155\"\n      },\n      \"deleteAfter\": \"\",\n      \"createdAt\": \"2021-07-11T09:58:12Z\",\n      \"updatedAt\": \"2021-07-11T09:58:12Z\"\n    }\n  ]\n}\n```\n\nThere is also a script to upgrade peanut.\n\n```zsh\n$ bash \u003c \u003c(curl -s https://raw.githubusercontent.com/Clivern/Peanut/main/deployment/linux/upgrade.sh)\n```\n\n\n#### Linux Deployment Explained\n\nDownload [the latest peanut binary](https://github.com/Clivern/Peanut/releases). Make it executable from everywhere.\n\n```zsh\n$ export PEANUT_LATEST_VERSION=$(curl --silent \"https://api.github.com/repos/Clivern/Peanut/releases/latest\" | jq '.tag_name' | sed -E 's/.*\"([^\"]+)\".*/\\1/' | tr -d v)\n\n$ curl -sL https://github.com/Clivern/Peanut/releases/download/v{$PEANUT_LATEST_VERSION}/peanut_{$PEANUT_LATEST_VERSION}_Linux_x86_64.tar.gz | tar xz\n```\n\nThen install `etcd` cluster or a single node! please refer to etcd docs or bin directory inside this repository.\n\nInstall the virtualization runtime! By default peanut uses `docker` \u0026 `docker-compose`\n\n```zsh\n$ apt-get update\n$ apt-get install docker.io -y\n$ systemctl enable docker\n\n$ apt-get install docker-compose -y\n```\n\nCreate the configs file `config.yml` from `config.dist.yml`. Something like the following:\n\n```yaml\n# App configs\napp:\n    # Env mode (dev or prod)\n    mode: ${PEANUT_APP_MODE:-dev}\n    # HTTP port\n    port: ${PEANUT_API_PORT:-8000}\n    # Hostname\n    hostname: ${PEANUT_API_HOSTNAME:-127.0.0.1}\n    # TLS configs\n    tls:\n        status: ${PEANUT_API_TLS_STATUS:-off}\n        pemPath: ${PEANUT_API_TLS_PEMPATH:-cert/server.pem}\n        keyPath: ${PEANUT_API_TLS_KEYPATH:-cert/server.key}\n\n    # Containerization runtime (supported docker)\n    containerization:\n        driver: ${PEANUT_CONTAINERIZATION_DRIVER:-docker}\n\n        # Clean up stale images, volumes and networks\n        autoClean: ${PEANUT_CONTAINERIZATION_AUTO_CLEAN:-true}\n\n        # Time to cache docker images tags\n        cacheTagsTimeInMinutes: ${PEANUT_CONTAINERIZATION_CACHE_TIME:-10080}\n\n    # App Storage\n    storage:\n        # Type (only local supported)\n        type: ${PEANUT_STORAGE_TYPE:-local}\n        # Local Path\n        path: ${PEANUT_STORAGE_PATH:-/tmp}\n\n    # API Configs\n    api:\n        key: ${PEANUT_API_KEY:-6c68b836-6f8e-465e-b59f-89c1db53afca}\n\n    # Async Workers\n    workers:\n        # Queue max capacity\n        buffer: ${PEANUT_WORKERS_CHAN_CAPACITY:-5000}\n        # Number of concurrent workers\n        count: ${PEANUT_WORKERS_COUNT:-4}\n\n    # Runtime, Requests/Response and Peanut Metrics\n    metrics:\n        prometheus:\n            # Route for the metrics endpoint\n            endpoint: ${PEANUT_METRICS_PROM_ENDPOINT:-/metrics}\n\n    # Application Database\n    database:\n        # Database driver\n        driver: ${PEANUT_DB_DRIVER:-etcd}\n\n        # Etcd Configs\n        etcd:\n            # Etcd database name or prefix\n            databaseName: ${PEANUT_DB_ETCD_DB:-peanut}\n            # Etcd username\n            username: ${PEANUT_DB_ETCD_USERNAME:- }\n            # Etcd password\n            password: ${PEANUT_DB_ETCD_PASSWORD:- }\n            # Etcd endpoints\n            endpoints: ${PEANUT_DB_ETCD_ENDPOINTS:-http://127.0.0.1:2379}\n            # Timeout in seconds\n            timeout: 30\n\n    # Log configs\n    log:\n        # Log level, it can be debug, info, warn, error, panic, fatal\n        level: ${PEANUT_LOG_LEVEL:-info}\n        # Output can be stdout or abs path to log file /var/logs/peanut.log\n        output: ${PEANUT_LOG_OUTPUT:-stdout}\n        # Format can be json\n        format: ${PEANUT_LOG_FORMAT:-json}\n```\n\nThe run the `peanut` with `systemd`\n\n```zsh\n$ peanut api -c /path/to/config.yml\n```\n\nDeploy your first redis server!\n\n```zsh\n$ curl -X POST http://127.0.0.1:8000/api/v1/service -d '{\"service\":\"redis\"}' -H 'x-api-key: ~api~key~here~'\n```\n\n\n#### To run the Admin Dashboard (Development Only):\n\nClone the project or your own fork:\n\n```zsh\n$ git clone https://github.com/Clivern/Peanut.git\n```\n\nCreate the dashboard config file `web/.env` from `web/.env.dist`. Something like the following:\n\n```\nVUE_APP_API_URL=http://localhost:8080\n```\n\nThen you can either build or run the dashboard\n\n```zsh\n# Install npm packages\n$ cd web\n$ npm install\n$ npm install -g npx\n\n# Add api server url to frontend\n$ echo \"VUE_APP_API_URL=http://127.0.0.1:8000\" \u003e .env\n\n$ cd ..\n\n# Validate js code format\n$ make check_ui_format\n\n# Format UI\n$ make format_ui\n\n# Run Vuejs app\n$ make serve_ui\n\n# Build Vuejs app\n$ make build_ui\n\n# Build the Vuejs app\n$ make package\n```\n\n\n#### The command line tool\n\nIn order to interact with peanut API server, you can either do basic API calls or use the provided command line tool. It is still not finished yet but it will be ready soon.\n\n\n#### Supported Services\n\nHere is a list of all supported services so far and the API call to deploy them.\n\n- MySQL.\n\n```zsh\n$ curl -X POST http://127.0.0.1:8000/api/v1/service \\\n    -d '{\"service\":\"mysql\",\"configs\": {\"rootPassword\": \"root\", \"database\": \"peanut\", \"username\": \"peanut\", \"password\": \"secret\"}}' \\\n    -H 'x-api-key: ~api~key~here~'\n```\n\n- MariaDB.\n\n```zsh\n$ curl -X POST http://127.0.0.1:8000/api/v1/service \\\n    -d '{\"service\":\"mariadb\",\"configs\": {\"rootPassword\": \"root\", \"database\": \"peanut\", \"username\": \"peanut\", \"password\": \"secret\"}}' \\\n    -H 'x-api-key: ~api~key~here~'\n```\n\n- PostgreSQL.\n\n```zsh\n$ curl -X POST http://127.0.0.1:8000/api/v1/service \\\n    -d '{\"service\":\"postgresql\",\"configs\": {\"database\": \"peanut\", \"username\": \"peanut\", \"password\": \"secret\"}}' \\\n    -H 'x-api-key: ~api~key~here~'\n```\n\n- Redis.\n\n```zsh\n$ curl -X POST http://127.0.0.1:8000/api/v1/service \\\n    -d '{\"service\":\"redis\",\"configs\": {\"password\": \"secret\"}}' \\\n    -H 'x-api-key: ~api~key~here~'\n```\n\n- Etcd.\n\n```zsh\n$ curl -X POST http://127.0.0.1:8000/api/v1/service \\\n    -d '{\"service\":\"etcd\"}' \\\n    -H 'x-api-key: ~api~key~here~'\n```\n\n- Grafana.\n\n```zsh\n$ curl -X POST http://127.0.0.1:8000/api/v1/service \\\n    -d '{\"service\":\"grafana\",\"configs\": {\"username\": \"admin\", \"password\": \"admin\", \"allowSignup\": \"false\", \"anonymousAccess\": \"true\"}}' \\\n    -H 'x-api-key: ~api~key~here~'\n```\n\n- Elasticsearch.\n\n```zsh\n$ curl -X POST http://127.0.0.1:8000/api/v1/service \\\n    -d '{\"service\":\"elasticsearch\"}' \\\n    -H 'x-api-key: ~api~key~here~'\n```\n\n- MongoDB.\n\n```zsh\n$ curl -X POST http://127.0.0.1:8000/api/v1/service \\\n    -d '{\"service\":\"mongodb\",\"configs\": {\"database\": \"peanut\", \"username\": \"peanut\", \"password\": \"secret\"}}' \\\n    -H 'x-api-key: ~api~key~here~'\n```\n\n- Graphite.\n\n```zsh\n$ curl -X POST http://127.0.0.1:8000/api/v1/service \\\n    -d '{\"service\":\"graphite\"}' \\\n    -H 'x-api-key: ~api~key~here~'\n```\n\n- Prometheus.\n\n```zsh\n$ curl -X POST http://127.0.0.1:8000/api/v1/service \\\n    -d '{\"service\":\"prometheus\"}' \\\n    -H 'x-api-key: ~api~key~here~'\n\n# Configs can be provided as base64 encoded string (use https://www.base64encode.org/)\n$ curl -X POST http://127.0.0.1:8000/api/v1/service \\\n    -d '{\"service\":\"prometheus\", \"configs\": {\"configsBase64Encoded\": \"Z2xvYmFsOgogIGV2YWx1YXRpb25faW50ZXJ2YWw6IDE1cwogIHNjcmFwZV9pbnRlcnZhbDogMTVzCnJ1bGVfZmlsZXM6IH4Kc2NyYXBlX2NvbmZpZ3M6CiAgLQogICAgam9iX25hbWU6IHByb21ldGhlCiAgICBzY3JhcGVfaW50ZXJ2YWw6IDVzCiAgICBzdGF0aWNfY29uZmlnczoKICAgICAgLQogICAgICAgIHRhcmdldHM6CiAgICAgICAgICAtICJsb2NhbGhvc3Q6OTA5MCI=\"}}' \\\n    -H 'x-api-key: ~api~key~here~'\n```\n\n- Zipkin.\n\n```zsh\n$ curl -X POST http://127.0.0.1:8000/api/v1/service \\\n    -d '{\"service\":\"zipkin\"}' \\\n    -H 'x-api-key: ~api~key~here~'\n```\n\n- Memcached.\n\n```zsh\n$ curl -X POST http://127.0.0.1:8000/api/v1/service \\\n    -d '{\"service\":\"memcached\"}' \\\n    -H 'x-api-key: ~api~key~here~'\n```\n\n- Mailhog.\n\n```zsh\n$ curl -X POST http://127.0.0.1:8000/api/v1/service \\\n    -d '{\"service\":\"mailhog\"}' \\\n    -H 'x-api-key: ~api~key~here~'\n```\n\n- Jaeger.\n\n```zsh\n$ curl -X POST http://127.0.0.1:8000/api/v1/service \\\n    -d '{\"service\":\"jaeger\"}' \\\n    -H 'x-api-key: ~api~key~here~'\n```\n\n- RabbitMQ.\n\n```zsh\n$ curl -X POST http://127.0.0.1:8000/api/v1/service \\\n    -d '{\"service\":\"rabbitmq\"}' \\\n    -H 'x-api-key: ~api~key~here~'\n```\n\n- Consul.\n\n```zsh\n$ curl -X POST http://127.0.0.1:8000/api/v1/service \\\n    -d '{\"service\":\"consul\"}' \\\n    -H 'x-api-key: ~api~key~here~'\n```\n\n- Vault.\n\n```zsh\n$ curl -X POST http://127.0.0.1:8000/api/v1/service \\\n    -d '{\"service\":\"vault\",\"configs\": {\"token\": \"peanut\"}}' \\\n    -H 'x-api-key: ~api~key~here~'\n```\n\n- Cassandra.\n\n```zsh\n$ curl -X POST http://127.0.0.1:8000/api/v1/service \\\n    -d '{\"service\":\"cassandra\"}' \\\n    -H 'x-api-key: ~api~key~here~'\n```\n\n- Minio.\n\n```zsh\n$ curl -X POST http://127.0.0.1:8000/api/v1/service \\\n    -d '{\"service\":\"minio\",\"configs\": {\"username\": \"admin12345678\", \"password\": \"admin12345678\"}}' \\\n    -H 'x-api-key: ~api~key~here~'\n```\n\n- Docker Registry.\n\n```zsh\n$ curl -X POST http://127.0.0.1:8000/api/v1/service \\\n    -d '{\"service\":\"registry\"}' \\\n    -H 'x-api-key: ~api~key~here~'\n```\n\n- Ghost.\n\n```zsh\n$ curl -X POST http://127.0.0.1:8000/api/v1/service \\\n    -d '{\"service\":\"ghost\"}' \\\n    -H 'x-api-key: ~api~key~here~'\n```\n\n- Httpbin.\n\n```zsh\n$ curl -X POST http://127.0.0.1:8000/api/v1/service \\\n    -d '{\"service\":\"httpbin\"}' \\\n    -H 'x-api-key: ~api~key~here~'\n```\n\n- Nagios.\n\n```zsh\n$ curl -X POST http://127.0.0.1:8000/api/v1/service \\\n    -d '{\"service\":\"nagios\"}' \\\n    -H 'x-api-key: ~api~key~here~'\n```\n\n- Etherpad.\n\n```zsh\n$ curl -X POST http://127.0.0.1:8000/api/v1/service \\\n    -d '{\"service\":\"etherpad\"}' \\\n    -H 'x-api-key: ~api~key~here~'\n```\n\nTo create a temporary service, you will need to add extra parameter while creating it.\n\n```zsh\n# It will be deleted after 30 seconds\n$ curl -X POST http://127.0.0.1:8000/api/v1/service \\\n    -d '{\"service\":\"etcd\", \"deleteAfter\": \"30sec\"}' \\\n    -H 'x-api-key: ~api~key~here~'\n\n# It will be deleted after 20 minutes\n$ curl -X POST http://127.0.0.1:8000/api/v1/service \\\n    -d '{\"service\":\"etcd\", \"deleteAfter\": \"20min\"}' \\\n    -H 'x-api-key: ~api~key~here~'\n\n# It will be deleted after 1 hour\n$ curl -X POST http://127.0.0.1:8000/api/v1/service \\\n    -d '{\"service\":\"etcd\", \"deleteAfter\": \"1hours\"}' \\\n    -H 'x-api-key: ~api~key~here~'\n\n# It will be deleted after 3 days\n$ curl -X POST http://127.0.0.1:8000/api/v1/service \\\n    -d '{\"service\":\"etcd\", \"deleteAfter\": \"3days\"}' \\\n    -H 'x-api-key: ~api~key~here~'\n```\n\nTo list all services running on a single or multi nodes.\n\n```zsh\n$ curl -X GET http://127.0.0.1:8000/api/v1/service \\\n    -H 'x-api-key: ~api~key~here~'\n```\n\nTo delete a service.\n\n```zsh\n$ curl -X DELETE http://127.0.0.1:8000/api/v1/service/:serviceId \\\n    -H 'x-api-key: ~api~key~here~'\n```\n\nTo get async job status like a deployment status.\n\n```zsh\n$ curl -X DELETE http://127.0.0.1:8000/api/v1/job/:serviceId/:jobId \\\n    -H 'x-api-key: ~api~key~here~'\n```\n\nTo get service versions.\n\n```zsh\n$ curl -X GET http://127.0.0.1:8000/api/v1/tag/$serviceType/$fromCacheStatus \\\n    -H 'x-api-key: ~api~key~here~'\n\n$ curl -X GET http://127.0.0.1:8000/api/v1/tag/mysql/true \\\n    -H 'x-api-key: ~api~key~here~'\n```\n\n\n## Versioning\n\nFor transparency into our release cycle and in striving to maintain backward compatibility, Peanut is maintained under the [Semantic Versioning guidelines](https://semver.org/) and release process is predictable and business-friendly.\n\nSee the [Releases section of our GitHub project](https://github.com/clivern/peanut/releases) for changelogs for each release version of Peanut. It contains summaries of the most noteworthy changes made in each release.\n\n\n## Bug tracker\n\nIf you have any suggestions, bug reports, or annoyances please report them to our issue tracker at https://github.com/clivern/peanut/issues\n\n\n## Security Issues\n\nIf you discover a security vulnerability within Peanut, please send an email to [hello@clivern.com](mailto:hello@clivern.com)\n\n\n## Contributing\n\nWe are an open source, community-driven project so please feel free to join us. see the [contributing guidelines](CONTRIBUTING.md) for more details.\n\n\n## License\n\n© 2021, Clivern. Released under [MIT License](https://opensource.org/licenses/mit-license.php).\n\n**Peanut** is authored and maintained by [@clivern](http://github.com/clivern).\n","funding_links":["clivern.com/sponsor/"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclivern%2Fpeanut","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fclivern%2Fpeanut","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclivern%2Fpeanut/lists"}