-
Notifications
You must be signed in to change notification settings - Fork 23
doc(README.md): modifying the readme to reflect beta status #84
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
64dd744
doc(README.md): modifying the readme to reflect beta status
bd99603
doc(README.md): add space after comma
c33e30a
doc(README.md): mention that minio is s3 compatible
7b70b29
doc(README.md): mention components that depend on minio
e6633a6
doc(README.md): adopt deis introduction text from docs
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,99 +1,82 @@ | ||
| # Deis Minio v2 | ||
|
|
||
| [](https://travis-ci.org/deis/minio) [](http://goreportcard.com/report/deis/minio) [](https://quay.io/repository/deisci/minio) | ||
| [](https://travis-ci.org/deis/minio) | ||
| [](http://goreportcard.com/report/deis/minio) | ||
| [](https://quay.io/repository/deisci/minio) | ||
|
|
||
| Deis (pronounced DAY-iss) is an open source PaaS that makes it easy to deploy and manage | ||
| applications on your own servers. Deis builds on [Kubernetes](http://kubernetes.io/) to provide | ||
| a lightweight, [Heroku-inspired](http://heroku.com) workflow. | ||
| Deis (pronounced DAY-iss) Workflow is an open source Platform as a Service (PaaS) that adds a developer-friendly layer to any [Kubernetes](http://kubernetes.io) cluster, making it easy to deploy and manage applications on your own servers. | ||
|
|
||
| ## Work in Progress | ||
| For more information about the Deis workflow, please visit the main project page at https://github.com/deis/workflow. | ||
|
|
||
|  | ||
| ## Beta Status | ||
|
|
||
| Deis Minio v2 is changing quickly. Your feedback and participation are more than welcome, but be | ||
| aware that this project is considered a work in progress. | ||
| This Deis component is currently in beta status, and we welcome your input! If you have feedback, please submit an [issue][issues]. If you'd like to participate in development, please read the "Development" section below and submit a [pull request][prs]. | ||
|
|
||
| # About | ||
|
|
||
| This package provides a [Minio](http://minio.io) S3-compatible object storage system on Kubernetes. It can be used as a [Deis](https://deis.com/) component to provide object storage for various other components, but it is flexible enough to be run anywhere else. | ||
| The Deis minio component provides an [S3 API][s3-api] compatible object storage server, based on [Minio](http://minio.io), that can be run on Kubernetes. It's intended for use within the [Deis v2 platform](http://docs-v2.readthedocs.org/en/latest/) as an object storage server, but it's flexible enough to be run as a standalone pod on any Kubernetes cluster. | ||
|
|
||
| We provide it as a Docker container, and also provide the following manifests to run it inside [Kubernetes](http://kubernetes.io/): | ||
| Note that in the default [Helm chart for the Deis platform](https://github.com/deis/charts/tree/master/deis-dev), this component is used as a storage location for the following components: | ||
|
|
||
| - A [replication controller](http://kubernetes.io/v1.1/docs/user-guide/replication-controller.html) to run a server on a single pod | ||
| - A [service](http://kubernetes.io/v1.1/docs/user-guide/services.html) to run in front of the replication controller | ||
| - [Secret](http://kubernetes.io/v1.1/docs/user-guide/secrets.html)s for: | ||
| - User credentials | ||
| - Admin credentials | ||
| - SSL (note that the current version does not run with SSL enabled, however) | ||
| - [deis/postgres](https://github.com/deis/postgres) | ||
| - [deis/registry](https://github.com/deis/registry) | ||
| - [deis/builder](https://github.com/deis/builder) | ||
|
|
||
| Note: this component currently does not offer persistent storage from the Docker container. | ||
| Also note that we aren't currently providing this component with any kind of persistent storage, but it may work with [persistent volumes](http://kubernetes.io/docs/user-guide/volumes/). | ||
|
|
||
| # Hacking Minio | ||
| # Development | ||
|
|
||
| First, install [helm](http://helm.sh) and [boot up a kubernetes cluster][install-k8s]. Next, add the | ||
| `deis` repository to your chart list: | ||
| The Deis project welcomes contributions from all developers. The high level process for development matches many other open source projects. See below for an outline. | ||
|
|
||
| ```console | ||
| $ helm repo add deis https://github.com/deis/charts | ||
| ``` | ||
| * Fork this repository | ||
| * Make your changes | ||
| * Submit a [pull request][prs] (PR) to this repository with your changes, and unit tests whenever possible. | ||
| * If your PR fixes any [issues][issues], make sure you write Fixes #1234 in your PR description (where #1234 is the number of the issue you're closing) | ||
| * The Deis core contributors will review your code. After each of them sign off on your code, they'll label your PR with `LGTM1` and `LGTM2` (respectively). Once that happens, you may merge. | ||
|
|
||
| Then, install the Deis chart! | ||
| ## Docker Based Development Environment | ||
|
|
||
| ```console | ||
| $ helm install deis/deis | ||
| ``` | ||
| The preferred environment for development uses the [`go-dev` Docker image](https://github.com/deis/docker-go-dev). The tools described in this section are used to build, test, package and release each version of Deis. | ||
|
|
||
| The chart will install the entire Deis platform onto Kubernetes. You can monitor all the pods that it installs by running: | ||
| To use it yourself, you must have [make](https://www.gnu.org/software/make/) installed and Docker installed and running on your local development machine. | ||
|
|
||
| ```console | ||
| $ kubectl get pods --namespace=deis | ||
| ``` | ||
| If you don't have Docker installed, please go to https://www.docker.com/ to install it. | ||
|
|
||
| Once this is done, SSH into a Kubernetes minion, and run the following: | ||
| After you have those dependencies, build your code with `make build` and execute unit tests with `make test`. | ||
|
|
||
| ``` | ||
| $ curl -sSL http://deis.io/deis-cli/install.sh | sh | ||
| $ sudo mv deis /bin | ||
| $ kubectl get service deis-workflow | ||
| $ deis register 10.247.59.157 # or the appropriate CLUSTER_IP | ||
| $ ssh-keygen -t rsa -b 4096 -C "your_email@example.com" | ||
| $ eval $(ssh-agent) && ssh-add ~/.ssh/id_rsa | ||
| $ deis keys:add ~/.ssh/id_rsa.pub | ||
| $ deis create --no-remote | ||
| Creating Application... done, created madras-radiator | ||
| $ deis pull deis/example-go -a madras-radiator | ||
| Creating build... ..o | ||
| ``` | ||
| ## Native Go Development Environment | ||
|
|
||
| If you want to hack on a new feature, re-compile your code, then rebuild the `deis/minio` image and push it to a Docker registry. The `$DEIS_REGISTRY` environment variable must point to a registry accessible to your Kubernetes cluster. If you're using a locally hosted Docker registry, you may need to configure the Docker engines on your Kubernetes nodes to allow `--insecure-registry 192.168.0.0/16` (or the appropriate address range). | ||
| You can also use the standard go toolchain to build and test if you prefer. To do so, you'll need [glide](https://github.com/Masterminds/glide) 0.9 or above and [Go](http://golang.org/) 1.6 or above installed. | ||
|
|
||
| ```console | ||
| $ make build docker-push | ||
| ``` | ||
| After you have those dependencies, you can build and unit-test your code with `go build` and `go test $(glide nv)`, respectively. | ||
|
|
||
| (note that `docker-push` runs `docker-build` implicitly) | ||
| Note that you will not be able to build or push Docker images using this method of development. | ||
|
|
||
| Next, you'll want to remove the `deis-minio` [replication controller](http://kubernetes.io/v1.1/docs/user-guide/replication-controller.html) and re-create it to run your new image. | ||
|
|
||
| ```console | ||
| make kube-clean kube-rc | ||
| ``` | ||
| ## Testing | ||
|
|
||
| ## Installation | ||
| The Deis project requires that as much code as possible is unit tested, but the core contributors also recognize that some code must be tested at a higher level (functional or integration tests, for example). | ||
|
|
||
| The following steps assume that you have the [Docker CLI](https://docs.docker.com/) and [Kubernetes CLI](http://kubernetes.io/v1.1/docs/user-guide/kubectl-overview.html) installed and correctly configured. | ||
| The [end-to-end tests](https://github.com/deis/workflow-e2e) repository has our integration tests. Additionally, the core contributors and members of the community also regularly [dogfood](https://en.wikipedia.org/wiki/Eating_your_own_dog_food) the platform. | ||
|
|
||
| ``` | ||
| make deploy kube-service | ||
| ``` | ||
| ## Running End-to-End Tests | ||
|
|
||
| Please see [README.md](https://github.com/deis/workflow-e2e/blob/master/README.md) on the end-to-end tests reposotory for instructions on how to set up your testing environment and run the tests. | ||
|
|
||
| ## Dogfooding | ||
|
|
||
| Please follow the instructions on the [official Deis docs](http://docs-v2.readthedocs.org/en/latest/installing-workflow/installing-deis-workflow/) to install and configure your Deis cluster and all related tools, and deploy and configure an app on Deis. | ||
|
|
||
| ## License | ||
|
|
||
| Copyright 2013, 2014, 2015 Engine Yard, Inc. | ||
| Copyright 2013, 2014, 2015, 2016 Engine Yard, Inc. | ||
|
|
||
| Licensed 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. | ||
|
|
||
|
|
||
| [install-k8s]: http://kubernetes.io/gettingstarted/ | ||
| [s3-api]: http://docs.aws.amazon.com/AmazonS3/latest/API/APIRest.html | ||
| [issues]: https://github.com/deis/minio/issues | ||
| [prs]: https://github.com/deis/minio/pulls | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Before this it's better we mention. Minio backs deis-registry and builder
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also database ??
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed in 7b70b29