object: add obc bucketLifecycle

Signed-off-by: Joshua Hoblitt <josh@hoblitt.com>
(cherry picked from commit a55fdb3fbe)
This commit is contained in:
Joshua Hoblitt authored and Mergify committed 2025-01-22 17:20:38 +00:00
1 parent 85e8be0f4e
commit 3bc1597e7c
4 files changed
+117

No files matched your search

@@ -17,6 +17,7 @@ limitations under the License.
package bucket
import (
"encoding/json"
"fmt"
"net/http"
"strings"
@@ -64,6 +65,7 @@ type additionalConfigSpec struct {
bucketMaxObjects *int64
bucketMaxSize *int64
bucketPolicy *string
bucketLifecycle *string
}
var _ apibkt.Provisioner = &Provisioner{}
@@ -587,6 +589,11 @@ func (p *Provisioner) setAdditionalSettings(additionalConfig *additionalConfigSp
return errors.Wrap(err, "failed to set bucket policy")
}
err = p.setBucketLifecycle(additionalConfig)
if err != nil {
return errors.Wrap(err, "failed to set bucket lifecycle")
}
return nil
}
@@ -741,6 +748,77 @@ func (p *Provisioner) setBucketPolicy(additionalConfig *additionalConfigSpec) er
return nil
}
func (p *Provisioner) setBucketLifecycle(additionalConfig *additionalConfigSpec) error {
svc := p.s3Agent.Client
var liveLc *s3.GetBucketLifecycleConfigurationOutput
liveLc, err := svc.GetBucketLifecycleConfiguration(&s3.GetBucketLifecycleConfigurationInput{
Bucket: &p.bucketName,
})
if err != nil {
// when no lifecycle configuration is set, an err with a "code" of
// NoSuchLifecycleConfiguration is returned
if aerr, ok := err.(awserr.Error); ok && aerr.Code() == "NoSuchLifecycleConfiguration" {
logger.Debugf("no lifecycle configuration set for bucket %q", p.bucketName)
} else {
return errors.Wrapf(err, "failed to fetch lifecycle configuration for bucket %q", p.bucketName)
}
}
// parse the conf supplied lifecycle configuration json as aws-sdk-go will not operate on a
// json string
confLc := &s3.BucketLifecycleConfiguration{}
// don't try to parse the conf json if it is nil
if additionalConfig.bucketLifecycle != nil {
err = json.Unmarshal([]byte(*additionalConfig.bucketLifecycle), confLc)
if err != nil {
return errors.Wrapf(err, "failed to unmarshal lifecycle configuration for bucket %q", p.bucketName)
}
}
// Comparing the conf json with a json serialization of the live rules is
// unreliable as aws-sdk-go does not tag fields with "ommitempty". The
// GetBucketLifecycleConfigurationOutput type has a String() method that
// returns a json like format which isn't valid json. The options are to
// write a custom json unmarshaler or compare go structs directly.
// convert the api returned GetBucketLifecycleConfigurationOutput to a
// BucketLifecycleConfiguration for apples to apples comparison to determine
// sync state
diffLiveLc := &s3.BucketLifecycleConfiguration{Rules: liveLc.Rules}
// note that the xml serialization of the rules returned by rgw sorts the
// rules by "ID". The rule ordering from the
// PutBucketLifecycleConfiguration() call is not preserved.
diff := cmp.Diff(diffLiveLc, confLc)
if diff == "" {
// policy is in sync
return nil
}
logger.Debugf("Lifecycle configuration for bucket %q has changed. diff:%s", p.bucketName, diff)
if additionalConfig.bucketLifecycle == nil {
// if policy is out of sync and the new policy is nil, delete the live policy
_, err = svc.DeleteBucketLifecycle(&s3.DeleteBucketLifecycleInput{
Bucket: &p.bucketName,
})
if err != nil {
return errors.Wrapf(err, "failed to delete lifecycle configuration for bucket %q", p.bucketName)
}
} else {
// set the new policy
_, err = svc.PutBucketLifecycleConfiguration(&s3.PutBucketLifecycleConfigurationInput{
Bucket: &p.bucketName,
LifecycleConfiguration: confLc,
})
if err != nil {
return errors.Wrapf(err, "failed to set lifecycle configuration for bucket %q", p.bucketName)
}
}
return nil
}
func (p *Provisioner) setTlsCaCert() error {
objStore, err := p.getObjectStore()
if err != nil {
@@ -524,6 +524,18 @@ func TestProvisioner_additionalConfigSpecFromMap(t *testing.T) {
assert.NoError(t, err)
assert.Equal(t, additionalConfigSpec{bucketMaxSize: &(&struct{ i int64 }{5}).i}, *spec)
})
t.Run("bucketPolicy field should be set", func(t *testing.T) {
spec, err := additionalConfigSpecFromMap(map[string]string{"bucketPolicy": "foo"})
assert.NoError(t, err)
assert.Equal(t, additionalConfigSpec{bucketPolicy: &(&struct{ s string }{"foo"}).s}, *spec)
})
t.Run("bucketLifecycle field should be set", func(t *testing.T) {
spec, err := additionalConfigSpecFromMap(map[string]string{"bucketLifecycle": "foo"})
assert.NoError(t, err)
assert.Equal(t, additionalConfigSpec{bucketLifecycle: &(&struct{ s string }{"foo"}).s}, *spec)
})
}
func numberOfCallsWithValue(substr string, strs []string) int {
+5
View File
@@ -125,6 +125,11 @@ func additionalConfigSpecFromMap(config map[string]string) (*additionalConfigSpe
spec.bucketPolicy = &policy
}
if _, ok := config["bucketLifecycle"]; ok {
lifecycle := config["bucketLifecycle"]
spec.bucketLifecycle = &lifecycle
}
return &spec, nil
}