elastomer-client 6.2.1 → 6.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49da91bf2c259b9b77ed76d66fa001aa4192432225090bb62ff9d74f8173f8dc
-  data.tar.gz: 2d519500cced0a8783a9fd5b77853d935cc3b99f35e8be981e5e1e23b55d9632
+  metadata.gz: 4f424a09ec9e71ac45004cac7097fa874aa1b4c2275f2fc8e827f6d078115237
+  data.tar.gz: '0461827d35a1ddf9bd136fddfd5fd0f0a0ab1a9a6f1d6c78b937402670c30e66'
 SHA512:
-  metadata.gz: 2f0f879414271cf6f861bfcf256ec6af824a60c2603dbb48dc2297ecffae55f969e7947e8c9cfc0469239c15fe4b9754721279886def527eb89658a549f085fb
-  data.tar.gz: 42cd80d2c67d119767451b524543f73cc1af3ffda4088186cfac8daa99970849655c05ed5382e7ab689a71e1a5c8e4c6b620fbaf66a91693e4afad7e186900ff
+  metadata.gz: 5d621a224ee207f16683946ee37fef808c8132e119503d24b0465566b1040191ed01e3e342e7fcc6f58eadfcffa89ae20a523e969344cdcf4aad000ce84d1dfc
+  data.tar.gz: 0745ccbc186f42e2d68feb52eafed5712249358b3922dfeece1785d784a1e16ccc6fb3ecc3a0a0afc7d168cac8e8a267bb01745152705a39aceb57fafb73f121

data/.github/workflows/main.yml

@@ -12,11 +12,11 @@ jobs:
     strategy:
       matrix:
         ruby-version: ['3.2']
-        ES_VERSION: ['8.13.2']
+        ES_VERSION: ['8.18.0']
         include:
-          - ES_VERSION: '8.13.2'
+          - ES_VERSION: '8.18.0'
             ES_DOWNLOAD_URL: >-
-              https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-8.13.2-linux-x86_64.tar.gz
+              https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-8.18.0-linux-x86_64.tar.gz
     steps:
       - uses: ruby/setup-ruby@v1
         with:

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 6.2.3 (2025-06-06)
+- Added support for ES 8.17.2
+- Added support for ES 8.18.0
+
+## 6.2.2 (2025-02-19)
+- Add support for manually and automatically following indices for cross-cluster replication
+
 ## 6.2.1 (2024-12-10)
 - Add support for rethrottling reindex tasks
 

data/README.md

@@ -110,7 +110,10 @@ end
 This client is tested against:
 
 - Ruby version 3.2
-- Elasticsearch versions 5.6 and 8.13
+- Elasticsearch versions: 
+  - 5.6
+  - 8.13
+  - 8.18
 
 ## Development
 
@@ -142,6 +145,11 @@ To run ES 5 and ES 8:
 docker compose --project-directory docker --profile all up
 ```
 
+To run in ES8 cross cluster replication mode:
+```
+script/setup-ccr up "{non-production license}"
+```
+
 To run only ES 8:
 ```
 docker compose --project-directory docker --profile es8 up
@@ -159,6 +167,11 @@ ES 8
 ES_PORT=9208 rake test
 ```
 
+CCR tests:
+```
+ES_PORT=9208 ES_REPLICA_PORT=9209 rake test
+```
+
 ES 5
 ```
 ES_PORT=9205 rake test

data/docker/compose.yaml

@@ -1,17 +1,18 @@
 version: "3"
 
 services:
-  elasticsearch8.13:
-    image: docker.elastic.co/elasticsearch/elasticsearch:8.13.2
-    container_name: es8.13
-    profiles: ["es8", "all"]
+  elasticsearch8.18:
+    image: docker.elastic.co/elasticsearch/elasticsearch:8.18.0
+    container_name: es8.18
+    profiles: ["es8", "ccr", "all"]
     environment:
-      - cluster.name=elastomer8.13
+      - cluster.name=elastomer8.18
       - bootstrap.memory_lock=true
       - discovery.type=single-node
       - xpack.security.enabled=false
       - xpack.watcher.enabled=false
       - "ES_JAVA_OPTS=-Xms512m -Xmx512m"
+      - node.roles=[master,data,remote_cluster_client]
     ulimits:
       memlock:
         soft: -1
@@ -28,6 +29,33 @@ services:
     ports:
       - 127.0.0.1:${ES_8_PORT:-9208}:9200
   
+  elasticsearchFollower:
+    image: docker.elastic.co/elasticsearch/elasticsearch:8.18.0
+    container_name: es-follow
+    profiles: ["ccr"]
+    environment:
+      - cluster.name=es-follow
+      - bootstrap.memory_lock=true
+      - discovery.type=single-node
+      - xpack.security.enabled=false
+      - xpack.watcher.enabled=false
+      - "ES_JAVA_OPTS=-Xms512m -Xmx512m"
+      - node.roles=[master,data,remote_cluster_client]
+    ulimits:
+      memlock:
+        soft: -1
+        hard: -1
+      nofile:
+        soft: 65536
+        hard: 65536
+    mem_limit: 2g
+    cap_add:
+      - IPC_LOCK
+    volumes:
+      - ./elasticsearch-follow.yml:/usr/share/elasticsearch/config/elasticsearch.yml
+    ports:
+      - 127.0.0.1:${ES_8_PORT:-9209}:9201
+
   elasticsearch5.6:
     image: docker.elastic.co/elasticsearch/elasticsearch:5.6.4
     container_name: es5.6

data/docker/elasticsearch-follow.yml

@@ -0,0 +1,14 @@
+cluster.name: "es-follow"
+
+network.host: 0.0.0.0
+
+path:
+  data: /usr/share/elasticsearch/data
+  logs: /usr/share/elasticsearch/logs
+  repo: /usr/share/elasticsearch/repos
+
+transport.port: 9301
+http.port: 9201
+remote_cluster.port: 9444
+http.max_content_length: 50mb
+ingest.geoip.downloader.enabled: false

data/docker/elasticsearch8plus.yml

@@ -9,5 +9,6 @@ path:
 
 transport.port: 9300
 http.port: 9200
+remote_cluster.port: 9443
 http.max_content_length: 50mb
 ingest.geoip.downloader.enabled: false

data/lib/elastomer_client/client/ccr.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+module ElastomerClient
+  class Client
+
+    # Returns a CCR instance
+    def ccr
+      Ccr.new(self)
+    end
+
+    class Ccr
+      # Create a new Ccr for initiating requests for cross cluster replication.
+      # More context: https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-apis.html
+      #
+      # client     - ElastomerClient::Client used for HTTP requests to the server
+      def initialize(client)
+        @client = client
+      end
+
+      attr_reader :client
+
+      # Gets the parameters and status for each follower index.
+      #
+      # index_pattern - String name of the index pattern to get follower info for
+      # params        - Hash of query parameters
+      #
+      # Examples
+      #
+      #   ccr.get_follower_info("follower_index")
+      #   ccr.get_follower_info("*")
+      #
+      # See https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-put-follow.html
+      def get_follower_info(index_pattern, params = {})
+        response = client.get "/#{index_pattern}/_ccr/info", params.merge(action: "get_follower_info", rest_api: "ccr")
+        response.body
+      end
+
+      # Creates a new follower index for the provided leader index on the remote cluster.
+      #
+      # follower_index - String name of the follower index to create
+      # body           - Hash of the request body
+      #   :remote_cluster - String name of the remote cluster. Required.
+      #   :leader_index   - String name of the leader index. Required.
+      # params         - Hash of query parameters
+      #
+      # Examples
+      #
+      #   ccr.follow("follower_index", { leader_index: "leader_index", remote_cluster: "leader" })
+      #
+      # See https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-put-follow.html
+      def follow(follower_index, body, params = {})
+        response = client.put "/#{follower_index}/_ccr/follow", params.merge(body:, action: "follow", rest_api: "ccr")
+        response.body
+      end
+
+      # Creates a new auto-follow pattern for the provided remote cluster.
+      #
+      # pattern_name - String name of the auto-follow pattern to create
+      # body         - Hash of the request body
+      #   :remote_cluster - String name of the remote cluster. Required.
+      #   :leader_index_patterns - An array of simple index patterns to match against indices in the remote cluster
+      #   :leader_index_exclusion_patterns - An array of simple index patterns that can be used to exclude indices from being auto-followed.
+      #   :follow_index_pattern - The name of follower index. The template {{leader_index}} can be used to derive
+      #                           the name of the follower index from the name of the leader index.
+      # params       - Hash of query parameters
+
+      # Examples
+
+      #   ccr.auto_follow("follower_pattern", { remote_cluster: "leader", leader_index_patterns: ["leader_index*"],
+      #                                         follow_index_pattern: "{{leader_index}}-follower" })
+
+      # See https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-put-auto-follow-pattern.html
+
+      def auto_follow(pattern_name, body, params = {})
+        response = client.put "/_ccr/auto_follow/#{pattern_name}", params.merge(body:, action: "create_auto_follow_pattern", rest_api: "ccr")
+        response.body
+      end
+
+      # Deletes the auto-follow pattern for the provided remote cluster.
+      #
+      # pattern_name - String name of the auto-follow pattern to delete
+      # params       - Hash of query parameters
+      #
+      # Examples
+      #
+      #   ccr.delete_auto_follow("follower_pattern")
+      #
+      # See https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-delete-auto-follow-pattern.html
+
+      def delete_auto_follow(pattern_name, params = {})
+        response = client.delete "/_ccr/auto_follow/#{pattern_name}", params.merge(action: "delete_auto_follow_pattern", rest_api: "ccr")
+        response.body
+      end
+
+      # Gets cross-cluster replication auto-follow patterns
+      #
+      # params - Hash of query parameters
+      #   :pattern_name - (Optional) String name of the auto-follow pattern. Returns all patterns if not specified
+      # Examples
+      #
+      #   ccr.get_auto_follow
+      #
+      # See https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-auto-follow-pattern.html
+
+      def get_auto_follow(params = {})
+        response = client.get "/_ccr/auto_follow{/pattern_name}", params.merge(action: "get_auto_follow_pattern", rest_api: "ccr")
+        response.body
+      end
+
+      # Pauses a follower index.
+      #
+      # follower_index - String name of the follower index to pause
+      # params         - Hash of the request body
+      #
+      # Examples
+      #   ccr.pause_follow("follower_index")
+      #
+      # See https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-pause-follow.html
+      def pause_follow(follower_index, params = {})
+        response = client.post "/#{follower_index}/_ccr/pause_follow", params.merge(action: "pause_follow", rest_api: "ccr")
+        response.body
+      end
+
+      # Unfollows a leader index given a follower index.
+      # The follower index must be paused and closed before unfollowing.
+      #
+      # follower_index - String name of the follower index to unfollow
+      # params         - Hash of the request body
+      #
+      # Examples
+      #   ccr.unfollow("follower_index")
+      # See https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-unfollow.html
+      def unfollow(follower_index, params = {})
+        response = client.post "/#{follower_index}/_ccr/unfollow", params.merge(action: "unfollow", rest_api: "ccr")
+        response.body
+      end
+    end
+  end
+end

data/lib/elastomer_client/client/reindex.rb

@@ -20,12 +20,12 @@ module ElastomerClient
       attr_reader :client
 
       def reindex(body, params = {})
-        response = client.post "/_reindex", params.merge(params, body:, action: "reindex", rest_api: "reindex")
+        response = client.post "/_reindex", params.merge(body:, action: "reindex", rest_api: "reindex")
         response.body
       end
 
       def rethrottle(task_id, params = {})
-        response = client.post "/_reindex/#{task_id}/_rethrottle", params.merge(params, action: "rethrottle", rest_api: "reindex")
+        response = client.post "/_reindex/#{task_id}/_rethrottle", params.merge(action: "rethrottle", rest_api: "reindex")
         response.body
       end