dev-support/hbase_docker/README.md

   1 <!---
   2 Licensed to the Apache Software Foundation (ASF) under one
   3 or more contributor license agreements.  See the NOTICE file
   4 distributed with this work for additional information
   5 regarding copyright ownership.  The ASF licenses this file
   6 to you under the Apache License, Version 2.0 (the
   7 "License"); you may not use this file except in compliance
   8 with the License.  You may obtain a copy of the License at
   9
  10   http://www.apache.org/licenses/LICENSE-2.0
  11
  12 Unless required by applicable law or agreed to in writing,
  13 software distributed under the License is distributed on an
  14 "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  15 KIND, either express or implied.  See the License for the
  16 specific language governing permissions and limitations
  17 under the License.
  18 -->
  19
  20 # hbase_docker
  21
  22 ## Overview
  23
  24 The Dockerfile in this folder can be used to build a Docker image running
  25 the latest HBase master branch in standalone mode. It does this by setting
  26 up necessary dependencies, checking out the master branch of HBase from
  27 GitHub, and then building HBase. By default, this image will start the HMaster
  28 and launch the HBase shell when run.
  29
  30 ## Usage
  31
  32 1. Ensure that you have a recent version of Docker installed from
  33    [docker.io](http://www.docker.io).
  34 1. Set this folder as your working directory.
  35 1. Type `docker build -t hbase_docker .` to build a Docker image called **hbase_docker**.
  36    This may take 10 minutes or more the first time you run the command since it will
  37    create a Maven repository inside the image as well as checkout the master branch
  38    of HBase.
  39 1. When this completes successfully, you can run `docker run -it hbase_docker`
  40    to access an HBase shell running inside of a container created from the
  41    **hbase_docker** image. Alternatively, you can type `docker run -it hbase_docker
  42    bash` to start a container without a running HMaster. Within this environment,
  43    HBase is built in `/root/hbase-bin`.