First commit of TA-octopus_deploy

CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0
+
+First version

LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2017 Coen Meerbeek
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,78 @@
+# Splunk TA for Octopus Deploy
+
+The Splunk TA for Octopus Deploy is a technology add-on for retrieving data from a Octopus Deployment installation. This Add-On only provides a Modular Input and related configuration files. 
+
+## Getting Started
+
+You must have an installed and configured Octopus application to complete the setup process of this app.
+
+### Install Prerequisites
+
+Too make sure everything works correctly make sure the following is available and working:
+
+1. A working Octopus application
+2. Access to the REST API port on the Octopus server from a Heavy Forwarder or Splunk single instance (port 80 for HTTP and port 443 for HTTP or else if configured differently)
+3. An API key to retrieve data from Octopus. See [Octopus Wiki](https://github.com/OctopusDeploy/OctopusDeploy-Api/wiki).
+4. A Splunk Heavy Forwarder or Single Instance with Splunk 6.0.x or higher running on Linux or Unix or OS X.
+
+### Install instructions
+
+Installation of the apps can be done using the Splunk UI as explained below or manually be extracting the add-on to the $SPLUNK_HOME/etc/apps folder. 
+
+**Install using Splunk UI:**
+
+1. Select "Manage Apps" from the Apps dropdown.
+2. Select the "Install app from file" button.
+3. Select the generated `TA-octopus_deploy.spl` package.
+4. Go to Settings -> Data Inputs -> Octopus Deploy API to add inputs.
+
+**Configure the TA**
+
+The TA will not deliver predefined inputs for now so you need to configure each inputs manually. Go to Settings -> Data Inputs -> Octopus Deploy API to start configuring Inputs.
+
+When you press "New" the Input Wizard will start and you will see one screen with multiple fields.
+
+1. name > The name for Input in the Splunk UI (e.g. Octopus Users)
+2. Endpoint > The Octopus endpoint to access (e.g. users)
+3. Protocol > The protocol on which Octopus Deploy is listening (HTTP or HTTPS)
+4. Hostname > The hostname and port on which Octopus Deploy is listening (e.g. octopus.example.com:8080)
+5. API key > The API key needed for authentication with the API. See [Octopus Wiki](https://github.com/OctopusDeploy/OctopusDeploy-Api/wiki).
+6. Use check pointing > If you do not want to index all the data inside each time the Input is running enable check pointing. The Input will keep track of the last indexed record and will only index new records.
+
+Check "More Settings" to configure Interval, Sourcetype, Host and Index. By default the TA will use the `octopus` Index and an Interval of 300 seconds if you add an Input.
+
+The following list show the most common endpoints for Octopus Deploy API and if check pointing should be applied:
+* machines (use check pointing: NO)
+* projects (use check pointing: NO)
+* releases (use check pointing: YES)
+* deployments (use check pointing: YES)
+* events (use check pointing: YES)
+* environments (use check pointing: NO)
+* users (use check pointing: NO)
+* tasks (use check pointing: YES)
+
+See [Octopus Wiki](https://github.com/OctopusDeploy/OctopusDeploy-Api/wiki) for more information on the available endpoints.
+
+## ChangeLog
+
+See [CHANGELOG](CHANGELOG.md) for details.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Support
+
+This app is developed in the open at [GitHub](https://github.com/cmeerbeek/TA-octopus_deploy). Use that repository-page to file issues if you have questions or need support.
+
+## ToDo
+
+* Add configuration page so you only need to provide the authentication information and data starts flowing.
+
+## Copyright
+
+ Copyright (c) 2017 Coen Meerbeek. See [LICENSE](LICENSE) for details.

README/inputs.conf.spec

@@ -0,0 +1,13 @@
+[TA-octopus_deploy://<name>]
+* Stream data from the Octopus Deploy API.
+
+endpoint = <value>
+* This is the Octopus Deploy endpoint like deployments, users or events.
+protocol = <value>
+* Protocol for accessing the Octopus Deploy API
+hostname = <value>
+* Hostname of Octopus Deploy environment (hostname:port)
+api_key = <value>
+* Key for accessing the Octopus Deploy API
+use_checkpoint = <value>
+* Decide if check pointing is needed for this endpoint