[GitHub] [accumulo-proxy] volmasoft commented on a change in pull request #20: WIP: accumulo-proxy docker container

[GitBox <gi...@apache.org>]

volmasoft commented on a change in pull request #20:
URL: https://github.com/apache/accumulo-proxy/pull/20#discussion_r416597585



##########
File path: DOCKER.md
##########
@@ -0,0 +1,53 @@
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements.  See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License.  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+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.
+-->
+
+# accumulo-proxy-docker
+
+A temporary guide on how to run this up in Docker.
+
+## Build the image using
+Invoke the docker build command to create a container image.
+```commandline
+docker build -t accumulo-proxy:latest .
+```
+
+## Default Configuration
+By default, the container image expects the following to be true:
+1. Your accumulo instance is named "myinstance"
+2. Your zookeeper is available (and reachable from the container) at localhost:2181
+
+## Custom proxy.properties
+If you wish to create advanced proxy.properties configuration changes, you should look to volume mount these in when you invoke the `docker run` command, an example is:
+```commandline
+docker run --rm -d -p 42424:42424 -v /path/to/proxy.properties:/opt/accumulo-proxy/conf/proxy.properties --add-host"FQDN:IP" --name accumulo-proxy accumulo-proxy:latest
+```
+
+## Accumulo Instance Configuration
+In order for Thrift to communicate with the Accumulo instance you will need to provide the container with the FQDN and IP of the Accumulo instance and its relevant servers (e.g. tservers) to allow it to resolve the required DNS.
+
+If you are running an Accumulo instance with more than one tserver you should add each tserver's entry with a new `--add-host "FQDN:IP"` entry.

Review comment:
       @keith-turner so that's true in certain environments, this is where I think we have to make a decision about what to support/not support. 
   
   In standard linux generally the docker configuration is fairly close to bare metal.
   
   If you use Windows or in my case Mac generally you run Docker 'technically' inside a VM, therefore when you attach the host network it's still not technically the 'host (physical machine)' network. 
   
   So whilst adding `--network="host"` into the instructions it'll only actually work for a subset of environments, adding the `--add-host` would work for a wider number and also allows for some isolation of resources (maybe a step too far for dev).
   
   Also this all changes again if we look towards any other orchestration tooling such as docker-compose or Kubernetes as both of those have different working configurations which then need different tuning to work.
   
   ---
   
   Given this is starting to creep into environment specific, I might comment on both options in the DOCKER.md and let the caller decide how they want to start their environment, but I'll try and give some hints as to what people may wish to consider.
   
   For now, I don't think many of us are intending Docker to be a simple non-technically orientated mechanism to setup so we can probably get away with giving options for now.




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org