logstash-output-vespa_feed 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b98f32843d4795adab351f144fe2391e013d2b6aaa9df269aa6f2d3632898bbf
-  data.tar.gz: 00b9672c21612ff9b39bdb826f19a37740cf556d507dcf1934d88d4b4d051530
+  metadata.gz: 186273bc178047bdc0a838874803aca962a710909b924a517a384623342aa4ac
+  data.tar.gz: 542044e824ed65a1f2f3bdd5230c960cd2d96a4a2c073f27191db3c5d98ab5ef
 SHA512:
-  metadata.gz: 752be99c8b887e432f63d117ad36b7eba984cabb56252c4dbfb5b56461e47db83250d1fb8845373cedb9e029bb264c644bf9ed443fc31342d10744f359298348
-  data.tar.gz: c8dcffe3604b2de3b3adcf0baff247a8d633e91963627f671c9c8d05d5be591844f9514e9b4041b898664ced8112c693ddab3f388e9d37d2e7943e3a401c26be
+  metadata.gz: df61a29d77945ed8451662f3694dccba2494271c2592ab70252eddb39c5214450092868a68ea7cb8b497a8b899cd5b801ce486799a5b8b38501878dff5a4b45b
+  data.tar.gz: 9d8fdd12570f6668075b6347a124f3aa1398b0e75f782784ea0607135840f8ed6996958d8583b237c420e03ead6d27f5ba9d2c24641c1a870aba0cbd7ff6ce6f

data/README.md

@@ -15,7 +15,7 @@ If you're developing the plugin, you'll want to do something like:
 # build the gem
 ./gradlew gem
 # install it as a Logstash plugin
-/opt/logstash/bin/logstash-plugin install /path/to/logstash-output-vespa/logstash-output-vespa_feed-$VERSION.gem
+/opt/logstash/bin/logstash-plugin install /path/to/logstash-output-vespa/logstash-output-vespa_feed-0.4.0.gem
 # profit
 /opt/logstash/bin/logstash
 ```
@@ -74,9 +74,19 @@ output {
 
   vespa_feed { # including defaults here
   
-    # Vespa endpoint, namespace, doc type (from the schema)
+    # Vespa endpoint
     vespa_url => "http://localhost:8080"
+    
+    # for HTTPS URLS (e.g. Vespa Cloud), you may want to provide a certificate and key for mTLS authentication
+    client_cert => "/home/radu/vespa_apps/myapp/security/clients.pem"
+    # make sure the key isn't password-protected
+    # if it is, you can create a new key without a password like this:
+    # openssl rsa -in myapp_key_with_pass.pem -out myapp_key.pem
+    client_key => "/home/radu/vespa_apps/myapp_key.pem"
+    
+    # namespace could be static or in the %{field} format, picking from a field in the document
     namespace => "no_default_provide_yours"
+    # similarly, doc type could be static or in the %{field} format
     document_type => "no_default_provide_yours_from_schema"
 
     # take the document ID from this field in each row

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.5.0

data/docs/index.asciidoc

@@ -35,6 +35,8 @@ Writes documents to Vespa.
 |=======================================================================
 |Setting |Input type|Required
 | <<plugins-{type}s-{plugin}-vespa_url>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-client_cert>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-client_key>> |<<string,string>>|No
 | <<plugins-{type}s-{plugin}-namespace>> |<<string,string>>|Yes
 | <<plugins-{type}s-{plugin}-document_type>> |<<string,string>>|Yes
 | <<plugins-{type}s-{plugin}-id_field>> |<<string,string>>|No
@@ -51,21 +53,47 @@ Writes documents to Vespa.
 * Value type is <<string,string>>
 * Default value is `http://localhost:8080`
 
-URL to the Vespa instance
+URL to the Vespa instance.
+
+If you're using Vespa Cloud, it will be listed as an MTLS endpoint under your application. In this case, make sure to set `client_cert` and `client_key` as well.
+
+[id="plugins-{type}s-{plugin}-client_cert"]
+===== `client_cert`
+
+* Value type is <<string,string>>
+* Default value is `nil`
+
+Certificate to use for https://blog.vespa.ai/securing-vespa-with-mutually-authenticated-tls/[mTLS authentication]. It's the preferred method to https://cloud.vespa.ai/en/security/guide.html[authenticate with Vespa Cloud], too.
+
+Make sure to set the `client_key` as well. The certificate should be in PEM format. Also, the `vespa_url` should be an HTTPS URL.
+
+[id="plugins-{type}s-{plugin}-client_key"]
+===== `client_key`
+
+* Value type is <<string,string>>
+* Default value is `nil`
+
+Corresponding private key for the `client_cert` certificate. It must not be password-protected, otherwise Logstash will fail to start complaining `Could not find private key in PEM file`.
 
 [id="plugins-{type}s-{plugin}-namespace"]
 ===== `namespace`
 
 * Value type is <<string,string>>
 
-Vespa namespace. A logical grouping of documents in Vespa
+Vespa namespace. A logical grouping of documents in Vespa.
+
+Can be static or dynamic, i.e. you can use something like `%{foo}` to use the value in the `foo` field as the namespace. If the field is not present or returns null, the plugin will use the field name as is (here, `foo`).
 
 [id="plugins-{type}s-{plugin}-document_type"]
 ===== `document_type`
 
 * Value type is <<string,string>>
 
-Document type. You should see it in the Vespa services.xml file as well as in the schema file
+Document type. Physical separation of documents in different files underneath.
+
+You should see it in the Vespa services.xml file as well as in the schema file.
+
+Like `namespace`, this can be static or dynamic. So you can use `%{foo}` to use the value in the `foo` field as the document type. If the field is not present or returns null, the plugin will use the field name as is (here, `foo`).
 
 [id="plugins-{type}s-{plugin}-id_field"]
 ===== `id_field`

data/lib/logstash-output-vespa_feed_jars.rb

@@ -2,4 +2,4 @@
 # encoding: utf-8
 
 require 'jar_dependencies'
-require_jar('org.logstashplugins', 'logstash-output-vespa_feed', '0.3.0')
+require_jar('org.logstashplugins', 'logstash-output-vespa_feed', '0.5.0')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-vespa_feed
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Radu Gheorghe
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-22 00:00:00.000000000 Z
+date: 2024-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -77,7 +77,7 @@ files:
 - lib/logstash-output-vespa_feed_jars.rb
 - lib/logstash/outputs/vespa_feed.rb
 - logstash-output-vespa_feed.gemspec
-- vendor/jar-dependencies/org/logstashplugins/logstash-output-vespa_feed/0.3.0/logstash-output-vespa_feed-0.3.0.jar
+- vendor/jar-dependencies/org/logstashplugins/logstash-output-vespa_feed/0.5.0/logstash-output-vespa_feed-0.5.0.jar
 homepage: https://vespa.ai
 licenses:
 - Apache-2.0