{"id":19839350,"url":"https://github.com/redislabs/rmadm","last_synced_at":"2026-02-08T17:31:34.267Z","repository":{"id":80860296,"uuid":"99712267","full_name":"RedisLabs/rmadm","owner":"RedisLabs","description":null,"archived":false,"fork":false,"pushed_at":"2017-11-14T15:15:12.000Z","size":22,"stargazers_count":2,"open_issues_count":1,"forks_count":2,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-06-16T13:04:59.400Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/RedisLabs.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-08-08T16:12:53.000Z","updated_at":"2018-06-22T09:37:46.000Z","dependencies_parsed_at":null,"dependency_job_id":"583e3349-e899-4d2d-9cc4-62fb8c0f4891","html_url":"https://github.com/RedisLabs/rmadm","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/RedisLabs/rmadm","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RedisLabs%2Frmadm","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RedisLabs%2Frmadm/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RedisLabs%2Frmadm/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RedisLabs%2Frmadm/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RedisLabs","download_url":"https://codeload.github.com/RedisLabs/rmadm/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RedisLabs%2Frmadm/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29238279,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-08T14:18:14.570Z","status":"ssl_error","status_checked_at":"2026-02-08T14:18:14.071Z","response_time":57,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":[],"created_at":"2024-11-12T12:21:57.543Z","updated_at":"2026-02-08T17:31:34.252Z","avatar_url":"https://github.com/RedisLabs.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# rmadm\n\nRedis Labs Enterprise Module Management Utility\n\n# About\n\nThis tool allows you to use modules in the Redis Labs Enterprise 5.0 cluster. It can install modules, create databases, and upgrade module on databases.\n\n# Installing rmadm\n\nAssuming pip is installed on the machine (if not, it can be installed by `apt-get install python-pip` on Ubuntu)\n\n```sh\npip install git+https://github.com/RedisLabs/rmadm@master\n```\n\n# Note on configuration and credentials\n\nYou need to provide the commands with Redis Pack (Redis Labs Enterprise Cluster) login credentials. \nYou can provide them with command-line arguments or environment variables. If they are not configured, the user \nis prompted to enter them.\n\n## Configuring environment variables\n\nModify the values according to your cluster's credentials:\n\n```sh\n$ export RL_USER=\"myuser@domain.com\"\n$ export RL_PASS=\"mypassword\"\n\n# Optional - configure the cluster host if not running locally.\n# Not required if you are running rmadm on the cluster's master host.\n$ export RL_HOST=\"https://127.0.0.1:9443\"\n```\n\n---\n\n# Quick Start: Creating a Database With a Module\n\nThe main command is `rmadm cluster create_db {module} [{version}]`:\n\nExample: creating a database with the latest version of rebloom.\n\n```sh\n$ rmadm cluster create_db rebloom\nDatabase Name [mydb]: rebloom1231\nNumber of Redis Shards [5]:\nDatabase Memory Limit (in GB) [4]: 2\nEnable Replication [y/N]:\nCustom Module Args []:\n  \n  File rebloom.Linux-x86_64.latest.zip does not exist, downloading it...\n  Downloading https://s3.amazonaws.com/redismodules/rebloom/rebloom.Linux-x86_64.latest.zip...\n  Deploying module to cluster...\n  Module UID: 1e20a0697da9ba95d281f8bf3179bc4c\n  Creating db...\n\nOK\n```\n\n# Command Reference\n\n## rmadm download MODULE [VERSION]\n\nDownload a module from s3 storage (where all module builds are stored) to the local machine. \n\n### Example:\n\n```sh\nrmadm download rscoordinator latest\n```\n\n**VERSION** can be omitted if you need the latest version. \n\n-------\n\n\n## rmadm cluster create_db [OPTIONS] MODULE\n\nCreate a new database with the given module. By default we download the latest version of the module if it does not exist on the current folder.\n\n### Options\n\n```\n  --version TEXT      Module Version\n  --module_args TEXT  Module Configuration Argument List\n  --db TEXT           Database Name\n  --shards INTEGER    Number of Redis Shards\n  --maxmemory TEXT    Database Memory Limit (in GB)\n  --replication       If set, replication is enabled\n  --file TEXT         Upload module from a local file\n  --help              Show this message and exit.\n```\n\n--------\n\n## rmadm cluster list_modules [MODULE]\n\nList available modules and versions, optionally filtering by specific module.\n\nExample:\n\n```\n$ rmadm cluster list_modules\n\n--------------------------------------------------------------------------------\n| Module          | Version         | UID\n--------------------------------------------------------------------------------\n| bf              | 2.0             | 1e20a0697da9ba95d281f8bf3179bc4c\n| ft              | 9000.0          | b6ab49e747cc4debf70dcc57d799d004\n| ft              | 2000.0          | c7f15d6fc15b2d5324d2a5e38f667032\n| ft              | 11.0            | ed43dbf2983b69163e6b87376ae4f1cf\n| ft              | 9001.0          | 6c4b3dba6df68e8a2a6b271a053128b3\n--------------------------------------------------------------------------------\n```\n\n##  rmadm cluster upgrade [OPTIONS] MODULE [VERSION]\n\nUpgrade a module on an existing BDB using a new module version\n\n### Options:\n\n```\n  --bdb INTEGER  BDB Id to upgrade the module on\n  --file TEXT    Upload module from a local file\n  --help         Show this message and exit.\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fredislabs%2Frmadm","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fredislabs%2Frmadm","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fredislabs%2Frmadm/lists"}