S3 API Quick Start

Step 1: Setup OpenStack CLI

To get started, you'll need to setup the OpenStack CLI client to generate credentials for the S3 API.

Step 2: Create EC2 Credentials

Once the OpenStack CLI is working, create your S3-compatible credentials:

openstack ec2 credentials create

The output will look like this:

+------------+----------------------------------+
| Field      | Value                            |
+------------+----------------------------------+
| access     | 00000000000000000000000000000000 |
| links      | {'self': '[...]'}                |
| project_id | 00000000000000000000000000000000 |
| secret     | 00000000000000000000000000000000 |
| trust_id   | None                             |
| user_id    | 00000000000000000000000000000000 |
+------------+----------------------------------+

Step 3: Configure S3 Browser

If you're using the S3 Browser application, configure it with these settings:

• Account Name: Any descriptive name
• Account Type: S3 Compatible Storage
• REST Endpoint: Your region's controller endpoint (e.g., lax-controller.ramnode.com)
• Access Key ID: Your "access" value from credentials
• Secret Access Key: Your "secret" value from credentials

Step 4: List Objects Example

Here's a complete example for listing objects using the boto3 Python library:

import boto3

# Assign your credentials (replace with your own values)
ACCESS_KEY_ID = '00000000000000000000000000000000'
SECRET_ACCESS_KEY = '00000000000000000000000000000000'

# Set the appropriate API URL for your region
S3_API_URL = 'https://lax-controller.ramnode.com:8080'

# Create an S3 client with your credentials and API URL
s3 = boto3.client('s3', 
                  aws_access_key_id=ACCESS_KEY_ID,
                  aws_secret_access_key=SECRET_ACCESS_KEY,
                  endpoint_url=S3_API_URL)

# Define the bucket and prefix you want to list objects for
bucket_name = 'ExampleBucket'
prefix = ''

# List objects in the bucket with the specified prefix
response = s3.list_objects(Bucket=bucket_name, Prefix=prefix)

# Print the object names
for obj in response['Contents']:
    print(obj['Key'])

Step 5: Upload Files

# Upload a file to a bucket
s3.upload_file('local-file.txt', 'my-bucket', 'remote-file.txt')

# Or use put_object for more control
with open('local-file.txt', 'rb') as f:
    s3.put_object(Bucket='my-bucket', Key='remote-file.txt', Body=f)

Step 6: Download Files

# Download a file from a bucket
s3.download_file('my-bucket', 'remote-file.txt', 'local-file.txt')

# Or use get_object
response = s3.get_object(Bucket='my-bucket', Key='remote-file.txt')
with open('local-file.txt', 'wb') as f:
    f.write(response['Body'].read())

Step 7: Delete Objects

# Delete an object from a bucket
s3.delete_object(Bucket='my-bucket', Key='remote-file.txt')

Step 8: List Buckets

# List all buckets
response = s3.list_buckets()
for bucket in response['Buckets']:
    print(bucket['Name'])