minio/pkg/madmin
Nitish Tiwari 42633748db
Update madmin package to return storage class parity (#5387)
After the addition of Storage Class support, readQuorum
and writeQuorum are decided on a per object basis, instead
of deployment wide static quorums.

This PR updates madmin api to remove readQuorum/writeQuorum
and add Standard storage class and reduced redundancy storage
class parity as return values. Since these parity values are
used to decide the quorum for each object.

Fixes #5378
2018-01-12 07:52:52 +05:30
..
examples Add disksUnavailable healStatus const (#3990) 2017-03-31 17:55:15 -07:00
API.md Update madmin package to return storage class parity (#5387) 2018-01-12 07:52:52 +05:30
README.md Update madmin package to return storage class parity (#5387) 2018-01-12 07:52:52 +05:30
api-error-response.go admin: Add service Set Credentials API (#3580) 2017-01-17 14:25:59 -08:00
api.go Remove redirectHeaders method (#5120) 2017-11-01 12:43:13 +05:30
api_test.go admin: Add missing madmin examples and API docs. (#3483) 2016-12-20 18:49:48 -08:00
config-commands.go admin: Set Config returns errSet and errMsg (#3822) 2017-03-03 02:53:48 -08:00
constants.go admin: Add missing madmin examples and API docs. (#3483) 2016-12-20 18:49:48 -08:00
generic-commands.go madmin: Do not require SSL to set credentials (#3879) 2017-03-09 14:08:33 -08:00
heal-commands.go Remove healing of incomplete multipart uploads (#5390) 2018-01-11 15:07:43 -08:00
info-commands.go Update madmin package to return storage class parity (#5387) 2018-01-12 07:52:52 +05:30
lock-commands.go remove all dead codes (#5019) 2017-10-05 12:25:45 -07:00
lock-commands_test.go Implement list, clear locks REST API w/ pkg/madmin support (#3491) 2017-01-03 23:39:22 -08:00
service-commands.go admin: Move SetCredentials from Service to Generic (#3805) 2017-02-25 11:06:08 -08:00
utils.go admin: Add service Set Credentials API (#3580) 2017-01-17 14:25:59 -08:00

README.md

Minio Admin Library. Slack

The Minio Admin Golang Client SDK provides APIs to manage Minio services.

This quickstart guide will show you how to install the Minio Admin client SDK, connect to Minio admin service, and provide a walkthrough of a simple file uploader.

This document assumes that you have a working Golang setup.

Download from Github


go get -u github.com/minio/minio/pkg/madmin

Initialize Minio Admin Client

You need four items to connect to Minio admin services.

Parameter Description
endpoint URL to object storage service.
accessKeyID Access key is the user ID that uniquely identifies your account.
secretAccessKey Secret key is the password to your account.
secure Set this value to 'true' to enable secure (HTTPS) access.

package main

import (
	"github.com/minio/minio/pkg/madmin"
	"log"
)

func main() {
	endpoint := "your-minio.example.com:9000"
	accessKeyID := "YOUR-ACCESSKEYID"
	secretAccessKey := "YOUR-SECRETKEY"
	useSSL := true

	// Initialize minio admin client object.
        madmClnt, err := madmin.New(endpoint, accessKeyID, secretAccessKey, useSSL)
	if err != nil {
		log.Fatalln(err)
	}

	log.Println("%v", madmClnt) // Minio admin client is now setup


Quick Start Example - Service Status.

This example program connects to minio server, gets the current disk status.

We will use the Minio server running at https://your-minio.example.com:9000 in this example. Feel free to use this service for testing and development. Access credentials shown in this example are open to the public.

ServiceStatus.go

package main

import (
	"log"

	"github.com/minio/minio/pkg/madmin"
)

func main() {
	endpoint := "your-minio.example.com:9000"
	accessKeyID := "YOUR-ACCESSKEYID"
	secretAccessKey := "YOUR-SECRETKEY"
	useSSL := true

	// Initialize minio admin client.
	mdmClnt, err := madmin.New(endpoint, accessKeyID, secretAccessKey, useSSL)
	if err != nil {
		log.Fatalln(err)
	}

	st, err := madmClnt.ServiceStatus()
	if err != nil {
		log.Fatalln(err)
	}
	log.Printf("%#v\n", st)

}

Run ServiceStatus


go run service-status.go
2016/12/20 16:46:01 madmin.ServiceStatusMetadata{Total:177038229504, Free:120365559808, Backend:struct { Type madmin.BackendType; OnlineDisks int; OfflineDisks int; ReadQuorum int; WriteQuorum int }{Type:1, OnlineDisks:0, OfflineDisks:0, StandardSCParity:0, RRSCParity:0}}

API Reference

API Reference : Service Operations

Full Examples

Full Examples : Service Operations

Contribute

Contributors Guide