Improving README.md to include Mint mode. #185
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
balamurugana
changed the title
krisis
requested changes
Oct 13, 2017
README.md
Outdated
| @@ -1,125 +1,96 @@ | |||
| # Mint [](https://slack.minio.io) [](https://hub.docker.com/r/minio/mint/) | |||
|
|
|||
| Mint detects overall correctness of Minio server using Minio SDKs, minio client (mc), AWS SDKs, awscli and s3cmd. Use Mint to test Minio server instances for functional correctness. | |||
| Mint is testing framework and system in docker container for Minio server. It runs various correctness, benchmarking and stress tests. Below are SDKs/tools used for correctness tests | |||
There was a problem hiding this comment.
How about?
Mint is a testing framework for Minio object server, available as a docker image. It runs correctness, benchmarking and stress tests. Following are the SDKs/tools used in correctness tests.
README.md
Outdated
|
|
||
| To run Mint image, use the `docker run` command. For example, to run Mint with Minio Play server as test target use the below command | ||
| Mint requires Docker to be installed. For Docker installation follow the steps [here](https://docs.docker.com/engine/installation/linux/docker-ce/ubuntu/). |
There was a problem hiding this comment.
Remove leading space in front of For Docker ...
README.md
Outdated
| To run Mint image, use the `docker run` command. For example, to run Mint with Minio Play server as test target use the below command | ||
| Mint requires Docker to be installed. For Docker installation follow the steps [here](https://docs.docker.com/engine/installation/linux/docker-ce/ubuntu/). | ||
|
|
||
| To run Mint, use the `docker run` command. For example, to run Mint with Minio Play server as test target use below command |
There was a problem hiding this comment.
We can simplify this as,
To run Mint with Minio Play server as test target,
$ docker run -e SERVER_ENDPOINT=play.minio.io:9000 -e ACCESS_KEY=Q3AM3UQ867SPQQA43P2F \
--e SECRET_KEY=zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG -e ENABLE_HTTPS=1 minio/mint:latest
-e SECRET_KEY=zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG -e ENABLE_HTTPS=1 minio/mint
There was a problem hiding this comment.
Yes. Slightly modified the above line as well.
| ``` | ||
|
|
||
| After the tests are run, output is stored in `/mint/log` directory inside the container. You can access these logs via `docker cp` command. For example to store logs to `/tmp/logs` directory on your host, run | ||
|
|
||
| After the tests are run, output is stored in `/mint/log` directory inside the container. To get these logs, use `docker cp` command. For example |
There was a problem hiding this comment.
we can remove this since the command displays this on exit. thoughts?
There was a problem hiding this comment.
I think we can keep it for document completion.
README.md
Outdated
|
|
||
| #### Current tests | ||
| After some hacking on Mint code base, it can be built and run by |
There was a problem hiding this comment.
After making changes to Mint a local docker image can be built by
There was a problem hiding this comment.
Done. with little change
README.md
Outdated
| - minio-js | ||
| - minio-py | ||
| - s3cmd | ||
| Its required to create new directory under [build](https://github.com/minio/mint/tree/master/build) and [run/core](https://github.com/minio/mint/tree/master/run/core) directory and creating `install.sh` which does installation of required tool/SDK. Any build and install time dependencies should be added to [install-packages.list](https://github.com/minio/mint/blob/master/install-packages.list) and build time dependencies added to [remove-packages.list](https://github.com/minio/mint/blob/master/remove-packages.list) for removal for clean Mint docker image. |
There was a problem hiding this comment.
Can we make this a unordered list of things to do?
E.g,
- add install.sh which has commands to be run to install the SDK/tool.
...
nitisht
reviewed
Oct 14, 2017
README.md
Outdated
| - minio-js | ||
| - minio-py | ||
| - s3cmd | ||
| Below is the steps need to be followed |
There was a problem hiding this comment.
It will be better it put it this way -- Below are the steps to be followed
nitisht
reviewed
Oct 14, 2017
nitisht
approved these changes
Oct 14, 2017
krisis
approved these changes
Oct 18, 2017
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.