Documentation

Initialize Mach5 Search in GKE

This guide outlines the steps to initialize Mach5 Search after completing the Kubernetes deployment.

Prerequisites

  • The namespace for the Mach5 Search deployment is assumed to be mach5.
  • Ensure you have kubectl installed and configured to interact with your GKE cluster.

Check Pod Status

Run the following command to verify the state of the Mach5 Search pods:

kubectl get pods -n mach5 -w

Find the External IP

Retrieve the external IP address of the Nginx Load Balancer:

kubectl get svc m5s-nginx -n mach5

Access the Mach5 Data Explorer

Once you have the external IP, access the Mach5 Data Explorer UI by navigating to:

http://<external-ip>:80/

This interface will be used to configure stores and store routes.

Step 1: Configure a New GCS Store

  1. Open the Mach5 Data Explorer at http://<external-ip>:80/.
  2. From the Home page, click Stores in the bottom left pane.
  3. Click the + button to add a new store.
  4. Configure the new Google Cloud Storage (GCS) store:
    • Name: Enter a name for the GCS store.
    • Store Type: Select Gcs.
    • Bucket: Enter your GCS bucket name (e.g., my-gcs-bucket).
    • Prefix: Specify an optional folder prefix (e.g., store).
  5. Click Save to create the store.
  6. Click on the created store to view its details and note the Store ID for the next step.

Step 2: Create a Store Route

  1. From the Home page, click Store Routes in the bottom left pane.
  2. Click the + button to add a new store route.
  3. Configure the store route:
    • Pattern: Use a regex pattern to match index names (e.g., .* to match all indices when using a single store).
    • Store Id: Enter the Store ID noted from the previous step.
    • Priority: Set the priority (default is 10).
  4. Click Save to create the store route.

Step 3: Create a Warehouse

  1. From the Home page, click Warehouses in the left pane.
  2. Click the + button to add a new warehouse.
  3. Enter a Name for the warehouse.
  4. Click Save to create the warehouse.

Verify Initialization

Mach5 should now be successfully initialized. It may take 1-2 minutes for the system to become accessible.

Access Mach5 Search Dashboards

To view the created warehouse, navigate to:

http://<external-ip>:80/warehouse/default/<warehouse-name>/dashboards/

Access OpenSearch-Compatible APIs

To interact with OpenSearch-compatible APIs, use:

http://<external-ip>:80/warehouse/default/<warehouse-name>/opensearch/

Your Mach5 Search deployment is now ready for use!