Add Helm Chart (#33)

This commit adds a Helm chart and instructions for installing adapter
via the same.

Signed-off-by: Venil Noronha <veniln@vmware.com>

README.md

@@ -13,7 +13,18 @@ taken before using it in production environments.
 
 ## Quick Start
 
-### Configuration
+This adapter could be installed either via [Helm](#helm-installation) or via the
+[Standard](#standard-installation) method.
+
+### Helm Installation
+
+[Helm](https://helm.sh/) is the preferred way of installing this adapter. Please
+see the [Helm Quick Start](install/wavefront#quick-start) to learn to install
+this adapter using Helm.
+
+### Standard Installation
+
+#### Configuration
 
 1\. Download the configuration from the [releases page](https://github.com/vmware/wavefront-adapter-for-istio/releases)
 and extract it.
@@ -58,7 +69,7 @@ params:
 See the [reference docs](https://istio.io/docs/reference/config/policy-and-telemetry/adapters/wavefront/)
 for the available configuration parameters.
 
-### Deployment
+#### Deployment
 
 Execute the following command to configure the Istio Mixer to publish metrics to
 Wavefront using this adapter. This step must be performed after deploying

config/sample_operator_config.yaml

@@ -9,6 +9,7 @@ spec:
   params:
     value: request.size | 0
     dimensions:
+      reporter: conditional((context.reporter.kind | "inbound") == "outbound", "client", "server")
       source_service: source.workload.name | "unknown"
       source_service_namespace: source.workload.namespace | "unknown"
       source_version: source.labels["version"] | "unknown"
@@ -50,6 +51,7 @@ spec:
   params:
     value: response.duration | "0ms"
     dimensions:
+      reporter: conditional((context.reporter.kind | "inbound") == "outbound", "client", "server")
       source_service: source.workload.name | "unknown"
       source_service_namespace: source.workload.namespace | "unknown"
       source_version: source.labels["version"] | "unknown"
@@ -70,6 +72,7 @@ spec:
   params:
     value: response.size | 0
     dimensions:
+      reporter: conditional((context.reporter.kind | "inbound") == "outbound", "client", "server")
       source_service: source.workload.name | "unknown"
       source_service_namespace: source.workload.namespace | "unknown"
       source_version: source.labels["version"] | "unknown"
@@ -90,6 +93,7 @@ spec:
   params:
     value: connection.sent.bytes | 0
     dimensions:
+      reporter: conditional((context.reporter.kind | "inbound") == "outbound", "client", "server")
       source_service: source.workload.name | "unknown"
       source_service_namespace: source.workload.namespace | "unknown"
       source_version: source.labels["version"] | "unknown"
@@ -109,6 +113,7 @@ spec:
   params:
     value: connection.received.bytes | 0
     dimensions:
+      reporter: conditional((context.reporter.kind | "inbound") == "outbound", "client", "server")
       source_service: source.workload.name | "unknown"
       source_service_namespace: source.workload.namespace | "unknown"
       source_version: source.labels["version"] | "unknown"

install/wavefront/Chart.yaml

@@ -0,0 +1,12 @@
+apiVersion: v1
+name: wavefront
+version: 0.1.0
+description: A Helm chart for Wavefront by VMware Adapter for Istio
+home: https://github.com/vmware/wavefront-adapter-for-istio/
+sources:
+  - https://github.com/vmware/wavefront-adapter-for-istio/
+maintainers:
+  - name: Venil Noronha
+    email: veniln@vmware.com
+engine: gotpl
+icon: https://raw.githubusercontent.com/vmware/wavefront-adapter-for-istio/master/docs/images/logo.png

install/wavefront/LICENSE

@@ -0,0 +1,182 @@
+Wavefront by VMware Adapter for Istio
+
+Copyright (c) 2018 VMware, Inc.  All rights reserved
+
+The Apache 2.0 license (the "License") set forth below applies to all
+parts of the Wavefront by VMware Adapter for Istio project.  You may
+not use this file except in compliance with the License.
+
+Apache License
+
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction,
+and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the
+copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other
+entities that control, are controlled by, or are under common control
+with that entity. For the purposes of this definition, "control" means
+(i) the power, direct or indirect, to cause the direction or management
+of such entity, whether by contract or otherwise, or (ii) ownership
+of fifty percent (50%) or more of the outstanding shares, or (iii)
+beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation source,
+and configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation
+or translation of a Source form, including but not limited to compiled
+object code, generated documentation, and conversions to other media
+types.
+
+"Work" shall mean the work of authorship, whether in Source or
+Object form, made available under the License, as indicated by a copyright
+notice that is included in or attached to the work (an example is provided
+in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form,
+that is based on (or derived from) the Work and for which the editorial
+revisions, annotations, elaborations, or other modifications represent,
+as a whole, an original work of authorship. For the purposes of this
+License, Derivative Works shall not include works that remain separable
+from, or merely link (or bind by name) to the interfaces of, the Work
+and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the
+original version of the Work and any modifications or additions to
+that Work or Derivative Works thereof, that is intentionally submitted
+to Licensor for inclusion in the Work by the copyright owner or by an
+individual or Legal Entity authorized to submit on behalf of the copyright
+owner. For the purposes of this definition, "submitted" means any form of
+electronic, verbal, or written communication sent to the Licensor or its
+representatives, including but not limited to communication on electronic
+mailing lists, source code control systems, and issue tracking systems
+that are managed by, or on behalf of, the Licensor for the purpose of
+discussing and improving the Work, but excluding communication that is
+conspicuously marked or otherwise designated in writing by the copyright
+owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity
+on behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+
+2. Grant of Copyright License.
+Subject to the terms and conditions of this License, each Contributor
+hereby grants to You a perpetual, worldwide, non-exclusive, no-charge,
+royalty-free, irrevocable copyright license to reproduce, prepare
+Derivative Works of, publicly display, publicly perform, sublicense, and
+distribute the Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License.
+Subject to the terms and conditions of this License, each Contributor
+hereby grants to You a perpetual, worldwide, non-exclusive, no-charge,
+royalty- free, irrevocable (except as stated in this section) patent
+license to make, have made, use, offer to sell, sell, import, and
+otherwise transfer the Work, where such license applies only to those
+patent claims licensable by such Contributor that are necessarily
+infringed by their Contribution(s) alone or by combination of
+their Contribution(s) with the Work to which such Contribution(s)
+was submitted. If You institute patent litigation against any entity
+(including a cross-claim or counterclaim in a lawsuit) alleging that the
+Work or a Contribution incorporated within the Work constitutes direct
+or contributory patent infringement, then any patent licenses granted
+to You under this License for that Work shall terminate as of the date
+such litigation is filed.
+
+4. Redistribution.
+You may reproduce and distribute copies of the Work or Derivative Works
+thereof in any medium, with or without modifications, and in Source or
+Object form, provided that You meet the following conditions:
+
+  a. You must give any other recipients of the Work or Derivative Works
+     a copy of this License; and
+
+  b. You must cause any modified files to carry prominent notices stating
+     that You changed the files; and
+
+  c. You must retain, in the Source form of any Derivative Works that
+     You distribute, all copyright, patent, trademark, and attribution
+     notices from the Source form of the Work, excluding those notices
+     that do not pertain to any part of the Derivative Works; and
+
+  d. If the Work includes a "NOTICE" text file as part of its
+     distribution, then any Derivative Works that You distribute must
+     include a readable copy of the attribution notices contained
+     within such NOTICE file, excluding those notices that do not
+     pertain to any part of the Derivative Works, in at least one of
+     the following places: within a NOTICE text file distributed as part
+     of the Derivative Works; within the Source form or documentation,
+     if provided along with the Derivative Works; or, within a display
+     generated by the Derivative Works, if and wherever such third-party
+     notices normally appear. The contents of the NOTICE file are for
+     informational purposes only and do not modify the License. You
+     may add Your own attribution notices within Derivative Works that
+     You distribute, alongside or as an addendum to the NOTICE text
+     from the Work, provided that such additional attribution notices
+     cannot be construed as modifying the License.  You may add Your own
+     copyright statement to Your modifications and may provide additional
+     or different license terms and conditions for use, reproduction, or
+     distribution of Your modifications, or for any such Derivative Works
+     as a whole, provided Your use, reproduction, and distribution of the
+     Work otherwise complies with the conditions stated in this License.
+
+5. Submission of Contributions.
+Unless You explicitly state otherwise, any Contribution intentionally
+submitted for inclusion in the Work by You to the Licensor shall be
+under the terms and conditions of this License, without any additional
+terms or conditions.  Notwithstanding the above, nothing herein shall
+supersede or modify the terms of any separate license agreement you may
+have executed with Licensor regarding such Contributions.
+
+6. Trademarks.
+This License does not grant permission to use the trade names, trademarks,
+service marks, or product names of the Licensor, except as required for
+reasonable and customary use in describing the origin of the Work and
+reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty.
+Unless required by applicable law or agreed to in writing, Licensor
+provides the Work (and each Contributor provides its Contributions) on
+an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+express or implied, including, without limitation, any warranties or
+conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR
+A PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any risks
+associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability.
+In no event and under no legal theory, whether in tort (including
+negligence), contract, or otherwise, unless required by applicable law
+(such as deliberate and grossly negligent acts) or agreed to in writing,
+shall any Contributor be liable to You for damages, including any direct,
+indirect, special, incidental, or consequential damages of any character
+arising as a result of this License or out of the use or inability to
+use the Work (including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all other
+commercial damages or losses), even if such Contributor has been advised
+of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability.
+While redistributing the Work or Derivative Works thereof, You may
+choose to offer, and charge a fee for, acceptance of support, warranty,
+indemnity, or other liability obligations and/or rights consistent with
+this License. However, in accepting such obligations, You may act only
+on Your own behalf and on Your sole responsibility, not on behalf of
+any other Contributor, and only if You agree to indemnify, defend, and
+hold each Contributor harmless for any liability incurred by, or claims
+asserted against, such Contributor by reason of your accepting any such
+warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

install/wavefront/README.md

@@ -0,0 +1,72 @@
+# Wavefront by VMware Adapter for Istio
+
+[Helm](https://helm.sh/) is a package manager for Kubernetes. You could use Helm
+for installing the Wavefront by VMware adapter on your Kubernetes deployment.
+
+## Quick Start
+
+### Prerequisites
+
+1. Install [Helm](https://docs.helm.sh/using_helm/#installing-helm).
+
+2. Install Tiller via Helm.
+
+```shell
+helm init
+```
+
+3. Download and extract [Istio](https://istio.io/docs/setup/kubernetes/download-release/).
+
+4. Install Istio CRDs (Custom Resource Definitions).
+
+```shell
+kubectl apply -f install/kubernetes/helm/istio/templates/crds.yaml
+```
+
+### Configuration
+
+You could configure the adapter installation via `values.yaml`. Below is a list
+of configurable parameters.
+
+* **adapter** holds the adapter installation parameters
+  * **image** represents the Docker image name
+  * **tag** represents the Docker image tag
+
+* **credentials** holds credentials for a Wavefront by VMware instance. One of
+  either `direct` or `proxy` parameters must be supplied.
+  * **direct** holds credentials for direct ingestion.
+    * **server** is the server URL. Ex: https://mydomain.wavefront.com
+    * **token** is the API token.
+  * **proxy** holds credentials for ingestion via a Proxy.
+    * **address** is the proxy address. Ex: 192.168.99.100:2878
+
+* **metrics** holds the metric configuration.
+  * **flushInterval** is the metric flush interval.
+  * **source** is the source tag for all metrics handled by this adapter.
+  * **prefix** is the prefix to prepend all metrics handled by this adapter.
+  * **http** is a flag that specifies whether HTTP metrics should be captured.
+  * **tcp** is a flag that specifies whether TCP metrics should be captured.
+
+### Deployment
+
+#### Installation
+
+To install the adapter via Helm, execute the following command.
+
+```shell
+helm install install/wavefront/
+```
+
+#### Uninstallation
+
+To uninstall the adapter, first identify the Helm release name, like so:
+
+```shell
+helm list
+```
+
+Then uninstall it using the following command.
+
+```shell
+helm delete <release-name>
+```

install/wavefront/templates/adapter.yaml

@@ -0,0 +1,42 @@
+# service for adapter wavefront
+apiVersion: v1
+kind: Service
+metadata:
+  name: wavefront
+  namespace: istio-system
+  labels:
+    app: wavefront
+spec:
+  type: ClusterIP
+  ports:
+  - name: grpc
+    protocol: TCP
+    port: 8000
+    targetPort: 8000
+  selector:
+    app: wavefront
+---
+# deployment for adapter wavefront
+apiVersion: extensions/v1beta1
+kind: Deployment
+metadata:
+  name: wavefront
+  namespace: istio-system
+  labels:
+    app: wavefront
+spec:
+  replicas: 1
+  template:
+    metadata:
+      labels:
+        app: wavefront
+      annotations:
+        sidecar.istio.io/inject: "false"
+        scheduler.alpha.kubernetes.io/critical-pod: ""
+    spec:
+      containers:
+      - name: wavefront
+        image: {{ .Values.adapter.image }}:{{ .Values.adapter.tag }}
+        imagePullPolicy: Always
+        ports:
+        - containerPort: 8000