Prerequisites

  1. You have an active Elastic Cloud account
  2. You have a deployment with a searchable index

This how to describes the three necessary processes to connect Quepid to your Elastic Cloud deployments:

  1. Configure Elastic Cloud deployment to accept browser requests from Quepid
  2. Create an API Key in Elastic Cloud
  3. Connect Quepid to Elastic Cloud with the appropriate settings

    Configure your Elastic Cloud deployment to accept browser requests from Quepid

  4. Log into your Elastic Cloud account at https://cloud.elastic.co/home.

  5. Select Manage next to the Deployment you want to connect Quepid to. select_EC_deployment.png

  6. Under your deployment name select Edit. edit_EC_deployment.png

  7. Select Manage user settings and extensions. manage_EC_deployment_settings.png

  8. Enable and configure CORS with the following settings when connecting to the public Quepid service running at https://app.quepid.com. Change allow-origin accordingly when running Quepid on localhost or any other host.

    http.cors:
    enabled: true
    allow-origin: /https?:\/\/app\.quepid\.com/
    allow-credentials: true
    allow-headers: "X-Requested-With, Content-Type, Content-Length, if-modified-since, Authorization" 
    
    1. Select Back and scroll down to the bottom of the page to confirm and save the changes by selecting Save.
    2. This triggers a restart of your deployment. Wait until the restart finishes. ## Create an API Key in Elastic Cloud To authenticate requests to the Elastic Cloud deployment follow these steps:
  9. If not logged in, log into your Elastic Cloud account at https://cloud.elastic.co/home.

  10. Select Open next to the Deployment you want to connect Quepid to. open_EC_deployment.png

  11. Select the + New button. create_EC_deployment_API_key.png

  12. Choose a descriptive name (for example Quepid) and choose the settings appropriate to your desired security guidelines or requirements.

  13. Create the API Key by selecting Create API Key.

  14. Your created API should look similar to the following JSON snippet:

    { 
    "id": "zbeFaZQBMjrfbP-YfIZh",
    "name": "Quepid",
    "expiration": 1737023543405,
    "api_key": "4dMPumSqTdiTzREUXYQDTA",
    "encoded": "emJlRmFaUUJNanJmYlAtWWZJWmg6NGRNUHVtU3FUZGlUelJFVVhZUURUQQ==",
    "beats_logstash_format": "zbeFaZQBMjrfbP-YfIZh:4dMPumSqTdiTzREUXYQDTA"
    }
    
  15. Store your API key in a safe place, for example your company password safe with appropriate access settings.

    Connect Quepid to Elastic Cloud with the appropriate settings

    We now create a new case and connect it to the deployment with the created API Key.

  16. Log into Quepid.

  17. Create by selecting Relevancy Cases and + Create a case.

  18. Name your case, for example TMBD on Elastic Cloud.

  19. Select Create a new Search Endpoint with the following settings:

    1. Choose Elasticsearch and enter your Elasticsearch endpoint including the index name and _search. (Note: You find your Elasticsearch endpoint when logging into your Elastic Cloud and selecting Open for the deployment you want to connect to.)
    2. Select Advanced and choose API Key in the dropdown for Custom Headers.
    3. Substitute XXX in the generated JSON for the custom header by the API Key you generated. You find the API Key under encoded. search_endpoint_configuration.png
  20. Click ping it below the endpoint input field.

  21. A successful configuration is confirmed with the output Quepid can search this! Hit 'Continue' to keep working through setup. Revisit the configuration to make sure you have all settings correct if you don't receive the success message.

  22. Continue with the case setup and set the display fields and add the queries you want to have in your case.

  23. Done!