Skip to content

Commit 713364f

Browse files
mowoc-ocpmowoc-ocp
authored
Support optional/configurable IAMEndpoint for Minio Client (#32581) (#32581)
Targeting issue #32271 This modification allows native Kubernetes + AWS (EKS) authentication with the Minio client, to Amazon S3 using the IRSA role assigned to a Service account by replacing the hard coded reference to the `DefaultIAMRoleEndpoint` with an optional configurable endpoint. Internally, Minio's `credentials.IAM` provider implements a discovery flow for IAM Endpoints if it is not set. For backwards compatibility: - We have added a configuration mechanism for an `IamEndpoint` to retain the unit test safety in `minio_test.go`. - We believe existing clients will continue to function the same without needing to provide a new config property since the internals of Minio client also often resolve to the `http://169.254.169.254` default endpoint that was being hard coded before To test, we were able to build a docker image from source and, observe it choosing the expected IAM endpoint, and see files uploaded via the client.
1 parent f2a9951 commit 713364f

File tree

5 files changed

+46
-11
lines changed

5 files changed

+46
-11
lines changed

Diff for: ‎custom/conf/app.example.ini

+14
Original file line numberDiff line numberDiff line change
@@ -1944,6 +1944,13 @@ LEVEL = Info
19441944
;; Minio secretAccessKey to connect only available when STORAGE_TYPE is `minio`
19451945
;MINIO_SECRET_ACCESS_KEY =
19461946
;;
1947+
;; Preferred IAM Endpoint to override Minio's default IAM Endpoint resolution only available when STORAGE_TYPE is `minio`.
1948+
;; If not provided and STORAGE_TYPE is `minio`, will search for and derive endpoint from known environment variables
1949+
;; (AWS_CONTAINER_AUTHORIZATION_TOKEN, AWS_CONTAINER_AUTHORIZATION_TOKEN_FILE, AWS_CONTAINER_CREDENTIALS_RELATIVE_URI,
1950+
;; AWS_CONTAINER_CREDENTIALS_FULL_URI, AWS_WEB_IDENTITY_TOKEN_FILE, AWS_ROLE_ARN, AWS_ROLE_SESSION_NAME, AWS_REGION),
1951+
;; or the DefaultIAMRoleEndpoint if not provided otherwise.
1952+
;MINIO_IAM_ENDPOINT =
1953+
;;
19471954
;; Minio bucket to store the attachments only available when STORAGE_TYPE is `minio`
19481955
;MINIO_BUCKET = gitea
19491956
;;
@@ -2688,6 +2695,13 @@ LEVEL = Info
26882695
;; Minio secretAccessKey to connect only available when STORAGE_TYPE is `minio`
26892696
;MINIO_SECRET_ACCESS_KEY =
26902697
;;
2698+
;; Preferred IAM Endpoint to override Minio's default IAM Endpoint resolution only available when STORAGE_TYPE is `minio`.
2699+
;; If not provided and STORAGE_TYPE is `minio`, will search for and derive endpoint from known environment variables
2700+
;; (AWS_CONTAINER_AUTHORIZATION_TOKEN, AWS_CONTAINER_AUTHORIZATION_TOKEN_FILE, AWS_CONTAINER_CREDENTIALS_RELATIVE_URI,
2701+
;; AWS_CONTAINER_CREDENTIALS_FULL_URI, AWS_WEB_IDENTITY_TOKEN_FILE, AWS_ROLE_ARN, AWS_ROLE_SESSION_NAME, AWS_REGION),
2702+
;; or the DefaultIAMRoleEndpoint if not provided otherwise.
2703+
;MINIO_IAM_ENDPOINT =
2704+
;;
26912705
;; Minio bucket to store the attachments only available when STORAGE_TYPE is `minio`
26922706
;MINIO_BUCKET = gitea
26932707
;;

Diff for: ‎modules/setting/storage.go

+1
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ type MinioStorageConfig struct {
4343
Endpoint string `ini:"MINIO_ENDPOINT" json:",omitempty"`
4444
AccessKeyID string `ini:"MINIO_ACCESS_KEY_ID" json:",omitempty"`
4545
SecretAccessKey string `ini:"MINIO_SECRET_ACCESS_KEY" json:",omitempty"`
46+
IamEndpoint string `ini:"MINIO_IAM_ENDPOINT" json:",omitempty"`
4647
Bucket string `ini:"MINIO_BUCKET" json:",omitempty"`
4748
Location string `ini:"MINIO_LOCATION" json:",omitempty"`
4849
BasePath string `ini:"MINIO_BASE_PATH" json:",omitempty"`

Diff for: ‎modules/setting/storage_test.go

+13
Original file line numberDiff line numberDiff line change
@@ -470,6 +470,19 @@ MINIO_BASE_PATH = /prefix
470470
cfg, err = NewConfigProviderFromData(`
471471
[storage]
472472
STORAGE_TYPE = minio
473+
MINIO_IAM_ENDPOINT = 127.0.0.1
474+
MINIO_USE_SSL = true
475+
MINIO_BASE_PATH = /prefix
476+
`)
477+
assert.NoError(t, err)
478+
assert.NoError(t, loadRepoArchiveFrom(cfg))
479+
assert.EqualValues(t, "127.0.0.1", RepoArchive.Storage.MinioConfig.IamEndpoint)
480+
assert.EqualValues(t, true, RepoArchive.Storage.MinioConfig.UseSSL)
481+
assert.EqualValues(t, "/prefix/repo-archive/", RepoArchive.Storage.MinioConfig.BasePath)
482+
483+
cfg, err = NewConfigProviderFromData(`
484+
[storage]
485+
STORAGE_TYPE = minio
473486
MINIO_ACCESS_KEY_ID = my_access_key
474487
MINIO_SECRET_ACCESS_KEY = my_secret_key
475488
MINIO_USE_SSL = true

Diff for: ‎modules/storage/minio.go

+5-3
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ func NewMinioStorage(ctx context.Context, cfg *setting.Storage) (ObjectStorage,
9797
}
9898

9999
minioClient, err := minio.New(config.Endpoint, &minio.Options{
100-
Creds: buildMinioCredentials(config, credentials.DefaultIAMRoleEndpoint),
100+
Creds: buildMinioCredentials(config),
101101
Secure: config.UseSSL,
102102
Transport: &http.Transport{TLSClientConfig: &tls.Config{InsecureSkipVerify: config.InsecureSkipVerify}},
103103
Region: config.Location,
@@ -164,7 +164,7 @@ func (m *MinioStorage) buildMinioDirPrefix(p string) string {
164164
return p
165165
}
166166

167-
func buildMinioCredentials(config setting.MinioStorageConfig, iamEndpoint string) *credentials.Credentials {
167+
func buildMinioCredentials(config setting.MinioStorageConfig) *credentials.Credentials {
168168
// If static credentials are provided, use those
169169
if config.AccessKeyID != "" {
170170
return credentials.NewStaticV4(config.AccessKeyID, config.SecretAccessKey, "")
@@ -184,7 +184,9 @@ func buildMinioCredentials(config setting.MinioStorageConfig, iamEndpoint string
184184
&credentials.FileAWSCredentials{},
185185
// read IAM role from EC2 metadata endpoint if available
186186
&credentials.IAM{
187-
Endpoint: iamEndpoint,
187+
// passing in an empty Endpoint lets the IAM Provider
188+
// decide which endpoint to resolve internally
189+
Endpoint: config.IamEndpoint,
188190
Client: &http.Client{
189191
Transport: http.DefaultTransport,
190192
},

Diff for: ‎modules/storage/minio_test.go

+13-8
Original file line numberDiff line numberDiff line change
@@ -107,8 +107,9 @@ func TestMinioCredentials(t *testing.T) {
107107
cfg := setting.MinioStorageConfig{
108108
AccessKeyID: ExpectedAccessKey,
109109
SecretAccessKey: ExpectedSecretAccessKey,
110+
IamEndpoint: FakeEndpoint,
110111
}
111-
creds := buildMinioCredentials(cfg, FakeEndpoint)
112+
creds := buildMinioCredentials(cfg)
112113
v, err := creds.Get()
113114

114115
assert.NoError(t, err)
@@ -117,13 +118,15 @@ func TestMinioCredentials(t *testing.T) {
117118
})
118119

119120
t.Run("Chain", func(t *testing.T) {
120-
cfg := setting.MinioStorageConfig{}
121+
cfg := setting.MinioStorageConfig{
122+
IamEndpoint: FakeEndpoint,
123+
}
121124

122125
t.Run("EnvMinio", func(t *testing.T) {
123126
t.Setenv("MINIO_ACCESS_KEY", ExpectedAccessKey+"Minio")
124127
t.Setenv("MINIO_SECRET_KEY", ExpectedSecretAccessKey+"Minio")
125128

126-
creds := buildMinioCredentials(cfg, FakeEndpoint)
129+
creds := buildMinioCredentials(cfg)
127130
v, err := creds.Get()
128131

129132
assert.NoError(t, err)
@@ -135,7 +138,7 @@ func TestMinioCredentials(t *testing.T) {
135138
t.Setenv("AWS_ACCESS_KEY", ExpectedAccessKey+"AWS")
136139
t.Setenv("AWS_SECRET_KEY", ExpectedSecretAccessKey+"AWS")
137140

138-
creds := buildMinioCredentials(cfg, FakeEndpoint)
141+
creds := buildMinioCredentials(cfg)
139142
v, err := creds.Get()
140143

141144
assert.NoError(t, err)
@@ -144,11 +147,11 @@ func TestMinioCredentials(t *testing.T) {
144147
})
145148

146149
t.Run("FileMinio", func(t *testing.T) {
147-
t.Setenv("MINIO_SHARED_CREDENTIALS_FILE", "testdata/minio.json")
148150
// prevent loading any actual credentials files from the user
151+
t.Setenv("MINIO_SHARED_CREDENTIALS_FILE", "testdata/minio.json")
149152
t.Setenv("AWS_SHARED_CREDENTIALS_FILE", "testdata/fake")
150153

151-
creds := buildMinioCredentials(cfg, FakeEndpoint)
154+
creds := buildMinioCredentials(cfg)
152155
v, err := creds.Get()
153156

154157
assert.NoError(t, err)
@@ -161,7 +164,7 @@ func TestMinioCredentials(t *testing.T) {
161164
t.Setenv("MINIO_SHARED_CREDENTIALS_FILE", "testdata/fake.json")
162165
t.Setenv("AWS_SHARED_CREDENTIALS_FILE", "testdata/aws_credentials")
163166

164-
creds := buildMinioCredentials(cfg, FakeEndpoint)
167+
creds := buildMinioCredentials(cfg)
165168
v, err := creds.Get()
166169

167170
assert.NoError(t, err)
@@ -187,7 +190,9 @@ func TestMinioCredentials(t *testing.T) {
187190
defer server.Close()
188191

189192
// Use the provided EC2 Instance Metadata server
190-
creds := buildMinioCredentials(cfg, server.URL)
193+
creds := buildMinioCredentials(setting.MinioStorageConfig{
194+
IamEndpoint: server.URL,
195+
})
191196
v, err := creds.Get()
192197

193198
assert.NoError(t, err)

0 commit comments

Comments
 (0)