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¹. 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.

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

bash opensearch-machine.bash

Working in your virtual machine

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.

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

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.