github.com/deis/deis@v1.13.5-0.20170519182049-1d9e59fbdbfc/tests/fixtures/mock-store/README.md (about)

     1  # Mock S3 storage
     2  
     3  The objective is to provide an S3-compatible service for tests, so a Ceph cluster
     4  is not required. This component uses [mock-s3](https://github.com/jserver/mock-s3).
     5  
     6  ## Usage:
     7  
     8  ```
     9  docker run -p 8888:8888 -e HOST=$COREOS_PRIVATE_IPV4 -v <local directory>:/app/storage deis/mock-store
    10  ```
    11  
    12  *The use of a local directory `(-v <local directory>)` is optional*
    13  
    14  
    15  `mock-s3` does not requires an `ACCESS_KEY` and `SECRET_KEY` (there is no concept of permissions), but this
    16  component will generate both to keep compatibility with `deis-store-gateway`.
    17  
    18  ## Containers
    19  
    20  The mock store component is composed of one container:
    21  
    22  * [mock-store](https://index.docker.io/u/deis/mock-store/) - the blob store gateway,
    23  offering a S3-compatible bucket APIs using the local filesystem as storage.
    24  
    25  ## Usage
    26  
    27  Please consult the [Makefile](Makefile) for current instructions on how to build, test, push,
    28  install, and start **deis/mock-store**.
    29  
    30  Note that changes to **deis/mock-store** will *not* be built automatically by the test suite.
    31  Run `make mock-store` from the tests/ directory to update the Docker image used by tests.
    32  
    33  ## License
    34  
    35  © 2015 Engine Yard, Inc.
    36  
    37  Licensed under the Apache License, Version 2.0 (the "License"); you may
    38  not use this file except in compliance with the License. You may obtain
    39  a copy of the License at <http://www.apache.org/licenses/LICENSE-2.0>
    40  
    41  Unless required by applicable law or agreed to in writing, software
    42  distributed under the License is distributed on an "AS IS" BASIS,
    43  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    44  See the License for the specific language governing permissions and
    45  limitations under the License.