Giters

ThomasObenaus / terraform-aws-es-quickstart

Terraform script to setup AWS ES including SecurityGroup and JumpStation to access the cluster.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

AWS Elastic Search Configuration

The following text is many extracted from the AWS documentation and reduced to the most interesting parts.

Quick Info

  • Configured AWS ES domain name: tf-demo-es-vpc-tf

Network configuration - VPC

  • You control network access within your VPC using security.

Choose internet or VPC access. To enable VPC access, we will use private IP addresses from your VPC, which provides security by default. You control network access within your VPC using security groups.

Placing an Amazon ES domain within a VPC enables secure communication between Amazon ES and other services within the VPC without the need for an internet gateway, NAT device, or VPN connection.

You can optionally add an additional layer of security by applying a restrictive access policy. Internet endpoints are publicly accessible.

To support VPCs, Amazon ES places an endpoint into either one or two subnets of your VPC. If you enable zone awareness for your domain, Amazon ES places an endpoint into two subnets. If you don't enable zone awareness, Amazon ES places an endpoint into only one subnet.

Amazon ES assigns each ENI a private IP address from the IPv4 address range of your subnet.Amazon ES also places an elastic network interface (ENI** in the VPC for each of your data nodes.

The service also assigns a public DNS hostname. Because the IP addresses might change, you should resolve the domain endpoint periodically so that you can always access the correct data nodes. We recommend that you set the DNS resolution interval to one minute.  You can't launch your domain within a VPC that uses dedicated tenancy. You must use a VPC with tenancy set to Default. The Cluster health tab does not include shard information, and the Indices tab is not present at all.

To access the default installation of Kibana for a domain that resides within a VPC, users must have access to the VPC. This process varies by network configuration, but likely involves connecting:

If you try to access the endpoint in a web browser, however, you might find that the request times out. To perform even basic GET requests, your computer must be able to connect to the VPC. This connection often takes the form of an

  • internet gateway,
  • VPN server, or
  • proxy server. For details on the various forms it can take, see Scenarios and Examples in theAmazon VPC User Guide.

In addition to this connectivity requirement, VPCs let you manage access to the domain through security groups. For many use cases, this combination of security features is sufficient, and you might feel comfortable applying an open access policy to the domain. Operating with an open access policy does not mean that anyone on the internet can access the Amazon ES domain. Rather, it means that if a request reaches the Amazon ES domain and the associated security groups permit it, the domain accepts the request without further security checks. For an additional layer of security, we recommend using access policies that specify IAM users or roles. Applying these policies means that, for the domain to accept a request, the security groups must permit it and it must be signed with valid credentials. Because security groups already enforce IP-based access policies, you can't apply IP-based access policies to Amazon ES domains that reside within a VPC.

SETUP AWS ES VPC - AWS Console

  • VPC-ID needed
  • Reserve IPs The number of IP addresses that Amazon ES requires depends on the following:
  • Number of data nodes in your domain. (Master nodes are not included in the number.)
  • Whether you enable zone awareness. If you enable zone awareness, you need only half the number of IP addresses per subnet that you need if you don't enable zone awareness. When you create the domain, Amazon ES reserves the IP addresses. You can see the network interfaces and their associated IP addresses in the Network Interfaces section of the Amazon EC2 console. The Description column shows which Amazon ES domain the network interface is associated with. TIP: We recommend that you create dedicated subnets for the Amazon ES reserved IP addresses.

Amazon ES requires a service-linked role to access your VPC. Amazon ES automatically creates the role when you use the Amazon ES console to create a domain within a VPC - you must have permissions for the iam:CreateServiceLinkedRole action. After Amazon ES creates the role, you can view it (AWSServiceRoleForAmazonElasticsearchService) using the IAM console.

  • Access policy: template: „Do not require signing request with IAM credential“ You can use security groups to control which IP addresses can access the domain.

Slow logs are an Elasticsearch feature that Amazon ES exposes through Amazon CloudWatch Logs. These logs are useful for troubleshooting performance issues, but are disabled by default. Elasticsearch disables slow logs by default. After you enable the publishing of slow logs to CloudWatch, you still must specify logging thresholds for each Elasticsearch index.

  1. Under Analytics, choose Elasticsearch Service.
  2. In the navigation pane, under My domains, choose the domain that you want to update.
  3. On the Logs tab, choose Enable for the log that you want.
  4. Create a CloudWatch log group, or choose an existing one. NOTE: If you plan to enable search and index slow logs, we recommend publishing each to its own log group. This separation makes the logs easier to scan.
  5. Activate logging of ES: curl -XPUT elasticsearch_domain_endpoint/index/_settings --data '{"index.search.slowlog.threshold.query.warn": "5s","index.search.slowlog.threshold.query.info": "2s"}' -H 'Content-Type: application/json' NOTE: To test that slow logs are publishing successfully, consider starting with very low values to verify that logs appear in CloudWatch, and then increase the thresholds to more useful levels.
-> https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html

MONITORING

ACCESS KIBANA

  1. Configure Jump-Station:
    1. Instance in same subnet needed
    2. Extend SG of ES domain -> Explicitly open 443
    3. Connect SG of ES domain to Jump-Station
    4. Note: IAM-Role NOT needed
  2. SShuttle Configuration ~/.ssh/config
Host demoesvpc
  HostName <dns_name_of_the_jump_station>
  User ec2-user
  IdentitiesOnly yes
  IdentityFile <path_to_the_ssh_instance_key.pem>
  1. SSHuttle
    1. Examine subnet address to limit request forwarding.
    2. sshuttle --dns --pidfile=/tmp/sshuttle.pid --remote=demoesvpc <ip_range_to_forward_to_the_jump_station_recommended_only_VPC_range>
  2. Check:
    1. curl -k https://<aws_es_endpoint>
    2. curl -XGET https://<aws_es_endpoint>/_cluster/health

PUSHING DATA

Inside VPC - Connected to Jump-Station:

  • curl -XPUT https://<aws_es_endpoint>/tf-demo-es-vpc-tf/movie/1 -d '{"director": "Burton, Tim", "genre": ["Comedy","Sci-Fi"], "year": 1996, "actor": ["Jack Nicholson","Pierce Brosnan","Sarah Jessica Parker"], "title": "Mars Attacks!"}' -H 'Content-Type: application/json'

SETUP AWS ES public - AWS Console

If you select public access, you should secure your domain with an access policy that only allows specific users or IP addresses to access the domain.

TERRAFORM

Using a terraform community module to setup AWS ES. Check variables.tf and output.tf for further configuration remark.

terraform init
terraform plan -out es.out -var-file es.tvars
terraform apply "es.out"
terraform destroy

About

Terraform script to setup AWS ES including SecurityGroup and JumpStation to access the cluster.

Languages

Language:HCL 100.0%