Documentation

Initialize Mach5 Search in AKS

This guide outlines the steps to initialize Mach5 Search after completing the Kubernetes helm charts 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 AKS cluster.

Connect to the cluster

Run the following command to connect to the cluster

az account set --subscription <subscription-id>

az aks get-credentials --resource-group <resource-group> --name <cluster-name> 
--overwrite-existing

Check Pod Status

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

kubectl get pods -n mach5 -w

Find the Internal IP

Retrieve the internal IP address of the Nginx Load Balancer, which can be accessed from a host from the same virtual network as the cluster. Alternatively, you can port-forward the nginx port to access Mach5 Search UI, which is detailed in the next section.

kubectl get svc m5s-nginx -n mach5

Port forward the Mach5 Search service port as follows:

kubectl port-forward -n mach5 svc/m5s-nginx 8888:80

Mach5 Search will be accessible at http://localhost:8888 post this.

Access the Mach5 Data Explorer

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

http://internal-ip:80/
or
http://localhost:8888/

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

Step 1: Configure a New ABS Store (Azure Blob Storage Store)

  1. Open the Mach5 Data Explorer at http://localhost:8888/.
  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 Azure Blob Storage (ABS) store:
    • Name: Enter a name for the ABS store.
    • Store Type: Select Abs.
    • Bucket: Enter your ABS container (e.g., my-abs-container).
    • Prefix: Specify an optional folder prefix (e.g., store).
    • Account: Enter your Azure Blob Storage account name (e.g., mach5blobstorage).
  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://localhost:8888/warehouse/default/<warehouse-name>/dashboards/

Access OpenSearch-Compatible APIs

To interact with OpenSearch-compatible APIs, use:

http://localhost:8888/warehouse/default/<warehouse-name>/opensearch/

Your Mach5 Search deployment is now ready for use!