opensearch-machine
This is a repo for testing and learning Opensearch running under Multipass.
Science Score: 52.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Academic email domains
-
✓Institutional organization owner
Organization caltechlibrary has institutional domain (www.library.caltech.edu) -
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (15.4%) to scientific vocabulary
Keywords
Repository
This is a repo for testing and learning Opensearch running under Multipass.
Basic Info
- Host: GitHub
- Owner: caltechlibrary
- License: other
- Language: HTML
- Default Branch: main
- Homepage: https://caltechlibrary.github.io/opensearch-machine
- Size: 1.09 MB
Statistics
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 0
- Releases: 2
Topics
Metadata Files
README.md
OpenSearch Machine
This repository contains instructions for setting up a Multipass managed virtual machine for learning and experimentation with OpenSearch v2.5.0. Multipass runs on macOS, Windows and Linux. It provides an Ubuntu Linux machine. OpenSearch while written in Java is tailored to run under a Linux environment. OpenSearch is a full text search engine based on a forked implementation of Elasticsearch full text search engine by Amazon. OpenSearch is the search engine used in Invenio-RDM.
<!-- 
-->
Table of contents
- Introduction
- Quick start
- Usage
- Known issues and limitations
- Getting help
- Contributing
- License
- Acknowledgments
Introduction
This repository is focused on creating a Multipass virtual machine for learning and exploring OpenSearch v2.5.0[^1]. It includes brief instructions for installation of OpenSearch and elasticdump running under a Multipass managed virtual machine. It includes documentation describing how to create an index, add and remove documents as well as backing up and restoring the index in the virtual machine.
[^1]: v2.5.0 was chosen as it is the closest version to that used in Invenio-RDM v11 that I could get to install and work under Ubuntu 22.04 LTS.
Quick start
Use the opensearch-init.yaml file to create a Multipass managed virtual machine. Then run the numbered scripts found in /usr/local/sbin to complete the installation process.
Creating (Launching) the virtual machine with Multipass
sh
bash opensearch-machine.bash
Working in your virtual machine
sh
multipass shell opensearch-machine
Setting finishing the search
While in the shell of your virtual machine (you are the "ubuntu" user) run the following scripts.
sh
01-setup-scripts.bash
07-add-opensearch.bash
sudo reboot
At this point you should have OpenSearch and OpenSearch Dashboard running in your virtual machine, ready to explore.
Stopping and removing your virtual machine
sh
multipass stop opensearch-machine
multipass delete opensearch-machine
multipass purge
Usage
Once you have your virtual machine up and running with OpenSearch and the OpenSearch dashboard you should be able to access it from your host machine using SSH port mapping to interact with the OpenSearch REST API.
You can find out more about using Multipass to manage virtual machines at https://multipass.run. You can find out more about OpenSearch and OpenSearch Dashboard at https://opensearch.org/docs/latest/about/
A presentation is included describing the basics of OpenSearch.
Known issues and limitations
These instructions focus on running OpenSearch for the purpose of learning and experimentation. It does not cover setup and configuration of running OpenSearch in a production environment. There are many additional considerations in that setting. Consult the OpenSearch website and your system administrator(s) to explore those issues.
Getting help
If you can questions, problems or suggestions regarding this repository software and documentation please file a GitHub issue.
License
Software produced by the Caltech Library is Copyright © 2024 California Institute of Technology. This software is freely distributed under a modified BSD 3-clause license. Please see the LICENSE file for more information.
Acknowledgments
I'd like to thank the Caltech Library Digital Library development group for their inspiration and support in this project.
This work was funded by the California Institute of Technology Library.
Owner
- Name: Caltech Library
- Login: caltechlibrary
- Kind: organization
- Email: helpdesk@library.caltech.edu
- Location: Pasadena, CA 91125
- Website: https://www.library.caltech.edu/
- Repositories: 84
- Profile: https://github.com/caltechlibrary
We manage the physical and digital holdings of the California Institute of Technology, provide services and training, and develop open-source software.
Citation (CITATION.cff)
cff-version: 1.2.0
message: "If you use this software, please cite it as below."
type: software
title: "Opensearch Machine"
abstract: "A Multipass virtual machine setup for learning and exploring
OpenSearch"
authors:
- family-names: Doiel
given-names: R. S.
orcid: "https://orcid.org/0000-0003-0900-6903"
repository-code: "https://github.com/caltechlibrary/opensearch-machine"
version: 0.0.2
license-url: "https://github.com/caltechlibrary/opensearch-machine/blob/main/LICENSE"
keywords: [ "OpenSearch", "search engine", "virtual machine" ]
CodeMeta (codemeta.json)
{
"@context": "https://doi.org/10.5063/schema/codemeta-2.0",
"@type": "SoftwareSourceCode",
"name": "Opensearch Machine",
"identifier": "opensearch-machine",
"description": "A Multipass virtual machine setup for learning and exploring OpenSearch",
"version": "0.0.2",
"dateCreated": "2024-03-07",
"dateModified": "2024-03-12",
"dateReleased": "2024-03-13",
"author": [
{
"@id": "https://orcid.org/0000-0003-0900-6903",
"@type": "Person",
"affiliation": {
"@type": "Organization",
"name": "Caltech Library"
},
"familyName": "Doiel",
"givenName": "R. S.",
"email": "rsdoiel@caltech.edu"
}
],
"funder": [
{
"@id": "https://doi.org/10.13039/100006961",
"@type": "Organization",
"name": "Caltech Library"
}
],
"copyrightHolder": [
{
"@id": "https://ror.org/05dxps055",
"@type": "Organization",
"name": "California Institute of Technology"
}
],
"copyrightYear": 2024,
"license": "https://github.com/caltechlibrary/opensearch-machine/blob/main/LICENSE",
"isAccessibleForFree": true,
"url": "https://github.com/caltechlibrary/opensearch-machine",
"codeRepository": "https://github.com/caltechlibrary/opensearch-machine",
"readme": "https://github.com/caltechlibrary/opensearch-machine/blob/main/README.md",
"releaseNotes": "https://github.com/caltechlibrary/opensearch-machine/blob/main/CHANGES.md",
"issueTracker": "https://github.com/caltechlibrary/opensearch-machine/issues",
"downloadUrl": "https://github.com/caltechlibrary/opensearch-machine/archive/main.zip",
"keywords": [
"OpenSearch",
"search engine",
"virtual machine"
],
"developmentStatus": "wip",
"softwareRequirements": [
"GNU Make >=3.8",
"Pandoc >= 3.1",
"PageFind >= 1.0.4",
"Bash >= 3.2",
"Python >= 3",
"Multipass >= 1.13",
"jq >= 1.7"
]
}GitHub Events
Total
Last Year
Issues and Pull Requests
Last synced: 11 months ago
All Time
- Total issues: 0
- Total pull requests: 1
- Average time to close issues: N/A
- Average time to close pull requests: 2 days
- Total issue authors: 0
- Total pull request authors: 1
- Average comments per issue: 0
- Average comments per pull request: 0.0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
- mhucka (2)