Add configs

CONTRIBUTING.md

@@ -0,0 +1,104 @@
+# Contributor guide
+
+Snowplow is maintained by the pipeline team at Snowplow Analytics and improved on by external contributors for which we are
+extremely grateful.
+
+## Getting in touch
+
+### Community support requests
+
+First and foremost, please do not log an issue if you are asking for support, all of our community support requests go through
+our Discourse forum: https://discourse.snowplowanalytics.com/.
+
+Posting your problem there ensures more people will see it and you should get support faster than creating a new issue on
+GitHub. Please do create a new issue on GitHub if you think you've found a bug though!
+
+### Gitter
+
+If you want to discuss already created issues, potential bugs, new features you would like to work on or any kind of developer
+chat, you can head over to our [Gitter room](https://gitter.im/snowplow/snowplow).
+
+## Roadmap visibility
+
+Being an open source company, transparency is very important to us, that's why we try to share as much as possible regarding
+what we will be working on next so that you can:
+
+- see how your contributions fit into our roadmap
+- help us design new features
+- share your opinions on the technical direction of the Snowplow pipeline
+
+You can peek into what the pipeline team is working on by looking at
+[the open GitHub projects](https://github.com/snowplow/snowplow/projects).
+
+For insights into what we will be working on next, you can look at
+[the RFC category in our Discourse](https://discourse.snowplowanalytics.com/c/roadmap/rfcs).
+
+## Repository structure
+
+The `snowplow/snowplow` project is split into different Scala projects:
+
+- [`2-collectors/scala-stream-collector`](https://github.com/snowplow/snowplow/tree/master/2-collectors/scala-stream-collector)
+which contains the code to collect events as HTTP requests and output raw events to a streaming platform (Kafka, Kinesis,
+NSQ or PubSub)
+- [`3-enrich/scala-common-enrich`](https://github.com/snowplow/snowplow/tree/master/3-enrich/scala-common-enrich), a
+library common to all the enrichers listed below which turns the raw events outputted by a collector into validated and
+enriched events
+- [`3-enrich/stream-enrich`](https://github.com/snowplow/snowplow/tree/master/3-enrich/stream-enrich), the pipeline which
+turns a stream of raw events into a stream of validated and enriched events and pushes them to a streaming platform (Kafka,
+Kinesis, NSQ or PubSub)
+
+All of these projects can be built and tested with [SBT](https://www.scala-sbt.org/).
+
+## Issues
+
+### Creating an issue
+
+The project contains an issue template which should help guiding you through the process. However, please keep in mind
+that support requests should go to our Discourse forum: https://discourse.snowplowanalytics.com/ and not GitHub issues.
+
+It's also a good idea to log an issue before starting to work on a pull request to discuss it with the maintainers.
+
+### Working on an issue
+
+If you see an issue you would like to work on, please let us know in the issue! That will help us in terms of scheduling and
+not doubling the amount of work.
+
+If you don't know where to start contributing, you can look at
+[the issues labeled `good first issue`](https://github.com/snowplow/snowplow/labels/good%20first%20issue).
+
+## Pull requests
+
+These are a few guidelines to keep in mind when opening pull requests, there is a GitHub template that reiterates most of the
+points described here.
+
+### Commit hygiene
+
+We keep a strict 1-to-1 correspondance between commits and issues, as such our commit messages are formatted in the following
+fashion:
+
+`Component: add issues description (closes #1234)`
+
+for example:
+
+`Scala Common Enrich: add Vero adapter (closes #1234)`
+
+### Writing tests
+
+Whenever necessary, it's good practice to add the corresponding unit tests to whichever feature you are working on.
+
+### Feedback cycle
+
+Reviews should happen fairly quickly during weekdays. If you feel your pull request has been forgotten, please ping one
+or more maintainers in the pull request.
+
+### Getting your pull request merged
+
+If your pull request is fairly chunky, there might be a non-trivial delay between the moment the pull request is approved and
+the moment it gets merged. This is because your pull request will have been scheduled for a specific milestone which might or
+might not be actively worked on by a maintainer at the moment.
+
+### Contributor license agreement
+
+We require outside contributors to sign a Contributor license agreement (or CLA) before we can merge their pull requests.
+You can find more information on the topic in [the dedicated wiki page](https://github.com/snowplow/snowplow/wiki/CLA).
+The @snowplowcla bot will guide you through the process.

README.md

@@ -2,11 +2,16 @@
 
 ## Quickstart
 
-Assuming `git` and `sbt` are installed:
+Assuming [Docker][docker] is installed:
+
+1. Add own `config.json` (specify connection and source details)
+2. Add own `resolver.json` (all schemas must be on [Iglu Server][iglu-server])
+3. Run the Docker image:
 
 ```bash
-$ git clone https://github.com/snowplow-incubator/pgloader.git
-$ cd pgloader
+$ docker run --rm -v $PWD/config:/snowplow/config snowplow-postgres-loader \
+    --resolver /snowplow/config/resolver.json \
+    --config /snowplow/config/config.json
 ```
 
 ## Copyright and License
@@ -22,6 +27,9 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 
+[docker]: https://www.docker.com/
+[iglu-server]: https://github.com/snowplow-incubator/iglu-server
+
 [travis]: https://travis-ci.org/snowplow-incubator/pgloader
 [travis-image]: https://travis-ci.org/snowplow-incubator/pgloader.png?branch=master
 

config/config.json

@@ -0,0 +1,25 @@
+{
+  "schema": "iglu:com.snowplowanalytics.snowplow.storage/postgresql_config/jsonschema/3-0-0",
+  "data": {
+    "name": "Acme Ltd. Snowplow Postgres",
+    "id": "5c5e4353-4eeb-43da-98f8-2de6dc7fa947",
+    "source": {
+      "kinesis": {
+        "appName": "acme-postgres-loader",
+        "streamName": "enriched-events",
+        "region": "eu-central-1",
+        "initialPosition": "TRIM_HORIZON"
+      }
+    },
+
+    "host": "localhost",
+    "database": "snowplow",
+    "port": 5432,
+    "username": "postgres",
+    "password": "mysecretpassword",
+    "schema": "atomic",
+
+    "sslMode": "REQUIRE",
+    "purpose": "ENRICHED_EVENTS"
+  }
+}

config/resolver.json

@@ -0,0 +1,34 @@
+{
+  "schema": "iglu:com.snowplowanalytics.iglu/resolver-config/jsonschema/1-0-2",
+  "data": {
+    "cacheSize": 500,
+    "cacheTtl": 600,
+    "repositories": [
+      {
+        "name": "Iglu Central",
+        "priority": 1,
+        "vendorPrefixes": [
+          "com.snowplowanalytics"
+        ],
+        "connection": {
+          "http": {
+            "uri": "http://iglucentral.com"
+          }
+        }
+      },
+
+      {
+        "name": "Iglu Central - Mirror 01",
+        "priority": 1,
+        "vendorPrefixes": [
+          "com.snowplowanalytics"
+        ],
+        "connection": {
+          "http": {
+            "uri": "http://mirror01.iglucentral.com"
+          }
+        }
+      }
+    ]
+  }
+}