Authentication basics in Elasticsearch - Mini Project: Build & Apply

Authentication basics

📖 Scenario: You are setting up a simple Elasticsearch client connection that requires authentication to access the cluster. This is common when your Elasticsearch server is secured and needs a username and password to allow queries.

🎯 Goal: Build a basic Elasticsearch client configuration that includes authentication details and perform a simple request to verify the connection.

📋 What You'll Learn

Create a dictionary called es_config with the Elasticsearch host URL

Add a http_auth key to es_config with a tuple of username and password

Create an Elasticsearch client instance using Elasticsearch(**es_config)

Use the client to perform a ping() request to check if the server is reachable

Print the result of the ping() request

💡 Why This Matters

🌍 Real World

Many Elasticsearch clusters require authentication to protect data. Setting up the client with correct credentials is essential to access and manage the data securely.

💼 Career

Knowing how to configure Elasticsearch clients with authentication is important for roles like backend developers, data engineers, and DevOps engineers who work with secured Elasticsearch clusters.

1

Set up Elasticsearch connection details

Create a dictionary called es_config with a key hosts set to the list containing the string 'http://localhost:9200'.

Elasticsearch

# Create the es_config dictionary with hosts
# Your code here

Need a hint?

Use a dictionary with key 'hosts' and value as a list with the URL string.

2

Add authentication credentials

Add a key http_auth to the existing es_config dictionary with the tuple ('elastic', 'changeme') as its value.

Elasticsearch

es_config = {'hosts': ['http://localhost:9200']}
# Add http_auth with username 'elastic' and password 'changeme'
# Your code here

Need a hint?

Use the key 'http_auth' with a tuple of username and password.

3

Create Elasticsearch client

Import Elasticsearch from elasticsearch and create a variable called client by calling Elasticsearch(**es_config).

Elasticsearch

es_config = {'hosts': ['http://localhost:9200'], 'http_auth': ('elastic', 'changeme')}
# Import Elasticsearch and create client using es_config
# Your code here

Need a hint?

Use from elasticsearch import Elasticsearch and then create the client.

4

Check connection and print result

Use the client variable to call the ping() method and print the result.

Elasticsearch

from elasticsearch import Elasticsearch

es_config = {'hosts': ['http://localhost:9200'], 'http_auth': ('elastic', 'changeme')}
client = Elasticsearch(**es_config)
# Call ping() on client and print the result
# Your code here

Need a hint?

The ping() method returns True if the server is reachable, otherwise False.