s3

Documentation

Index

• Constants
• Variables
• func BuildS3EnvVars(annotations map[string]string, s3Config *S3Config) []v1.EnvVar
• func BuildSecretEnvs(secret *v1.Secret, s3Config *S3Config) []v1.EnvVar
• func BuildServiceAccountEnvs(serviceAccount *v1.ServiceAccount, s3Config *S3Config) []v1.EnvVar
• type S3Config

Constants

const (
	AWSAccessKeyId         = "AWS_ACCESS_KEY_ID"
	AWSSecretAccessKey     = "AWS_SECRET_ACCESS_KEY" // #nosec G101
	AWSAccessKeyIdName     = "awsAccessKeyID"
	AWSSecretAccessKeyName = "awsSecretAccessKey"
	AWSEndpointUrl         = "AWS_ENDPOINT_URL"
	AWSRegion              = "AWS_DEFAULT_REGION"
	S3Endpoint             = "S3_ENDPOINT"
	S3UseHttps             = "S3_USE_HTTPS"
	S3VerifySSL            = "S3_VERIFY_SSL"
	S3UseVirtualBucket     = "S3_USER_VIRTUAL_BUCKET"
	S3UseAccelerate        = "S3_USE_ACCELERATE"
	AWSAnonymousCredential = "awsAnonymousCredential"
	AWSCABundle            = "AWS_CA_BUNDLE"
	AWSCABundleConfigMap   = "AWS_CA_BUNDLE_CONFIGMAP"
)

For a quick reference about AWS ENV variables: AWS Cli: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html Boto: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#using-environment-variables

Variables

var (
	InferenceServiceS3SecretEndpointAnnotation    = constants.KServeAPIGroupName + "/" + "s3-endpoint"
	InferenceServiceS3SecretRegionAnnotation      = constants.KServeAPIGroupName + "/" + "s3-region"
	InferenceServiceS3SecretSSLAnnotation         = constants.KServeAPIGroupName + "/" + "s3-verifyssl"
	InferenceServiceS3SecretHttpsAnnotation       = constants.KServeAPIGroupName + "/" + "s3-usehttps"
	InferenceServiceS3UseVirtualBucketAnnotation  = constants.KServeAPIGroupName + "/" + "s3-usevirtualbucket"
	InferenceServiceS3UseAccelerateAnnotation     = constants.KServeAPIGroupName + "/" + "s3-useaccelerate"
	InferenceServiceS3UseAnonymousCredential      = constants.KServeAPIGroupName + "/" + "s3-useanoncredential"
	InferenceServiceS3CABundleConfigMapAnnotation = constants.KServeAPIGroupName + "/" + "s3-cabundle-configmap"
	InferenceServiceS3CABundleAnnotation          = constants.KServeAPIGroupName + "/" + "s3-cabundle"
)

Functions

func BuildS3EnvVars

func BuildS3EnvVars(annotations map[string]string, s3Config *S3Config) []v1.EnvVar

func BuildSecretEnvs

func BuildSecretEnvs(secret *v1.Secret, s3Config *S3Config) []v1.EnvVar

func BuildServiceAccountEnvs

func BuildServiceAccountEnvs(serviceAccount *v1.ServiceAccount, s3Config *S3Config) []v1.EnvVar

Types

type S3Config

type S3Config struct {
	S3AccessKeyIDName        string `json:"s3AccessKeyIDName,omitempty"`
	S3SecretAccessKeyName    string `json:"s3SecretAccessKeyName,omitempty"`
	S3Endpoint               string `json:"s3Endpoint,omitempty"`
	S3UseHttps               string `json:"s3UseHttps,omitempty"`
	S3Region                 string `json:"s3Region,omitempty"`
	S3VerifySSL              string `json:"s3VerifySSL,omitempty"`
	S3UseVirtualBucket       string `json:"s3UseVirtualBucket,omitempty"`
	S3UseAccelerate          string `json:"s3UseAccelerate,omitempty"`
	S3UseAnonymousCredential string `json:"s3UseAnonymousCredential,omitempty"`
	S3CABundleConfigMap      string `json:"s3CABundleConfigMap,omitempty"`
	S3CABundle               string `json:"s3CABundle,omitempty"`
}