minio/docs
1
0
Fork 0
mirror of https://github.com/minio/docs.git synced 2025-08-08 01:43:18 +03:00
Code Activity

Alpha Release Work

Browse Source
This commit is contained in:
ravindk89
2020-09-29 18:57:09 -04:00
parent d2657ec80a
commit e3e9caf593
76 changed files with 1115 additions and 1152 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
source/minio-cli/minio-mc-admin.rst
View File

@@ -4,7 +4,7 @@ MinIO Admin (``mc admin``)
.. default-domain:: minio
.. contents:: On This Page
.. contents:: Table of Contents
:local:
:depth: 1
@@ -62,8 +62,8 @@ Ensure that the host machine has :command:`mc`
security best practices for your operating system for inputting sensitive
information on the command line.
Use the :subcommand:`mc alias add` command to add the
deployment to the :command:`mc` configuration.
Use the :mc-cmd:`mc alias set` command to add the
deployment to the :program:`mc` configuration.
.. code-block:: shell
:class: copyable
@@ -111,7 +111,7 @@ The command has the following syntax:
If the specified ``<ALIAS>`` corresponds to a distributed MinIO deployment, the
command returns information for each MinIO server in the deployment. Use
:subcommand:`mc alias add` to list the currently configured aliases and their
:subcommand:`mc alias set` to list the currently configured aliases and their
corresponding endpoints.
*Display MinIO Server Information*
@@ -148,7 +148,7 @@ The command has the following syntax:
If the specified ``<ALIAS>`` corresponds to a distributed MinIO deployment, the
command adds the policy to each MinIO server in the deployment. Use
:subcommand:`mc alias add` to list the currently configured aliases and their
:subcommand:`mc alias set` to list the currently configured aliases and their
corresponding endpoints.
MinIO servers include the following canned policies:

2
source/minio-cli/minio-mc-admin/mc-admin-bucket-quota.rst
View File

@@ -4,7 +4,7 @@
.. default-domain:: minio
.. contents:: On This Page
.. contents:: Table of Contents
:local:
:depth: 2

2
source/minio-cli/minio-mc-admin/mc-admin-bucket-remote.rst
View File

@@ -4,7 +4,7 @@
.. default-domain:: minio
.. contents:: On This Page
.. contents:: Table of Contents
:local:
:depth: 2

2
source/minio-cli/minio-mc-admin/mc-admin-console.rst
View File

@@ -4,7 +4,7 @@
.. default-domain:: minio
.. contents:: On This Page
.. contents:: Table of Contents
:local:
:depth: 2

2
source/minio-cli/minio-mc-admin/mc-admin-groups.rst
View File

@@ -4,7 +4,7 @@
.. default-domain:: minio
.. contents:: On This Page
.. contents:: Table of Contents
:local:
:depth: 2

2
source/minio-cli/minio-mc-admin/mc-admin-heal.rst
View File

@@ -4,7 +4,7 @@
.. default-domain:: minio
.. contents:: On This Page
.. contents:: Table of Contents
:local:
:depth: 2

2
source/minio-cli/minio-mc-admin/mc-admin-info.rst
View File

@@ -4,7 +4,7 @@
.. default-domain:: minio
.. contents:: On This Page
.. contents:: Table of Contents
:local:
:depth: 1

2
source/minio-cli/minio-mc-admin/mc-admin-kms.rst
View File

@@ -4,7 +4,7 @@
.. default-domain:: minio
.. contents:: On This Page
.. contents:: Table of Contents
:local:
:depth: 2

2
source/minio-cli/minio-mc-admin/mc-admin-obd.rst
View File

@@ -4,7 +4,7 @@
.. default-domain:: minio
.. contents:: On This Page
.. contents:: Table of Contents
:local:
:depth: 2

2
source/minio-cli/minio-mc-admin/mc-admin-policy.rst
View File

@@ -4,7 +4,7 @@
.. default-domain:: minio
.. contents:: On This Page
.. contents:: Table of Contents
:local:
:depth: 2

2
source/minio-cli/minio-mc-admin/mc-admin-profile.rst
View File

@@ -4,7 +4,7 @@
.. default-domain:: minio
.. contents:: On This Page
.. contents:: Table of Contents
:local:
:depth: 2

2
source/minio-cli/minio-mc-admin/mc-admin-prometheus.rst
View File

@@ -4,7 +4,7 @@
.. default-domain:: minio
.. contents:: On This Page
.. contents:: Table of Contents
:local:
:depth: 2

2
source/minio-cli/minio-mc-admin/mc-admin-service.rst
View File

@@ -4,7 +4,7 @@
.. default-domain:: minio
.. contents:: On This Page
.. contents:: Table of Contents
:local:
:depth: 2

2
source/minio-cli/minio-mc-admin/mc-admin-top.rst
View File

@@ -4,7 +4,7 @@
.. default-domain:: minio
.. contents:: On This Page
.. contents:: Table of Contents
:local:
:depth: 2

2
source/minio-cli/minio-mc-admin/mc-admin-trace.rst
View File

@@ -4,7 +4,7 @@
.. default-domain:: minio
.. contents:: On This Page
.. contents:: Table of Contents
:local:
:depth: 2

2
source/minio-cli/minio-mc-admin/mc-admin-update.rst
View File

@@ -4,7 +4,7 @@
.. default-domain:: minio
.. contents:: On This Page
.. contents:: Table of Contents
:local:
:depth: 1

2
source/minio-cli/minio-mc-admin/mc-admin-user.rst
View File

@@ -4,7 +4,7 @@
.. default-domain:: minio
.. contents:: On This Page
.. contents:: Table of Contents
:local:
:depth: 2

53
source/minio-cli/minio-mc.rst
View File

@@ -1,10 +1,10 @@
=================
MinIO Client (mc)
=================
=====================
MinIO Client (``mc``)
=====================
.. default-domain:: minio
.. contents:: On This Page
.. contents:: Table of Contents
:local:
:depth: 1
@@ -21,14 +21,16 @@ support for both filesystems and Amazon S3-compatible cloud storage services
mc [FLAGS] COMMAND [COMMAND FLAGS | -h] [ARGUMENTS...] ALIAS
.. _mc-install:
Quickstart
----------
1) Install ``mc``
~~~~~~~~~~~~~~~~~
Ensure that the host machine has :mc-cmd:`mc`
:ref:`installed <mc-install>` prior to starting this procedure:
Install the :program:`mc` command line tool onto the host machine. Click
the tab that corresponds to the host machine operating system or environment:
.. include:: /includes/minio-mc-installation.rst
@@ -43,27 +45,25 @@ Ensure that the host machine has :mc-cmd:`mc`
security best practices for your operating system for inputting sensitive
information on the command line.
Use the :mc-cmd:`mc alias add` command to add an Amazon S3-compatible host
Use the :mc-cmd:`mc alias set` command to add an Amazon S3-compatible service
to the :mc-cmd:`mc` :ref:`configuration <mc-configuration>`.
.. code-block:: shell
:class: copyable
bash +o history
mc alias add ALIAS ENDPOINT ACCESS_KEY SECRET_KEY --api [S3v2|S3v4]
mc alias set ALIAS HOSTNAME ACCESS_KEY SECRET_KEY
bash -o history
- Replace ``ALIAS`` with a name to associate to the S3 service.
:mc-cmd:`mc` commands typically require ``ALIAS`` as an argument for
identifying which S3 service to execute against.
- Replace ``ENDPOINT`` with the URL endpoint of the S3 service.
- Replace ``HOSTNAME`` with the URL endpoint or IP address of the S3 service.
- Replace ``ACCESS_KEY`` and ``SECRET_KEY`` with the access and secret
keys for a user on the S3 service.
- The ``--api`` flag is optional and defaults to ``S3v4`` if ommitted.
Replace each argument with the required values. Specifying only the
``mc config host add`` command starts an input prompt for entering the
required values.
@@ -77,21 +77,21 @@ Each of the following tabs contains a provider-specific example:
.. code-block:: shell
:class: copyable
mc alias add myminio https://minioserver.example.net ACCESS_KEY SECRET KEY
mc alias set myminio https://minioserver.example.net ACCESS_KEY SECRET KEY
.. tab:: AWS S3 Storage
.. code-block:: shell
:class: copyable
mc alias add myS3 https://s3.amazon.com/endpoint ACCESS_KEY SECRET KEY
mc alias set myS3 https://s3.amazon.com/endpoint ACCESS_KEY SECRET KEY
.. tab:: Google Cloud Storage
.. code-block:: shell
:class: copyable
mc alias add myGCS https://storage.googleapis.com/endpoint ACCESS_KEY SECRET KEY
mc alias set myGCS https://storage.googleapis.com/endpoint ACCESS_KEY SECRET KEY
3) Test the Connection
~~~~~~~~~~~~~~~~~~~~~~
@@ -118,6 +118,8 @@ unsuccessful, check each of the following:
for more information on user access permissions. For other S3-compatible
services, defer to the documentation for that service.
.. _minio-mc-commands:
Command Quick Reference
-----------------------
@@ -294,27 +296,6 @@ The following list describes each possible file path location in the order
You can use the ``--config-dir``
.. _mc-install:
Installation
------------
.. include:: /includes/minio-mc-installation.rst
:mc:`mc` includes a default :mc-cmd:`alias <mc alias>` for the
https://play.min.io MinIO deployment. If the host machine has internet access,
you can use the ``play`` alias for testing and development purposes. For
example, the following lists all buckets on ``https://play.min.io``:
.. code-block:: shell
:class: copyable
mc ls play
The ``play`` MinIO deployment provides a simple sandbox for testing core S3
functionality. Any S3-compatible tool can view and interact with data on
``play``. Any data stored on ``play`` is public-facing and modifyable.
.. _minio-mc-global-options:
Global Options
@@ -322,6 +303,8 @@ Global Options
.. program:: mc
All :ref:`commands <minio-mc-commands>` support the following global options:
.. option:: --debug
Enables verbose output to the console.

122
source/minio-cli/minio-mc/mc-alias.rst
View File

@@ -4,9 +4,9 @@
.. default-domain:: minio
.. contents:: On This Page
.. contents:: Table of Contents
:local:
:depth: 1
:depth: 2
.. mc:: mc alias
@@ -28,43 +28,77 @@ Using :mc-cmd:`mc alias` to add or remove an S3-compatible host is equivalent
to manually editing entries in the :program:`mc`
:ref:`configuration file <mc-configuration>`.
.. important::
S3 Access Control and Limitations
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:mc-cmd:`mc alias` requires specifying an access key and corresponding
secret key for a user on the S3-compatible host. :program:`mc` can
only perform operations on that host for which the user has explicit
permission. If the specified user cannot perform an action or access
a resource on the S3 host, :program:`mc` inherits those restrictions.
:mc-cmd:`mc alias` requires specifying an access key and corresponding secret
key for a user on the S3-compatible host. :program:`mc` can only perform
operations on that host for which the user has explicit permission. If the
specified user cannot perform an action or access a resource on the S3 host,
:program:`mc` inherits those restrictions.
Quick Reference
---------------
For more information on MinIO Access Control, see
:ref:`minio-auth-authz-overview`.
:mc-cmd:`mc alias add ALIAS HOSTNAME ACCESSKEY SECRETKEY <mc alias add>`
Adds the specified S3-compatible host to the
:program:`mc` :ref:`configuration file <mc-configuration>`.
:program:`mc` commands can access the host using the
specified ``ALIAS``.
For more complete documentation on S3 Access Control, see
:s3-docs:`Amazon S3 Security <security.html>`.
:mc-cmd:`mc alias remove ALIAS <mc alias remove>`
Removes the S3-compatible host associated to the specified alias from the
:program:`mc` :ref:`configuration file <mc-configuration>`.
For all other S3-compatible services, defer to the documentation for that
service.
Common Operations
-----------------
Add an S3-Compatible Service
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc-cmd:`mc alias set` to add an S3-compatible service for use with
:program:`mc`:
.. code-block:: shell
:class: copyable
mc alias set ALIAS HOSTNAME ACCESSKEY SECRETKEY
- Replace ``ALIAS`` with the name of the alias to associate to the S3-compatible service.
- Replace ``HOSTNAME`` with the hostname or IP address of the S3-compatible service.
- Replace ``ACCESSKEY`` and ``SECRETKEY`` with the access and secret key for a
user on the S3-compatible service.
Remove a Configured S3-Compatible Service
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc-cmd:`mc alias remove` to remove an S3-compatible alias from the
:program:`mc` configuration:
.. code-block:: shell
:class: copyable
mc alias remove ALIAS
- Replace ``ALIAS`` with the name of the S3-compatible service to remove.
Use :mc-cmd:`mc alias list` to list the currently configured S3-compatible
services.
List Configured S3-Compatible Services
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc-cmd:`mc alias list` to list all configured S3-compatible aliases:
.. code-block:: shell
:class: copyable
mc alias list
:mc-cmd:`mc alias list <mc alias list>`
Lists all S3-compatible hosts and aliases in the :program:`mc`
:ref:`configuration file <mc-configuration>`.
Syntax
------
:mc-cmd:`~mc alias` has the following syntax:
.. code-block:: shell
mc alias COMMAND [COMMAND FLAGS | -h ] [ARGUMENTS]
:mc-cmd:`~mc alias` supports the following commands:
.. mc-cmd:: add, a
.. mc-cmd:: set, s
:fullpath:
Adds a new S3-compatible host to the configuration file. The command
has the following syntax:
@@ -72,9 +106,9 @@ Syntax
.. code-block:: shell
:class: copyable
mc alias add ALIAS HOSTNAME ACCESS_KEY SECRET_KEY --api [S3v2|S3v4]
mc alias set ALIAS HOSTNAME ACCESS_KEY SECRET_KEY --api [S3v2|S3v4]
:mc-cmd:`mc alias add` supports the following arguments:
:mc-cmd:`mc alias set` supports the following arguments:
.. mc-cmd:: ALIAS
@@ -111,6 +145,7 @@ Syntax
.. mc-cmd:: remove, rm
:fullpath:
Removes a host entry from the configuration file. The command has the
following syntax:
@@ -121,6 +156,7 @@ Syntax
mc alias remove ALIAS
.. mc-cmd:: list, ls
:fullpath:
Lists all hosts in the configuration file. The command has the following
syntax:
@@ -130,9 +166,6 @@ Syntax
mc alias list
Behavior
--------
Examples
--------
@@ -142,21 +175,4 @@ Add a New S3 Service Alias
.. code-block:: shell
:class: copyable
mc alias add myminio https://myminio.example.net myminioaccesskey myminiosecretkey
Remove an Existing S3 Service Alias
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: shell
:class: copyable
mc alias remove myminio
List All Configured S3 Service Aliases
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: shell
:class: copyable
mc alias list
mc alias set myminio https://myminio.example.net myminioaccesskey myminiosecretkey

2
source/minio-cli/minio-mc/mc-cat.rst
View File

@@ -4,7 +4,7 @@
.. default-domain:: minio
.. contents:: On This Page
.. contents:: Table of Contents
:local:
:depth: 1

2
source/minio-cli/minio-mc/mc-cp.rst
View File

@@ -4,7 +4,7 @@
.. default-domain:: minio
.. contents:: On This Page
.. contents:: Table of Contents
:local:
:depth: 1

2
source/minio-cli/minio-mc/mc-diff.rst
View File

@@ -4,7 +4,7 @@
.. default-domain:: minio
.. contents:: On This Page
.. contents:: Table of Contents
:local:
:depth: 1

2
source/minio-cli/minio-mc/mc-encrypt.rst
View File

@@ -4,7 +4,7 @@
.. default-domain:: minio
.. contents:: On This Page
.. contents:: Table of Contents
:local:
:depth: 1

2
source/minio-cli/minio-mc/mc-event.rst
View File

@@ -4,7 +4,7 @@
.. default-domain:: minio
.. contents:: On This Page
.. contents:: Table of Contents
:local:
:depth: 1

2
source/minio-cli/minio-mc/mc-find.rst
View File

@@ -4,7 +4,7 @@
.. default-domain:: minio
.. contents:: On This Page
.. contents:: Table of Contents
:local:
:depth: 1

2
source/minio-cli/minio-mc/mc-head.rst
View File

@@ -4,7 +4,7 @@
.. default-domain:: minio
.. contents:: On This Page
.. contents:: Table of Contents
:local:
:depth: 1

2
source/minio-cli/minio-mc/mc-ilm.rst
View File

@@ -4,7 +4,7 @@
.. default-domain:: minio
.. contents:: On This Page
.. contents:: Table of Contents
:local:
:depth: 1

2
source/minio-cli/minio-mc/mc-legalhold.rst
View File

@@ -4,7 +4,7 @@
.. default-domain:: minio
.. contents:: On This Page
.. contents:: Table of Contents
:local:
:depth: 2

2
source/minio-cli/minio-mc/mc-lock.rst
View File

@@ -4,7 +4,7 @@
.. default-domain:: minio
.. contents:: On This Page
.. contents:: Table of Contents
:local:
:depth: 1

2
source/minio-cli/minio-mc/mc-ls.rst
View File

@@ -4,7 +4,7 @@
.. default-domain:: minio
.. contents:: On This Page
.. contents:: Table of Contents
:local:
:depth: 1

2
source/minio-cli/minio-mc/mc-mb.rst
View File

@@ -4,7 +4,7 @@
.. default-domain:: minio
.. contents:: On This Page
.. contents:: Table of Contents
:local:
:depth: 1

2
source/minio-cli/minio-mc/mc-mirror.rst
View File

@@ -4,7 +4,7 @@
.. default-domain:: minio
.. contents:: On This Page
.. contents:: Table of Contents
:local:
:depth: 1

2
source/minio-cli/minio-mc/mc-mv.rst
View File

@@ -4,7 +4,7 @@
.. default-domain:: minio
.. contents:: On This Page
.. contents:: Table of Contents
:local:
:depth: 1

2
source/minio-cli/minio-mc/mc-policy.rst
View File

@@ -4,7 +4,7 @@
.. default-domain:: minio
.. contents:: On This Page
.. contents:: Table of Contents
:local:
:depth: 1

2
source/minio-cli/minio-mc/mc-rb.rst
View File

@@ -4,7 +4,7 @@
.. default-domain:: minio
.. contents:: On This Page
.. contents:: Table of Contents
:local:
:depth: 1

2
source/minio-cli/minio-mc/mc-retention.rst
View File

@@ -4,7 +4,7 @@
.. default-domain:: minio
.. contents:: On This Page
.. contents:: Table of Contents
:local:
:depth: 2

2
source/minio-cli/minio-mc/mc-rm.rst
View File

@@ -4,7 +4,7 @@
.. default-domain:: minio
.. contents:: On This Page
.. contents:: Table of Contents
:local:
:depth: 1

2
source/minio-cli/minio-mc/mc-share.rst
View File

@@ -4,7 +4,7 @@
.. default-domain:: minio
.. contents:: On This Page
.. contents:: Table of Contents
:local:
:depth: 1

2
source/minio-cli/minio-mc/mc-sql.rst
View File

@@ -4,7 +4,7 @@
.. default-domain:: minio
.. contents:: On This Page
.. contents:: Table of Contents
:local:
:depth: 1

2
source/minio-cli/minio-mc/mc-stat.rst
View File

@@ -4,7 +4,7 @@
.. default-domain:: minio
.. contents:: On This Page
.. contents:: Table of Contents
:local:
:depth: 1

2
source/minio-cli/minio-mc/mc-tag.rst
View File

@@ -4,7 +4,7 @@
.. default-domain:: minio
.. contents:: On This Page
.. contents:: Table of Contents
:local:
:depth: 2

2
source/minio-cli/minio-mc/mc-tree.rst
View File

@@ -4,7 +4,7 @@
.. default-domain:: minio
.. contents:: On This Page
.. contents:: Table of Contents
:local:
:depth: 1

2
source/minio-cli/minio-mc/mc-update.rst
View File

@@ -4,7 +4,7 @@
.. default-domain:: minio
.. contents:: On This Page
.. contents:: Table of Contents
:local:
:depth: 1

2
source/minio-cli/minio-mc/mc-version.rst
View File

@@ -4,7 +4,7 @@
.. default-domain:: minio
.. contents:: On This Page
.. contents:: Table of Contents
:local:
:depth: 2

2
source/minio-cli/minio-mc/mc-watch.rst
View File

@@ -4,7 +4,7 @@
.. default-domain:: minio
.. contents:: On This Page
.. contents:: Table of Contents
:local:
:depth: 1