1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267
|
//
// Copyright (c) 2015-2024 MinIO, Inc.
//
// This file is part of MinIO Object Storage stack
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
//
package madmin
import (
"encoding/json"
"errors"
"log"
)
//go:generate msgp -file $GOFILE
// TierConfigVer refers to the current tier config version
const TierConfigVer = "v1"
// TierType enumerates different remote tier backends.
type TierType int
const (
// Unsupported refers to remote tier backend that is not supported in this version
Unsupported TierType = iota
// S3 refers to AWS S3 compatible backend
S3
// Azure refers to Azure Blob Storage
Azure
// GCS refers to Google Cloud Storage
GCS
// MinIO refers to MinIO object storage backend
MinIO
)
// String returns the name of tt's remote tier backend.
func (tt TierType) String() string {
switch tt {
case S3:
return "s3"
case Azure:
return "azure"
case GCS:
return "gcs"
case MinIO:
return "minio"
}
return "unsupported"
}
// MarshalJSON returns the canonical json representation of tt.
func (tt TierType) MarshalJSON() ([]byte, error) {
typ := tt.String()
return json.Marshal(typ)
}
// UnmarshalJSON parses the provided tier type string, failing unmarshal
// if data contains invalid tier type.
func (tt *TierType) UnmarshalJSON(data []byte) error {
var s string
err := json.Unmarshal(data, &s)
if err != nil {
return err
}
newtt, err := NewTierType(s)
if err != nil {
return err
}
*tt = newtt
return nil
}
// NewTierType creates TierType if scType is a valid tier type string, otherwise
// returns an error.
func NewTierType(scType string) (TierType, error) {
switch scType {
case S3.String():
return S3, nil
case Azure.String():
return Azure, nil
case GCS.String():
return GCS, nil
case MinIO.String():
return MinIO, nil
}
return Unsupported, ErrTierTypeUnsupported
}
// TierConfig represents the different remote tier backend configurations
// supported. The specific backend is identified by the Type field. It has a
// Version field to allow for backwards-compatible extension in the future.
type TierConfig struct {
Version string
Type TierType `json:",omitempty"`
Name string `json:",omitempty"`
S3 *TierS3 `json:",omitempty"`
Azure *TierAzure `json:",omitempty"`
GCS *TierGCS `json:",omitempty"`
MinIO *TierMinIO `json:",omitempty"`
}
var (
// ErrTierNameEmpty "remote tier name empty"
ErrTierNameEmpty = errors.New("remote tier name empty")
// ErrTierInvalidConfig "invalid tier config"
ErrTierInvalidConfig = errors.New("invalid tier config")
// ErrTierInvalidConfigVersion "invalid tier config version"
ErrTierInvalidConfigVersion = errors.New("invalid tier config version")
// ErrTierTypeUnsupported "unsupported tier type"
ErrTierTypeUnsupported = errors.New("unsupported tier type")
)
// Clone returns a copy of TierConfig with secret key/credentials redacted.
func (cfg *TierConfig) Clone() TierConfig {
var (
s3 TierS3
az TierAzure
gcs TierGCS
m TierMinIO
)
switch cfg.Type {
case S3:
s3 = *cfg.S3
s3.SecretKey = "REDACTED"
case Azure:
az = *cfg.Azure
az.AccountKey = "REDACTED"
case GCS:
gcs = *cfg.GCS
gcs.Creds = "REDACTED"
case MinIO:
m = *cfg.MinIO
m.SecretKey = "REDACTED"
}
return TierConfig{
Version: cfg.Version,
Type: cfg.Type,
Name: cfg.Name,
S3: &s3,
Azure: &az,
GCS: &gcs,
MinIO: &m,
}
}
// UnmarshalJSON unmarshals json value to ensure that Type field is filled in
// correspondence with the tier config supplied.
// See TestUnmarshalTierConfig for an example json.
func (cfg *TierConfig) UnmarshalJSON(b []byte) error {
type tierConfig TierConfig
var m tierConfig
err := json.Unmarshal(b, &m)
if err != nil {
return err
}
switch m.Version {
case TierConfigVer:
default:
return ErrTierInvalidConfigVersion
}
switch m.Type {
case S3:
if m.S3 == nil {
return ErrTierInvalidConfig
}
case Azure:
if m.Azure == nil {
return ErrTierInvalidConfig
}
case GCS:
if m.GCS == nil {
return ErrTierInvalidConfig
}
case MinIO:
if m.MinIO == nil {
return ErrTierInvalidConfig
}
}
if m.Name == "" {
return ErrTierNameEmpty
}
*cfg = TierConfig(m)
return nil
}
// Endpoint returns the remote tier backend endpoint.
func (cfg *TierConfig) Endpoint() string {
switch cfg.Type {
case S3:
return cfg.S3.Endpoint
case Azure:
return cfg.Azure.Endpoint
case GCS:
return cfg.GCS.Endpoint
case MinIO:
return cfg.MinIO.Endpoint
}
log.Printf("unexpected tier type %s", cfg.Type)
return ""
}
// Bucket returns the remote tier backend bucket.
func (cfg *TierConfig) Bucket() string {
switch cfg.Type {
case S3:
return cfg.S3.Bucket
case Azure:
return cfg.Azure.Bucket
case GCS:
return cfg.GCS.Bucket
case MinIO:
return cfg.MinIO.Bucket
}
log.Printf("unexpected tier type %s", cfg.Type)
return ""
}
// Prefix returns the remote tier backend prefix.
func (cfg *TierConfig) Prefix() string {
switch cfg.Type {
case S3:
return cfg.S3.Prefix
case Azure:
return cfg.Azure.Prefix
case GCS:
return cfg.GCS.Prefix
case MinIO:
return cfg.MinIO.Prefix
}
log.Printf("unexpected tier type %s", cfg.Type)
return ""
}
// Region returns the remote tier backend region.
func (cfg *TierConfig) Region() string {
switch cfg.Type {
case S3:
return cfg.S3.Region
case Azure:
return cfg.Azure.Region
case GCS:
return cfg.GCS.Region
case MinIO:
return cfg.MinIO.Region
}
log.Printf("unexpected tier type %s", cfg.Type)
return ""
}
|