Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Azure: Add new az_tenant_id, client_id and client_secret configs #157

Merged
merged 2 commits into from
Jan 15, 2025
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Re-implement the flags with signed-off.
Signed-off-by: DylanGuedes <[email protected]>
DylanGuedes committed Jan 14, 2025

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
commit dffc903272757c2e4778e428ee4ca319bac8ea5a
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -11,6 +11,7 @@ We use *breaking :warning:* to mark changes that are not backward compatible (re
## Unreleased
- [#38](https://github.com/thanos-io/objstore/pull/38) GCS: Upgrade cloud.google.com/go/storage version to `v1.43.0`.
- [#145](https://github.com/thanos-io/objstore/pull/145) Include content length in the response of Get and GetRange.
- [#157](https://github.com/thanos-io/objstore/pull/157) Azure: Add `az_tenant_id`, `client_id` and `client_secret` configs.

### Fixed
- [#153](https://github.com/thanos-io/objstore/pull/153) Metrics: Fix `objstore_bucket_operation_duration_seconds_*` for `get` and `get_range` operations.
11 changes: 11 additions & 0 deletions providers/azure/azure.go
Original file line number Diff line number Diff line change
@@ -46,6 +46,9 @@ var DefaultConfig = Config{

// Config Azure storage configuration.
type Config struct {
AzTenantID string `yaml:"az_tenant_id"`
ClientID string `yaml:"client_id"`
ClientSecret string `yaml:"client_secret"`
DylanGuedes marked this conversation as resolved.
Show resolved Hide resolved
StorageAccountName string `yaml:"storage_account"`
StorageAccountKey string `yaml:"storage_account_key"`
StorageConnectionString string `yaml:"storage_connection_string"`
@@ -84,6 +87,14 @@ func (conf *Config) validate() error {
errMsg = append(errMsg, "user_assigned_id cannot be set when using storage_connection_string authentication")
}

if conf.UserAssignedID != "" && conf.ClientID != "" {
errMsg = append(errMsg, "user_assigned_id cannot be set when using client_id authentication")
}

if (conf.AzTenantID != "" || conf.ClientSecret != "" || conf.ClientID != "") && (conf.AzTenantID == "" || conf.ClientSecret == "" || conf.ClientID == "") {
errMsg = append(errMsg, "az_tenant_id, client_id, and client_secret must be set together")
}

if conf.StorageAccountKey != "" && conf.StorageConnectionString != "" {
errMsg = append(errMsg, "storage_account_key and storage_connection_string cannot both be set")
}
21 changes: 21 additions & 0 deletions providers/azure/azure_test.go
Original file line number Diff line number Diff line change
@@ -140,6 +140,27 @@ container: "MyContainer"`),
storage_account_key: ""
user_assigned_id: "1234-56578678-655"
storage_connection_string: "myConnectionString"
container: "MyContainer"`),
wantFailParse: false,
wantFailValidate: true,
},
{
name: "Valid AzTenantID, ClientID, ClientSecret",
config: []byte(`storage_account: "myAccount"
storage_account_key: ""
az_tenant_id: "1234-56578678-655"
client_id: "1234-56578678-655"
client_secret: "1234-56578678-655"
container: "MyContainer"`),
wantFailParse: false,
wantFailValidate: false,
},
{
name: "Valid ClientID and ClientSecret but missing AzTenantID",
config: []byte(`storage_account: "myAccount"
storage_account_key: ""
client_id: "1234-56578678-655"
client_secret: "1234-56578678-655"
container: "MyContainer"`),
wantFailParse: false,
wantFailValidate: true,
26 changes: 15 additions & 11 deletions providers/azure/helpers.go
Original file line number Diff line number Diff line change
@@ -71,17 +71,7 @@ func getContainerClient(conf Config, wrapRoundtripper func(http.RoundTripper) ht
}

// Otherwise use a token credential
var cred azcore.TokenCredential

// Use Managed Identity Credential if a user assigned ID is set
if conf.UserAssignedID != "" {
msiOpt := &azidentity.ManagedIdentityCredentialOptions{}
msiOpt.ID = azidentity.ClientID(conf.UserAssignedID)
cred, err = azidentity.NewManagedIdentityCredential(msiOpt)
} else {
// Otherwise use Default Azure Credential
cred, err = azidentity.NewDefaultAzureCredential(nil)
}
cred, err := getTokenCredential(conf)

if err != nil {
return nil, err
@@ -94,3 +84,17 @@ func getContainerClient(conf Config, wrapRoundtripper func(http.RoundTripper) ht

return containerClient, nil
}

func getTokenCredential(conf Config) (azcore.TokenCredential, error) {
if conf.ClientSecret != "" && conf.AzTenantID != "" && conf.ClientID != "" {
return azidentity.NewClientSecretCredential(conf.AzTenantID, conf.ClientID, conf.ClientSecret, &azidentity.ClientSecretCredentialOptions{})
}

if conf.UserAssignedID == "" {
return azidentity.NewDefaultAzureCredential(nil)
}

msiOpt := &azidentity.ManagedIdentityCredentialOptions{}
msiOpt.ID = azidentity.ClientID(conf.UserAssignedID)
return azidentity.NewManagedIdentityCredential(msiOpt)
}

Unchanged files with check annotations Beta

func (b *Bucket) IsObjNotFoundErr(err error) bool {
failure, isServiceError := common.IsServiceError(err)
if isServiceError {
k := failure.GetHTTPStatusCode()

Check failure on line 250 in providers/oci/oci.go

GitHub Actions / Linters (Static Analysis) for Go

failure.GetHTTPStatusCode undefined (type common.ServiceError has no field or method GetHTTPStatusCode)
match := k == http.StatusNotFound
level.Debug(b.logger).Log("msg", match)
return failure.GetHTTPStatusCode() == http.StatusNotFound