{"id":21217077,"url":"https://github.com/ansible-collections/community.elastic","last_synced_at":"2025-08-04T14:35:06.384Z","repository":{"id":40445537,"uuid":"327953449","full_name":"ansible-collections/community.elastic","owner":"ansible-collections","description":null,"archived":false,"fork":false,"pushed_at":"2025-06-28T12:20:00.000Z","size":201,"stargazers_count":30,"open_issues_count":4,"forks_count":13,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-06-28T12:24:59.482Z","etag":null,"topics":["ansible-collection","database","elastic","elasticsearch","nosql"],"latest_commit_sha":null,"homepage":"http://galaxy.ansible.com/community/elastic","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ansible-collections.png","metadata":{"files":{"readme":"README.md","changelog":"changelogs/changelog.yaml","contributing":null,"funding":null,"license":"COPYING","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-01-08T16:22:19.000Z","updated_at":"2025-06-28T12:20:03.000Z","dependencies_parsed_at":"2022-07-19T06:32:04.000Z","dependency_job_id":"f08812f3-e9f4-4867-a6d1-e4322e177d2d","html_url":"https://github.com/ansible-collections/community.elastic","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/ansible-collections/community.elastic","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ansible-collections%2Fcommunity.elastic","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ansible-collections%2Fcommunity.elastic/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ansible-collections%2Fcommunity.elastic/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ansible-collections%2Fcommunity.elastic/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ansible-collections","download_url":"https://codeload.github.com/ansible-collections/community.elastic/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ansible-collections%2Fcommunity.elastic/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264573347,"owners_count":23630469,"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":["ansible-collection","database","elastic","elasticsearch","nosql"],"created_at":"2024-11-20T21:56:57.133Z","updated_at":"2025-07-10T11:33:14.586Z","avatar_url":"https://github.com/ansible-collections.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# community.elastic\n\n![CI](https://github.com/ansible-collections/community.elastic/workflows/CI/badge.svg)\n![Build \u0026 Publish Collection](https://github.com/ansible-collections/community.elastic/workflows/Build%20\u0026%20Publish%20Collection/badge.svg)\n\nThis Ansible collection provides modules to work with Elasticsearch instances and clusters.\n\n## Installing the official release\n\n```bash\nansible-galaxy collection install community.elastic\n```\n\n# Installing the latest development version\n\nBoth Elasticsearch server version 7 and 8 are supported. But the version\nof elasticesearch Python library must be aligned with Elasticsearch server.\n\n```bash\npip install elasticsearch==7.*  # To connect to Elasticsearch 7.x\npip install elasticsearch==8.*  # To connect to Elasticsearch 8.x\n```\n\n```bash\nansible-galaxy collection install https://github.com/ansible-collections/community.elastic/releases/download/latest/community-elastic-latest.tar.gz\n```\n\n## Collection Contents\n\nThese modules are tested on Debian and RHEL based distributions.\n\n### Modules\n\n- `elastic_bulk`: Perform actions with documents using the Bulk API.\n- `elastic_cluster_health`: Validate cluster health.\n- `elastic_cluster_settings`: Manage Elastic Search Cluster Settings.\n- `elastic_index`:  Manage Elasticsearch indexes.\n- `elastic_index_info`: Returns info about Elasticsearch indexes.\n- `elastic_index_lifecycle`: Manage Elasticsearch Index Lifecyles.\n- `elastic_keystore`: Manage entries in the Elasticsearch keystore.\n- `elastic_pipeline`: Manage Elasticsearch Pipelines.\n- `elastic_reindex`: Copies documents from a source to a destination.\n- `elastic_role`: Manage Elasticsearch user roles.\n- `elastic_rollup`: Manage Elasticsearch Rollup Jobs.\n- `elastic_snapshot`: Manage Elasticsearch Snapshots.\n- `elastic_snapshot_repository`: Manage Elasticsearch Snapshot Repositories.\n- `elastic_transform`: Manage Elasticsearch Transform Jobs.\n- `elastic_user`: Manage Elasticsearch users.\n\n## Running the integration tests\n\n* Requirements\n  * [Python 3.5+](https://www.python.org/)\n  * [pip](https://pypi.org/project/pip/)\n  * [virtualenv](https://virtualenv.pypa.io/en/latest/) or [pipenv](https://pypi.org/project/pipenv/) if you prefer.\n  * [git](https://git-scm.com/)\n  * [docker](https://www.docker.com/)\n  * [docker-compose](https://docs.docker.com/compose/)\n\n* Useful Links\n  * [Pip \u0026 Virtual Environments](https://docs.python-guide.org/dev/virtualenvs/)\n  * [Ansible Integration Tests](https://docs.ansible.com/ansible/latest/dev_guide/testing_integration.html)\n\nThe ansible-test tool requires a specific directory hierarchy to function correctly so please follow carefully. Many of these test make use of docker-compose to launch Elastic Clusters. These tests should be run in a isolated Linux environment.\n\n* Create the required directory structure. N-B. The ansible-test tool requires this format.\n\n```bash\nmkdir -p git/ansible_collections/community\ncd git/ansible_collections/community\n```\n\n* Clone the required projects.\n\n```bash\ngit clone  https://github.com/ansible-collections/community.elastic.git ./elastic\ngit clone  https://github.com/ansible-collections/community.general.git ./general\n```\n\n* Create and activate a virtual environment.\n\n```bash\nvirtualenv venv\nsource venv/bin/activate\n```\n\n* Change to the project directory.\n\n```bash\ncd elastic\n```\n\n* Install the devel branch of ansible-base.\n\n```bash\npip install https://github.com/ansible/ansible/archive/devel.tar.gz --disable-pip-version-check\n```\n\nPlease note that most of these integration tests are intended to run directly in GitHUb Actions and running them locally may make changes to the executing computer. You can use the docker flag to avoid that but many of these tests won't work in those conditions.\n\n* Set elasticsearch and kibana version to integration_config.yml\nPlease set elasticsearch_version and kibana_version to tests/integration/integration_config.yml.\nRefference: tests/integration/integration_config.yml.template\n\n* Run integration tests for the elastic_user module.\n\n```bash\nansible-test integration -v --color yes --python 3.6 elastic_user\n```\n\n* Run integration tests for the elastic_cluster_health module.\n\n```bash\nansible-test integration -v --color yes --python 3.6 elastic_cluster_health\n```\n\n* Run tests for everything in the collection.\n\n```bash\nansible-test integration -v --color yes --python 3.6\n```\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fansible-collections%2Fcommunity.elastic","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fansible-collections%2Fcommunity.elastic","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fansible-collections%2Fcommunity.elastic/lists"}