mirror of
https://github.com/minio/docs.git
synced 2025-07-30 07:03:26 +03:00
Alpha Release Work
This commit is contained in:
ravindk89
@ -1,75 +0,0 @@
|
||||
.. _minio-bucket:
|
||||
|
||||
=======
|
||||
Buckets
|
||||
=======
|
||||
|
||||
.. default-domain:: minio
|
||||
|
||||
.. contents:: On This Page
|
||||
:local:
|
||||
:depth: 2
|
||||
|
||||
|
||||
A :ref:`bucket <minio-bucket>` is a folder or storage container that can hold an
|
||||
arbitrary number of :ref:`objects <minio-object>`. Minio buckets provide the
|
||||
same functionality as an Amazon Web Services (AWS) S3 Bucket. The MinIO API is
|
||||
fully compatible with the Amazon S3 API, where applications can seamlessly
|
||||
transition to using the MinIO deployment with minimal code changes.
|
||||
|
||||
Bucket Notifications
|
||||
--------------------
|
||||
|
||||
MinIO Bucket Notifications allow you to automatically publish notifications
|
||||
to one or more configured endpoints when specific events occur in a bucket.
|
||||
|
||||
See :doc:`/minio-features/bucket-notifications` for more information.
|
||||
|
||||
Push Notifications
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
MinIO supports pushing events to the following targets:
|
||||
|
||||
- AMQP
|
||||
- MQTT
|
||||
- Elasticsearch
|
||||
- NSQ
|
||||
- Redis
|
||||
- NATS
|
||||
- PostgreSQL
|
||||
- MySQL
|
||||
- Apache Kafka
|
||||
- Webhooks
|
||||
|
||||
Use the ``mc admin`` utility to configure the MinIO deployment to actively
|
||||
push notifications to each configured target. For more complete documentation,
|
||||
see <logging tbd>
|
||||
|
||||
Listener API
|
||||
~~~~~~~~~~~~
|
||||
|
||||
MinIO provides two routes to listen for events for a given bucket:
|
||||
|
||||
- The ``mc event`` command.
|
||||
- The ``BucketNotification`` API.
|
||||
|
||||
.. todo: Add more information here as its available.
|
||||
|
||||
Write Once Read Many (WORM)
|
||||
---------------------------
|
||||
|
||||
MinIO supports enabling Write-Once Read-Many (WORM) for specific objects
|
||||
in a bucket *or* for all objects in the bucket. Objects with WORM applied
|
||||
are immutable, and can only be deleted if the WORM configuration includes an
|
||||
expiry.
|
||||
|
||||
Configure WORM for Bucket
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
ToDo: Enable, Disable WORM
|
||||
|
||||
Configure WORM for Specific Objects
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
ToDo: Enable, Disable WORM per object
|
||||
|
||||
@ -2,6 +2,8 @@
|
||||
Deployment Topologies
|
||||
=====================
|
||||
|
||||
.. default-domain:: minio
|
||||
|
||||
MinIO supports three deployment topologies:
|
||||
|
||||
.. list-table::
|
||||
@ -25,7 +27,7 @@ MinIO supports three deployment topologies:
|
||||
|
||||
* - :ref:`Active-Active <minio-deployment-active-active>`
|
||||
- Multiple distributed deployments with intra-deployment
|
||||
replication to synchronize :ref:`objects <minio-object>` across
|
||||
replication to synchronize :ref:`objects <objects>` across
|
||||
deployments.
|
||||
|
||||
Active-Active Distributed deployments are ideal for production
|
||||
@ -43,6 +45,7 @@ TBD:
|
||||
- Link to deployment tutorials (kubernetes, bare-metal)
|
||||
|
||||
.. _minio-deployment-distributed:
|
||||
.. _minio-zones:
|
||||
|
||||
Distributed Deployment
|
||||
----------------------
|
||||
@ -51,6 +54,7 @@ TBD:
|
||||
- Add a diagram of a distributed deployment
|
||||
- List the drawbacks (if any)
|
||||
- Link to deployment tutorials (kubernetes, bare-metal)
|
||||
- Discuss horizontal expansion / zones
|
||||
|
||||
.. _minio-deployment-active-active:
|
||||
|
||||
|
||||
@ -4,6 +4,8 @@
|
||||
Erasure Coding
|
||||
==============
|
||||
|
||||
.. default-domain:: minio
|
||||
|
||||
MinIO protects data with per-object, inline erasure coding, which is written in
|
||||
assembly code to deliver the highest performance possible. MinIO uses
|
||||
Reed-Solomon code to stripe objects into `n/2` data and ``n/2`` parity blocks -
|
||||
|
||||
@ -2,6 +2,8 @@
|
||||
Introduction
|
||||
============
|
||||
|
||||
.. default-domain:: minio
|
||||
|
||||
MinIO is a High Performance Object Storage released under Apache License v2.0.
|
||||
It is API compatible with Amazon S3 cloud storage service. Use MinIO to build
|
||||
high performance infrastructure for machine learning, analytics and application
|
||||
@ -10,50 +12,55 @@ data workloads.
|
||||
What Is Object Storage?
|
||||
-----------------------
|
||||
|
||||
Applications create, update, retrieve, and delete data as part of normal
|
||||
operations. MinIO provides a complete solution for managing the storage
|
||||
and access of that data as :ref:`objects <minio-object>`. Applications group
|
||||
objects into one or more :ref:`buckets <minio-bucket>`.
|
||||
.. _objects:
|
||||
|
||||
MinIO is fully compatible with the Amazon Web Services Simple Storage Service
|
||||
(AWS S3) API. Applications using the AWS S3 API can seamlessly transition to
|
||||
using a MinIO deployment for managing their application's object storage with
|
||||
minimal code changes.
|
||||
An :ref:`object <objects>` is binary data, sometimes referred to as a Binary
|
||||
Large OBject (BLOB). Blobs can be images, audio files, spreadsheets, or even
|
||||
binary executable code. Object Storage platforms like MinIO provide dedicated
|
||||
tools and capabilities for storing, retrieving, and searching for blobs.
|
||||
|
||||
Erasure Coding
|
||||
--------------
|
||||
.. _buckets:
|
||||
|
||||
MinIO Erasure Coding guarantees object retrieval as long as the deployment
|
||||
has at least half of its drives operational. Specifically, the deployment
|
||||
can lose `(n/2)-1` drives and still service create, retrieval, update, and
|
||||
delete operations.
|
||||
MinIO Object Storage uses :ref:`buckets <buckets>` to organize objects.
|
||||
A bucket is similar to a folder or directory in a filesystem, where each
|
||||
bucket can hold an arbitrary number of objects. MinIO buckets provide the
|
||||
same functionality as AWS S3 buckets.
|
||||
|
||||
For example, consider a deployment with 12 data drives. MinIO splits the
|
||||
12 drive set into 6 data drives and 6 parity drives. As long as *at least* 7
|
||||
drives are online, the MinIO server can guarantee retrieval of any stored
|
||||
object.
|
||||
For example, consider an application that hosts a web blog. The application
|
||||
needs to store a variety of blobs, including rich multimedia like videos and
|
||||
images. The structure of objects on the MinIO server might look similar to the
|
||||
following:
|
||||
|
||||
For more information on MinIO Erasure Coding, see
|
||||
:ref:`minio-erasure-coding`.
|
||||
.. code-block:: shell
|
||||
|
||||
Bitrot Protection
|
||||
-----------------
|
||||
/ #root
|
||||
/images/
|
||||
2020-01-02-blog-title.png
|
||||
2020-01-03-blog-title.png
|
||||
/videos/
|
||||
2020-01-03-blog-cool-video.mp4
|
||||
/blogs/
|
||||
2020-01-02-blog.md
|
||||
2020-01-03-blog.md
|
||||
/comments/
|
||||
2020-01-02-blog-comments.json
|
||||
2020-01-02-blog-comments.json
|
||||
|
||||
MinIO Bitrot Protection heals objects that have degraded due to
|
||||
disk corruption. When applications request a specific object, MinIO
|
||||
automatically checks for corruption and applies a healing algorithm to
|
||||
reconstruct the object.
|
||||
Deploying MinIO
|
||||
---------------
|
||||
|
||||
For more information on MinIO Bitrot Protection, see
|
||||
:ref:`minio-bitrot-protection`.
|
||||
For Kubernetes clusters, use the MinIO Kubernetes Operator.
|
||||
See :ref:`minio-kubernetes` for more information.
|
||||
|
||||
For bare-metal environments, including private cloud services
|
||||
or containerized environments, install and run the :mc:`minio server` on
|
||||
each host in the MinIO deployment. See :ref:`minio-baremetal` for more
|
||||
information.
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
:titlesonly:
|
||||
|
||||
/introduction/buckets.rst
|
||||
/introduction/objects.rst
|
||||
/introduction/deployment-topologies.rst
|
||||
/introduction/erasure-coding.rst
|
||||
/introduction/bitrot-protection.rst
|
||||
@ -1,15 +0,0 @@
|
||||
.. _minio-object:
|
||||
|
||||
=======
|
||||
Objects
|
||||
=======
|
||||
|
||||
An :ref:`object <minio-object>` is any kind of data with no limit to its
|
||||
size, format, or type. Examples of objects include digital images,
|
||||
text documents, or video files. Applications can store, retrieve, and
|
||||
delete objects from a MinIO deployment.
|
||||
|
||||
MinIO objects provide the same core functionality as an Amazon Web Services (AWS)
|
||||
S3 Object. The MinIO API is fully compatible with the Amazon S3 API,
|
||||
where applications can seamlessly transition to using the MinIO deployment
|
||||
with minimal code changes.
|
||||
Reference in New Issue
Block a user