Files
my-rook-config/pkg/operator/ceph/object/s3-handlers.go
T
Blaine Gardner a777b1d7d1 object: do not create service for external object stores
External CephObjectStores already have endpoints defined by
spec.gateway.externalRgwEndpoints, and if the external store is
configured with TLS (HTTPS), the store's certificates will likely not
accept connections intended for the Service endpoint Rook creates. Some
users might not be able to easily add the service endpoint to their
certificates. Therefore, don't even bother creating a Service for
external clusters.

This does introduce a few issues. The Service seems to have been
initially created to allow multiple external RGW endpoints to be
addressable via a single address in Rook. For all connections to an
external CephObjectStore with multiple endpoints, simply choose an
endpoint at random. Random selection will prevent Rook from failing to
create buckets or users on an external store if one of the external
store's endpoints fails.

The latest OBC library (lib-bucket-provisioner) allows updating the
endpoints on ObjectBuckets after they are created. This allows Rook
users to change endpoints on external CephObjectStores without breaking
all existing OBCs. It requires implementation of the new GetUserID()
library call, requires updating Provision() and Grant() calls to be
idempotent, and it requires removing the Update() call.

Signed-off-by: Blaine Gardner <blaine.gardner@redhat.com>
2022-11-04 17:30:30 -06:00

213 lines
5.6 KiB
Go

/*
Copyright 2018 The Rook Authors. All rights reserved.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package object
import (
"bytes"
"crypto/tls"
"crypto/x509"
"net/http"
"strings"
"github.com/aws/aws-sdk-go/aws"
"github.com/aws/aws-sdk-go/aws/awserr"
"github.com/aws/aws-sdk-go/aws/credentials"
awssession "github.com/aws/aws-sdk-go/aws/session"
"github.com/aws/aws-sdk-go/service/s3"
"github.com/pkg/errors"
)
// Region for aws golang sdk
const CephRegion = "us-east-1"
// S3Agent wraps the s3.S3 structure to allow for wrapper methods
type S3Agent struct {
Client *s3.S3
}
func NewS3Agent(accessKey, secretKey, endpoint string, debug bool, tlsCert []byte) (*S3Agent, error) {
return newS3Agent(accessKey, secretKey, endpoint, debug, tlsCert, false)
}
func NewInsecureS3Agent(accessKey, secretKey, endpoint string, debug bool) (*S3Agent, error) {
return newS3Agent(accessKey, secretKey, endpoint, debug, nil, true)
}
func newS3Agent(accessKey, secretKey, endpoint string, debug bool, tlsCert []byte, insecure bool) (*S3Agent, error) {
logLevel := aws.LogOff
if debug {
logLevel = aws.LogDebug
}
client := http.Client{
Timeout: HttpTimeOut,
}
tlsEnabled := false
if len(tlsCert) > 0 || insecure {
tlsEnabled = true
client.Transport = BuildTransportTLS(tlsCert, insecure)
}
session, err := awssession.NewSession(
aws.NewConfig().
WithRegion(CephRegion).
WithCredentials(credentials.NewStaticCredentials(accessKey, secretKey, "")).
WithEndpoint(endpoint).
WithS3ForcePathStyle(true).
WithMaxRetries(5).
WithDisableSSL(!tlsEnabled).
WithHTTPClient(&client).
WithLogLevel(logLevel),
)
if err != nil {
return nil, err
}
svc := s3.New(session)
return &S3Agent{
Client: svc,
}, nil
}
// CreateBucket creates a bucket with the given name
func (s *S3Agent) CreateBucketNoInfoLogging(name string) error {
return s.createBucket(name, false)
}
// CreateBucket creates a bucket with the given name
func (s *S3Agent) CreateBucket(name string) error {
return s.createBucket(name, true)
}
func (s *S3Agent) createBucket(name string, infoLogging bool) error {
if infoLogging {
logger.Infof("creating bucket %q", name)
} else {
logger.Debugf("creating bucket %q", name)
}
bucketInput := &s3.CreateBucketInput{
Bucket: &name,
}
_, err := s.Client.CreateBucket(bucketInput)
if err != nil {
if aerr, ok := err.(awserr.Error); ok {
logger.Debugf("DEBUG: after s3 call, ok=%v, aerr=%v", ok, aerr)
switch aerr.Code() {
case s3.ErrCodeBucketAlreadyExists:
logger.Debugf("bucket %q already exists", name)
return nil
case s3.ErrCodeBucketAlreadyOwnedByYou:
logger.Debugf("bucket %q already owned by you", name)
return nil
}
}
return errors.Wrapf(err, "failed to create bucket %q", name)
}
if infoLogging {
logger.Infof("successfully created bucket %q", name)
} else {
logger.Debugf("successfully created bucket %q", name)
}
return nil
}
// DeleteBucket function deletes given bucket using s3 client
func (s *S3Agent) DeleteBucket(name string) (bool, error) {
_, err := s.Client.DeleteBucket(&s3.DeleteBucketInput{
Bucket: aws.String(name),
})
if err != nil {
logger.Errorf("failed to delete bucket. %v", err)
return false, err
}
return true, nil
}
// PutObjectInBucket function puts an object in a bucket using s3 client
func (s *S3Agent) PutObjectInBucket(bucketname string, body string, key string,
contentType string) (bool, error) {
_, err := s.Client.PutObject(&s3.PutObjectInput{
Body: strings.NewReader(body),
Bucket: &bucketname,
Key: &key,
ContentType: &contentType,
})
if err != nil {
logger.Errorf("failed to put object in bucket. %v", err)
return false, err
}
return true, nil
}
// GetObjectInBucket function retrieves an object from a bucket using s3 client
func (s *S3Agent) GetObjectInBucket(bucketname string, key string) (string, error) {
result, err := s.Client.GetObject(&s3.GetObjectInput{
Bucket: aws.String(bucketname),
Key: aws.String(key),
})
if err != nil {
logger.Errorf("failed to retrieve object from bucket. %v", err)
return "ERROR_ OBJECT NOT FOUND", err
}
buf := new(bytes.Buffer)
_, err = buf.ReadFrom(result.Body)
if err != nil {
return "", err
}
return buf.String(), nil
}
// DeleteObjectInBucket function deletes given bucket using s3 client
func (s *S3Agent) DeleteObjectInBucket(bucketname string, key string) (bool, error) {
_, err := s.Client.DeleteObject(&s3.DeleteObjectInput{
Bucket: aws.String(bucketname),
Key: aws.String(key),
})
if err != nil {
if aerr, ok := err.(awserr.Error); ok {
switch aerr.Code() {
case s3.ErrCodeNoSuchBucket:
return true, nil
case s3.ErrCodeNoSuchKey:
return true, nil
}
}
logger.Errorf("failed to delete object from bucket. %v", err)
return false, err
}
return true, nil
}
func BuildTransportTLS(tlsCert []byte, insecure bool) *http.Transport {
//nolint:gosec // is enabled only for testing
tlsConfig := &tls.Config{MinVersion: tls.VersionTLS12, InsecureSkipVerify: insecure}
if len(tlsCert) > 0 {
caCertPool := x509.NewCertPool()
caCertPool.AppendCertsFromPEM(tlsCert)
tlsConfig.RootCAs = caCertPool
}
return &http.Transport{
TLSClientConfig: tlsConfig,
}
}