volmasoft commented on a change in pull request #20: URL: https://github.com/apache/accumulo-proxy/pull/20#discussion_r417546058
########## File path: DOCKER.md ########## @@ -0,0 +1,122 @@ +<!-- +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 +This documentation covers how to stand up [accumulo-proxy](https://github.com/apache/accumulo-proxy/) within a Docker container. + +The guide covers: +* Building the image +* Configuring the `proxy.properties` file +* Selecting an appropriate networking choice +* Starting and stopping the container +* Basic troubleshooting tips + +It is not recommended using this guide for a production instance of accumulo-proxy at this time. + +## Build the image using +Invoke the docker build command to create a container image. +```commandline +docker build -t accumulo-proxy:latest . +``` + +## Default Configuration and Quickstart +By default, the container image expects the following to be true: +1. Your Accumulo instance name is "myinstance" +2. Your ZooKeeper is available (and reachable from the container) at localhost:2181 + +You can start the proxy using: +```commandline +docker run --rm -d -p 42424:42424 --network="host" --name accumulo-proxy accumulo-proxy:latest; +``` + +## 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 --network="host" --name accumulo-proxy accumulo-proxy:latest +``` + +## Networking configuration +Container networking can be a very specialised subject therefore we document two common practices that should cover the majority of use cases for development. + +The proxy container must be able to access both Accumulo and ZooKeeper. + +The ZooKeeper location can be configured in the `conf/proxy.properties` file, so you can override this to an acceptable value (see "Custom proxy.properties" section) + +In order to communicate with Accumulo the container will need to be able to resolve the FQDN that the servers have registered in ZooKeeper. If using [fluo-uno](https://github.com/apache/fluo-uno) this is very likely the hostname of your development environment. We'll call this my.host.com and IP 192.168.0.1 for the rest of this document. + +### Host networking + +Host networking is the simplest mechanism but generally only works for linux hosts where docker has been installed on 'bare metal' e.g. through an RPM. + +You can test if this will work for you by executing the following: +```commandline +# Start the accumulo-proxy container and enter it +docker run -it --rm -p 42424:42424 --network="host" --name accumulo-proxy accumulo-proxy:latest bash; + +# Install telnet and verify if you can connect to my.host.com:9995 +apt-get update && apt-get install telnet; +telnet my.host.com 9995 Review comment: The old adage of "you learn something new every day" still rings true. I've updated the latest commit to use your approach, it means there's less faffing about with installing telnet 👍 ---------------------------------------------------------------- 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: us...@infra.apache.org
