Skip to content

Latest commit

 

History

History
146 lines (106 loc) · 4.63 KB

eks.md

File metadata and controls

146 lines (106 loc) · 4.63 KB

Prombench in EKS

Run Prombench tests in Elastic Kubernetes Service (EKS).

Table of Contents

  1. Setup Prombench
  2. Usage

Setup Prombench

1. Create the Main Node

  1. Create Security Credentials:

    accesskeyid: <Amazon access key>
secretaccesskey: <Amazon access secret>

  2. Create a VPC:

    • Set up a VPC with public subnets.

  3. Create IAM Roles:

    • EKS Cluster Role: Create an Amazon EKS cluster role with the following policy:
      • AmazonEKSclusterPolicy
    • EKS Worker Node Role: Create an Amazon EKS worker node role with the following policies:
      • AmazonEKSWorkerNodePolicy
      • AmazonEKS_CNI_Policy
      • AmazonEC2ContainerRegistryReadOnly

  4. Set Environment Variables and Deploy the Cluster:

    export AUTH_FILE=<path to yaml credentials file that was created in the last step>
export CLUSTER_NAME=prombench
export ZONE=us-east-1
export EKS_WORKER_ROLE_ARN=<Amazon EKS worker node IAM role ARN>
export EKS_CLUSTER_ROLE_ARN=<Amazon EKS cluster role ARN>
export SEPARATOR=, 
export EKS_SUBNET_IDS=SUBNETID1,SUBNETID2,SUBNETID3
export PROVIDER=eks

make cluster_create

2. Deploy Monitoring Components

Note: These components are responsible for collecting, monitoring, and displaying test results and logs.

  1. Optional GitHub Integration:

    • If used with GitHub integration, generate a GitHub auth token: 
    export GRAFANA_ADMIN_PASSWORD=password
export DOMAIN_NAME=prombench.prometheus.io # Can be set to any other custom domain or an empty string if not used with the GitHub integration.
export OAUTH_TOKEN=<generated token from GitHub or set to an empty string " ">
export WH_SECRET=<GitHub webhook secret>
export GITHUB_ORG=prometheus
export GITHUB_REPO=prometheus

  2. Deploy the Monitoring Components:

    • This step will deploy the nginx-ingress-controller, Prometheus-Meta, Loki, Grafana, Alertmanager, and GitHub Notifier.
    make cluster_resource_apply

  3. Configure DNS:

    • The output will display the ingress IP. Use this IP to point the domain name.
    • Set the A record for <DOMAIN_NAME> to point to the nginx-ingress-controller IP address.

  4. Access the Services:

    • Grafana: http://<DOMAIN_NAME>/grafana
    • Prometheus: http://<DOMAIN_NAME>/prometheus-meta
    • Logs: http://<DOMAIN_NAME>/grafana/explore
    • Profiles: http://<DOMAIN_NAME>/profiles

Usage

1. Start a Benchmarking Test Manually

  1. Set the Environment Variables:

    export RELEASE=<master/main or any prometheus release (e.g., v2.3.0)>
export PR_NUMBER=<PR to benchmark against the selected $RELEASE>

  2. Create Nodegroups for Kubernetes Objects:

    make node_create

  3. Deploy the Kubernetes Objects:

    make resource_apply

2. Stopping a Benchmarking Test Manually

  1. Set the Environment Variables:

    export AUTH_FILE=<path to yaml credentials file that was created>
export CLUSTER_NAME=prombench
export SEPARATOR=,
export EKS_WORKER_ROLE_ARN=<Amazon EKS worker node IAM role ARN>
export EKS_CLUSTER_ROLE_ARN=<Amazon EKS cluster role ARN>
export EKS_SUBNET_IDS=SUBNETID1,SUBNETID2,SUBNETID3
export ZONE=us-east-1
export PROVIDER=eks

export PR_NUMBER=<PR to benchmark against the selected $RELEASE>

  2. Delete Nodegroups (Keeping the Main Node Intact):

    make clean

  3. Delete Everything (Complete Teardown):

    make cluster_delete