cleanup markdown docs across multiple files (#14296)

enable markdown-linter
This commit is contained in:
Harshavardhana
2022-02-11 16:51:25 -08:00
committed by GitHub
parent 2c0f121550
commit e3e0532613
71 changed files with 1023 additions and 595 deletions

View File

@@ -1,18 +1,23 @@
# MinIO Admin Multi-user Quickstart Guide [![Slack](https://slack.min.io/slack?type=svg)](https://slack.min.io)
MinIO supports multiple admin users in addition to default operator credential created during server startup. New admins can be added after server starts up, and server can be configured to deny or allow access to different admin operations for these users. This document explains how to add/remove admin users and modify their access rights.
## Get started
In this document we will explain in detail on how to configure admin users.
### 1. Prerequisites
- Install mc - [MinIO Client Quickstart Guide](https://docs.min.io/docs/minio-client-quickstart-guide.html)
- Install MinIO - [MinIO Quickstart Guide](https://docs.min.io/docs/minio-quickstart-guide)
### 2. Create a new admin user with CreateUser, DeleteUser and ConfigUpdate permissions
Use [`mc admin policy`](https://docs.min.io/docs/minio-admin-complete-guide.html#policies) to create custom admin policies.
Create new canned policy file `adminManageUser.json`. This policy enables admin user to
manage other users.
```json
cat > adminManageUser.json << EOF
{
@@ -43,11 +48,13 @@ EOF
```
Create new canned policy by name `userManager` using `userManager.json` policy file.
```
mc admin policy add myminio userManager adminManageUser.json
```
Create a new admin user `admin1` on MinIO use `mc admin user`.
```
mc admin user add myminio admin1 admin123
```
@@ -61,6 +68,7 @@ mc admin policy set myminio userManager user=admin1
This admin user will then be allowed to perform create/delete user operations via `mc admin user`
### 3. Configure `mc` and create another user user1 with attached policy user1policy
```
mc alias set myminio-admin1 http://localhost:9000 admin1 admin123 --api s3v4
@@ -70,10 +78,13 @@ mc admin policy set myminio-admin1 user1policy user=user1
```
### 4. List of permissions defined for admin operations
#### Config management permissions
- admin:ConfigUpdate
#### User management permissions
- admin:CreateUser
- admin:DeleteUser
- admin:ListUsers
@@ -82,6 +93,7 @@ mc admin policy set myminio-admin1 user1policy user=user1
- admin:GetUser
#### Service management permissions
- admin:ServerInfo
- admin:ServerUpdate
- admin:StorageInfo
@@ -101,6 +113,7 @@ mc admin policy set myminio-admin1 user1policy user=user1
- admin:BandwidthMonitor
#### User/Group management permissions
- admin:AddUserToGroup
- admin:RemoveUserFromGroup
- admin:GetGroup
@@ -109,6 +122,7 @@ mc admin policy set myminio-admin1 user1policy user=user1
- admin:DisableGroup
#### Policy management permissions
- admin:CreatePolicy
- admin:DeletePolicy
- admin:GetPolicy
@@ -116,34 +130,42 @@ mc admin policy set myminio-admin1 user1policy user=user1
- admin:ListUserPolicies
#### Heal management permissions
- admin:Heal
#### Service account management permissions
- admin:CreateServiceAccount
- admin:UpdateServiceAccount
- admin:RemoveServiceAccount
- admin:ListServiceAccounts
#### Bucket quota management permissions
- admin:SetBucketQuota
- admin:GetBucketQuota
#### Bucket target management permissions
- admin:SetBucketTarget
- admin:GetBucketTarget
#### Remote tier management permissions
- admin:SetTier
- admin:ListTier
#### Give full admin permissions
- admin:*
### 5. Using an external IDP for admin users
Admin users can also be externally managed by an IDP by configuring admin policy with
special permissions listed above. Follow [MinIO STS Quickstart Guide](https://docs.min.io/docs/minio-sts-quickstart-guide) to manage users with an IDP.
## Explore Further
- [MinIO Client Complete Guide](https://docs.min.io/docs/minio-client-complete-guide)
- [MinIO STS Quickstart Guide](https://docs.min.io/docs/minio-sts-quickstart-guide)
- [MinIO Admin Complete Guide](https://docs.min.io/docs/minio-admin-complete-guide.html)