{"id":21994383,"url":"https://github.com/codelibs/opensearch-runner","last_synced_at":"2025-07-05T04:02:19.631Z","repository":{"id":57739170,"uuid":"422197169","full_name":"codelibs/opensearch-runner","owner":"codelibs","description":null,"archived":false,"fork":false,"pushed_at":"2025-04-13T09:15:44.000Z","size":97,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-13T10:24:54.946Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/codelibs.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,"zenodo":null}},"created_at":"2021-10-28T12:34:01.000Z","updated_at":"2025-04-13T09:15:48.000Z","dependencies_parsed_at":"2024-06-26T01:40:57.160Z","dependency_job_id":"c235186f-ceef-4f35-9313-86ebc8a6dcda","html_url":"https://github.com/codelibs/opensearch-runner","commit_stats":null,"previous_names":[],"tags_count":39,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codelibs%2Fopensearch-runner","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codelibs%2Fopensearch-runner/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codelibs%2Fopensearch-runner/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codelibs%2Fopensearch-runner/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codelibs","download_url":"https://codeload.github.com/codelibs/opensearch-runner/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251748001,"owners_count":21637408,"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":[],"created_at":"2024-11-29T21:08:43.174Z","updated_at":"2025-04-30T16:48:07.993Z","avatar_url":"https://github.com/codelibs.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"OpenSearch Runner\n[![Java CI with Maven](https://github.com/codelibs/opensearch-runner/actions/workflows/maven.yml/badge.svg)](https://github.com/codelibs/opensearch-runner/actions/workflows/maven.yml)\n============\n\nThis project runs OpenSearch cluster on one JVM instance for your development/testing easily.\nYou can use OpenSearch Runner as Embedded OpenSearch in your application.\n\n## Version\n\n[Versions in Maven Repository](https://repo1.maven.org/maven2/org/codelibs/opensearch/opensearch-runner/)\n\n## Run on Your Application\n\nPut opensearch-runner if using Maven:\n\n    \u003cdependency\u003e\n        \u003cgroupId\u003eorg.codelibs.opensearch\u003c/groupId\u003e\n        \u003cartifactId\u003eopensearch-runner\u003c/artifactId\u003e\n        \u003cversion\u003ex.x.x.0\u003c/version\u003e\n    \u003c/dependency\u003e\n\n### Start Runner\n\n    import static org.codelibs.opensearch.runner.OpenSearchRunner.newConfigs;\n    ...\n    // create runner instance\n    OpenSearchRunner runner = new OpenSearchRunner();\n    // create ES nodes\n    runner.onBuild(new OpenSearchRunner.Builder() {\n        @Override\n        public void build(final int number, final Builder settingsBuilder) {\n            // put opensearch settings\n            // settingsBuilder.put(\"index.number_of_replicas\", 0);\n        }\n    }).build(newConfigs());\n\nbuild(Configs) method configures/starts Clsuter Runner.\n\n### Stop Runner\n\n    // close runner\n    runner.close();\n\n### Clean up \n\n    // delete all files(config and index)\n    runner.clean();\n\n## Run on JUnit\n\nPut opensearch-runner as test scope:\n\n    \u003cdependency\u003e\n        \u003cgroupId\u003eorg.codelibs.opensearch\u003c/groupId\u003e\n        \u003cartifactId\u003eopensearch-runner\u003c/artifactId\u003e\n        \u003cversion\u003ex.x.x.0\u003c/version\u003e\n        \u003cscope\u003etest\u003c/scope\u003e\n    \u003c/dependency\u003e\n\nand see [OpenSearchRunnerTest](https://github.com/codelibs/opensearch-runner/blob/master/src/test/java/org/codelibs/opensearch/runner/OpenSearchRunnerTest.java \"OpenSearchRunnerTest\").\n\n## Run as Standalone\n\n### Install Maven\n\nDownload and install Maven 3 from http://maven.apache.org/.\n\n### Clone This Project\n\n    git clone https://github.com/codelibs/opensearch-runner.git\n\n### Build This Project\n\n    mvn compile\n\n## Run/Stop OpenSearch Cluster\n\n### Run Cluster\n\nRun:\n\n    mvn exec:java \n\nThe default cluster has 3 nodes and the root directory for OpenSearch is es\\_home.\nNodes use 9201-9203 port for HTTP and 9301-9303 port for Transport.\nIf you want to change the number of node, Run:\n\n    mvn exec:java -Dexec.args=\"-basePath es_home -numOfNode 4\"\n\n### Stop Cluster\n\nType Ctrl-c or kill the process.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodelibs%2Fopensearch-runner","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodelibs%2Fopensearch-runner","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodelibs%2Fopensearch-runner/lists"}