Update reference package (#248)

Add details to the reference package discussed in #242

dev/packages/example/reference-1.0.0/dataset/reference/manifest.yml

@@ -0,0 +1,48 @@
+# Title of the dataset
+title: Reference Logs Title
+
+# Release status of the dataset.
+# Allowed values: ga, beta, experimental
+release: beta
+
+# Describes the type of the dataset.
+# Allowed values: logs, metrics, events
+type: logs
+
+# This is the ingest pipeline which should be used. If none is define,
+# it checks if a default pipeline exists.
+#ingest_pipeline: default
+
+# List of supported streams. There can be multiple stream definitions for different input types.
+streams:
+  -
+    # This is the input to be used defined on the package level. The names must match.
+    input: logs
+
+    # Title shown for the stream. If not set, falls back to dataset id
+    title: Title reference stream
+
+    # Description of the stream. It can contain markdown and should contain more details about the stream.
+    description: Collecting the nginx access logs from file.
+
+    vars:
+      - name: paths
+        required: true
+
+        # Title shown on top of the variable
+        title: Example variable title
+
+        # More detailed description of the variable, example values, how to use it. Markdown is allowed.
+        description: >
+          Description around how a variable should be used, what values it can contain and it can even contain
+          **Markdown** or links.
+
+        # Type to be used for it in the UI.
+        # Allowed values: text, password, bool, integer
+        type: text
+
+        # Multi defines if the values is an array and multiple values can be defined
+        multi: true
+
+        # Default value to be filled in, in the UI.
+        default: foo

dev/packages/example/reference-1.0.0/docs/README.md

@@ -1,3 +1,5 @@
 # Reference package
 
 This is the standard README.md file for the reference package.
+
+In here, all the documentation around the package itself and the datasets should be added. This can become pretty long.

dev/packages/example/reference-1.0.0/manifest.yml

@@ -66,8 +66,52 @@ screenshots:
 #    type: video/mp4
 
 # Icons options are commented out as currently not icons added
+# It is expected that icons are in svg, but other formats are supported.
 icons:
-#  - src: "/img/icon.png"
-#    size: "1800x1800"
-#    type: "image/png"
+  -
+    # src is a required field
+    src: "/img/icon.svg"
+    # This helps to send the right header
+    type: "image/svg+xml"
+    # Size of the image, can be useful if it has to be scaled.
+    size: 32x32
 
+# Defining a datasource allows the UI to generate a form for each input and generate the agent
+# config out of it. For a visual guide on what fields is used how in the UI, check out https://github.com/elastic/package-registry/pull/242
+datasources:
+  -
+    # Do we need a name for the data source?
+    name: nginx
+    title: Nginx logs and metrics.
+    description: Collecting logs and metrics from nginx.
+
+    # List of inputs this datasource supports
+    inputs:
+      -
+        # An id can be given, in case the type used here is not unique
+        # This is for selection in the stream
+        # id: nginx
+
+        # The type describing this input. These are the types supported by the agent
+        # and are used by the stream definition to reference a type.
+        type: nginx/metrics
+
+        # Short title to describe the input. It should not have a dot at the end.
+        title: Collect metrics and logs from reference service
+
+        # This description is to describe what this input is about. It can contain markdown
+        # and should always end with a dot.
+        description: Description of the reference input.
+
+        # Common configuration options for this input
+        vars:
+          - name: hosts
+            title: Hosts
+
+            description: List of nginx hosts to collect data from.
+            default:
+              ["http://127.0.0.1"]
+            # All the config options that are required should be shown in the UI
+            required: true
+            multi: true
+            type: text