Meet k6 registry requirements (#9)

With this commit we:

* Simplify the docker-compose file and improve docs
* Move the example script to the required directory
* Upgrade to the most recent version of k6

Relates #8

Author: danielmitterdorfer

.env

@@ -5,7 +5,7 @@ ELASTIC_PASSWORD=changeme
 KIBANA_PASSWORD=changeme
 
 # Version of Elastic products
-STACK_VERSION=8.7.0
+STACK_VERSION=8.8.0
 
 # Set the cluster name
 CLUSTER_NAME=docker-cluster
@@ -23,4 +23,4 @@ KIBANA_PORT=5601
 #KIBANA_PORT=80
 
 # Increase or decrease based on the available host memory (in bytes)
-MEM_LIMIT=1073741824
+MEM_LIMIT=2147483648

README.md

@@ -46,7 +46,7 @@ Alternatively, you can send metrics to a local (unsecured) cluster:
 ```shell
 export K6_ELASTICSEARCH_URL=http://localhost:9200
 
-./k6 run ./samples/script.js -o output-elasticsearch
+./k6 run ./examples/script.js -o output-elasticsearch
 ```
 
 If running locally with TLS (with a self-signed certificate), set `K6_ELASTICSEARCH_INSECURE_SKIP_VERIFY` to `true` (defaults to `false`):
@@ -55,7 +55,7 @@ If running locally with TLS (with a self-signed certificate), set `K6_ELASTICSEA
 export K6_ELASTICSEARCH_URL=https://localhost:9200
 export K6_ELASTICSEARCH_INSECURE_SKIP_VERIFY=true
 
-./k6 run ./samples/script.js -o output-elasticsearch
+./k6 run ./examples/script.js -o output-elasticsearch
 ```
 
 The metrics are stored in the index `k6-metrics` which will be automatically created by this extension. See the [mapping](pkg/esoutput/mapping.json) for details.
@@ -68,7 +68,7 @@ Note that some variables (Stack version, elastic and Kibana users' passwords) ar
 
 Clone the repo to get started and follow these steps: 
 
-1. Put your `k6` scripts in the `samples` directory or use the [`script.js`](./samples/script.js) example.
+1. Put your `k6` scripts in the `examples` directory or use the [`script.js`](examples/script.js) example.
 
 3. Start the `docker-compose` environment.
 
@@ -79,16 +79,16 @@ Clone the repo to get started and follow these steps:
 4. Use the k6 Docker image to run the k6 script and send metrics to the Elasticsearch cluster started in the previous step.
 
     ```shell
-    docker-compose run --rm -T k6 run -<samples/script.js --tag testid=<SOME-ID>
+    docker-compose run --rm -T k6 run -<examples/script.js --tag testid=<SOME-ID>
     ```
 
 	> Note that the [docker-compose command to run k6 tests](https://k6.io/docs/getting-started/running-k6/) might differ depending your OS.
 
-5. Visit http://localhost:5601/ to view results in Kibana.
+5. Visit http://localhost:5601/ to view results in Kibana (default credentials are `elastic` / `changeme`).
 
     - Create a [Data View](https://www.elastic.co/guide/en/kibana/current/data-views.html) for the index `k6-metrics`.
         ![Kibana Data View](./images/kibana-data-view.png)
     - Go to [Discover](https://www.elastic.co/guide/en/kibana/current/discover.html) to start exploring the metrics.
         ![Kibana Discover](./images/kibana-discover.png)
 
-When done, to clean up run `docker-compose down -v`.
+When done, to clean up run `docker-compose down -v`.

docker-compose.yml

@@ -1,4 +1,4 @@
-version: "3.7"
+version: "2.2"
 
 services:
   setup:
@@ -30,18 +30,6 @@ services:
           "      - localhost\n"\
           "    ip:\n"\
           "      - 127.0.0.1\n"\
-          "  - name: es02\n"\
-          "    dns:\n"\
-          "      - es02\n"\
-          "      - localhost\n"\
-          "    ip:\n"\
-          "      - 127.0.0.1\n"\
-          "  - name: es03\n"\
-          "    dns:\n"\
-          "      - es03\n"\
-          "      - localhost\n"\
-          "    ip:\n"\
-          "      - 127.0.0.1\n"\
           > config/certs/instances.yml;
           bin/elasticsearch-certutil cert --silent --pem -out config/certs/certs.zip --in config/certs/instances.yml --ca-cert config/certs/ca/ca.crt --ca-key config/certs/ca/ca.key;
           unzip config/certs/certs.zip -d config/certs;
@@ -57,7 +45,7 @@ services:
         echo "All done!";
       '
     healthcheck:
-      test: [ "CMD-SHELL", "[ -f config/certs/es01/es01.crt ]" ]
+      test: ["CMD-SHELL", "[ -f config/certs/es01/es01.crt ]"]
       interval: 1s
       timeout: 5s
       retries: 120
@@ -75,10 +63,10 @@ services:
     environment:
       - node.name=es01
       - cluster.name=${CLUSTER_NAME}
-      - cluster.initial_master_nodes=es01,es02,es03
-      - discovery.seed_hosts=es02,es03
+      - discovery.type=single-node
       - ELASTIC_PASSWORD=${ELASTIC_PASSWORD}
       - bootstrap.memory_lock=true
+      - xpack.ml.enabled=false
       - xpack.security.enabled=true
       - xpack.security.http.ssl.enabled=true
       - xpack.security.http.ssl.key=certs/es01/es01.key
@@ -105,92 +93,11 @@ services:
       timeout: 10s
       retries: 120
 
-  es02:
-    depends_on:
-      - es01
-    image: docker.elastic.co/elasticsearch/elasticsearch:${STACK_VERSION}
-    volumes:
-      - certs:/usr/share/elasticsearch/config/certs
-      - esdata02:/usr/share/elasticsearch/data
-    environment:
-      - node.name=es02
-      - cluster.name=${CLUSTER_NAME}
-      - cluster.initial_master_nodes=es01,es02,es03
-      - discovery.seed_hosts=es01,es03
-      - bootstrap.memory_lock=true
-      - xpack.security.enabled=true
-      - xpack.security.http.ssl.enabled=true
-      - xpack.security.http.ssl.key=certs/es02/es02.key
-      - xpack.security.http.ssl.certificate=certs/es02/es02.crt
-      - xpack.security.http.ssl.certificate_authorities=certs/ca/ca.crt
-      - xpack.security.transport.ssl.enabled=true
-      - xpack.security.transport.ssl.key=certs/es02/es02.key
-      - xpack.security.transport.ssl.certificate=certs/es02/es02.crt
-      - xpack.security.transport.ssl.certificate_authorities=certs/ca/ca.crt
-      - xpack.security.transport.ssl.verification_mode=certificate
-      - xpack.license.self_generated.type=${LICENSE}
-    mem_limit: ${MEM_LIMIT}
-    ulimits:
-      memlock:
-        soft: -1
-        hard: -1
-    healthcheck:
-      test:
-        [
-          "CMD-SHELL",
-          "curl -s --cacert config/certs/ca/ca.crt https://localhost:9200 | grep -q 'missing authentication credentials'"
-        ]
-      interval: 10s
-      timeout: 10s
-      retries: 120
-
-  es03:
-    depends_on:
-      - es02
-    image: docker.elastic.co/elasticsearch/elasticsearch:${STACK_VERSION}
-    volumes:
-      - certs:/usr/share/elasticsearch/config/certs
-      - esdata03:/usr/share/elasticsearch/data
-    environment:
-      - node.name=es03
-      - cluster.name=${CLUSTER_NAME}
-      - cluster.initial_master_nodes=es01,es02,es03
-      - discovery.seed_hosts=es01,es02
-      - bootstrap.memory_lock=true
-      - xpack.security.enabled=true
-      - xpack.security.http.ssl.enabled=true
-      - xpack.security.http.ssl.key=certs/es03/es03.key
-      - xpack.security.http.ssl.certificate=certs/es03/es03.crt
-      - xpack.security.http.ssl.certificate_authorities=certs/ca/ca.crt
-      - xpack.security.transport.ssl.enabled=true
-      - xpack.security.transport.ssl.key=certs/es03/es03.key
-      - xpack.security.transport.ssl.certificate=certs/es03/es03.crt
-      - xpack.security.transport.ssl.certificate_authorities=certs/ca/ca.crt
-      - xpack.security.transport.ssl.verification_mode=certificate
-      - xpack.license.self_generated.type=${LICENSE}
-    mem_limit: ${MEM_LIMIT}
-    ulimits:
-      memlock:
-        soft: -1
-        hard: -1
-    healthcheck:
-      test:
-        [
-          "CMD-SHELL",
-          "curl -s --cacert config/certs/ca/ca.crt https://localhost:9200 | grep -q 'missing authentication credentials'"
-        ]
-      interval: 10s
-      timeout: 10s
-      retries: 120
 
   kibana:
     depends_on:
       es01:
         condition: service_healthy
-      es02:
-        condition: service_healthy
-      es03:
-        condition: service_healthy
     image: docker.elastic.co/kibana/kibana:${STACK_VERSION}
     volumes:
       - certs:/usr/share/kibana/config/certs
@@ -208,7 +115,7 @@ services:
       test:
         [
           "CMD-SHELL",
-          "curl -s -I http://localhost:5601 | grep -q 'HTTP/1.1 302 Found'"
+          "curl -s -I http://localhost:5601 | grep -q 'HTTP/1.1 302 Found'",
         ]
       interval: 10s
       timeout: 10s
@@ -225,16 +132,12 @@ services:
       - K6_ELASTICSEARCH_PASSWORD=${ELASTIC_PASSWORD}
       - K6_ELASTICSEARCH_INSECURE_SKIP_VERIFY=true
     volumes:
-      - ./samples:/scripts
+      - ./examples:/scripts
 
 volumes:
   certs:
     driver: local
   esdata01:
     driver: local
-  esdata02:
-    driver: local
-  esdata03:
-    driver: local
   kibanadata:
-    driver: local
+    driver: local

samples/script.js examples/script.jssamples/script.js renamed to examples/script.js

@@ -5,35 +5,28 @@ go 1.17
 require (
 	github.com/elastic/go-elasticsearch/v8 v8.1.0
 	github.com/sirupsen/logrus v1.9.0
-	go.k6.io/k6 v0.43.1
+	go.k6.io/k6 v0.45.0
 	gopkg.in/guregu/null.v3 v3.5.0
 )
 
 require (
 	github.com/kubernetes/helm v2.17.0+incompatible
-	github.com/mattn/go-isatty v0.0.17 // indirect
+	github.com/mattn/go-isatty v0.0.18 // indirect
 	github.com/spf13/afero v1.9.3 // indirect
 	golang.org/x/time v0.3.0 // indirect
 )
 
 require (
 	github.com/elastic/elastic-transport-go/v8 v8.1.0 // indirect
-	github.com/fatih/color v1.13.0 // indirect
+	github.com/fatih/color v1.15.0 // indirect
 	github.com/ghodss/yaml v1.0.0 // indirect
 	github.com/josharian/intern v1.0.0 // indirect
-	github.com/klauspost/compress v1.15.14 // indirect
 	github.com/kr/pretty v0.3.0 // indirect
 	github.com/mailru/easyjson v0.7.7 // indirect
 	github.com/mattn/go-colorable v0.1.13 // indirect
 	github.com/mstoykov/atlas v0.0.0-20220811071828-388f114305dd // indirect
-	github.com/oxtoacart/bpool v0.0.0-20190530202638-03653db5a59c // indirect
-	github.com/stretchr/testify v1.8.1 // indirect
-	golang.org/x/crypto v0.5.0 // indirect
-	golang.org/x/net v0.5.0 // indirect
-	golang.org/x/sys v0.4.0 // indirect
-	golang.org/x/text v0.6.0 // indirect
-	google.golang.org/genproto v0.0.0-20230119192704-9d59e20e5cd1 // indirect
-	google.golang.org/grpc v1.52.0 // indirect
+	golang.org/x/sys v0.8.0 // indirect
+	golang.org/x/text v0.9.0 // indirect
 	gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c // indirect
 	gopkg.in/yaml.v2 v2.4.0 // indirect
 )