Your Object Storage containers work with any tool that speaks S3: the AWS CLI, Python boto3, rclone, Cyberduck, Terraform, backup software and most media and website tools. To connect one, you need three things:
- an endpoint (the address of the region your container is in)
- an Access Key
- a Secret Key
You create the keys yourself, so only you ever see them. It takes about five minutes the first time.
Before you start
- A container in Object Storage > Containers. Each container shows up in S3 tools as a bucket with the same name.
- Python 3 on your computer (Mac, Linux or Windows).
Step 1: Create an Application Credential
An Application Credential lets the command line act on your behalf without your Gewape ID password.
- In the console, click your name at the top right and choose Application Credentials.
- Click Create.
- Name: something you will recognize later, for example
s3-access. - Expires At: leave empty for no expiry, or pick a date if the key is temporary.
- Roles: keep the default.
- Unrestricted: leave unticked.
- Click OK. Copy the ID and the Secret now. The Secret is shown only once. If you lose it, delete the credential and create a new one.
More detail: API access and Application Credentials.
Step 2: Install the tools (once)
pip install python-openstackclient awscli
Step 3: Sign in from your terminal
On Mac or Linux:
export OS_AUTH_TYPE=v3applicationcredential
export OS_AUTH_URL=https://api.kgl.gewapecloud.com:5000/v3
export OS_APPLICATION_CREDENTIAL_ID=your-id
export OS_APPLICATION_CREDENTIAL_SECRET=your-secret
On Windows PowerShell:
$env:OS_AUTH_TYPE="v3applicationcredential"
$env:OS_AUTH_URL="https://api.kgl.gewapecloud.com:5000/v3"
$env:OS_APPLICATION_CREDENTIAL_ID="your-id"
$env:OS_APPLICATION_CREDENTIAL_SECRET="your-secret"
Step 4: Create your S3 keys
openstack ec2 credentials create
In the result, access is your S3 Access Key and secret is your S3 Secret Key. The keys work for every container in your project.
To see your keys later:
openstack ec2 credentials list
Step 5: Connect your S3 tool
Use the endpoint of the region your container is in:
| Region | Endpoint |
|---|---|
| Kigali | https://s3.kgl.gewapecloud.com |
| Huye | https://s3.huy.gewapecloud.com |
| Nairobi | https://s3.nbo.gewapecloud.com |
Each container answers only on the endpoint of its own region. A Kigali container used through another region's endpoint is refused, so always match the endpoint to the region you chose when you created the container.
AWS CLI
aws configure
Enter your Access Key and Secret Key. For Default region name enter us-east-1. Leave the output format empty. Then test (Kigali shown, use your region's endpoint):
aws --endpoint-url https://s3.kgl.gewapecloud.com s3 ls
You should see your containers listed. Everyday commands:
aws --endpoint-url https://s3.kgl.gewapecloud.com s3 cp report.pdf s3://my-container/
aws --endpoint-url https://s3.kgl.gewapecloud.com s3 cp s3://my-container/report.pdf .
aws --endpoint-url https://s3.kgl.gewapecloud.com s3 sync ./backup s3://my-container/backup
Python (boto3)
import boto3
s3 = boto3.client(
"s3",
endpoint_url="https://s3.kgl.gewapecloud.com",
aws_access_key_id="YOUR_ACCESS_KEY",
aws_secret_access_key="YOUR_SECRET_KEY",
region_name="us-east-1",
)
print(s3.list_buckets()["Buckets"])
Any other tool (rclone, Cyberduck, backup software): choose "S3 compatible" or "Other S3" and use:
- Endpoint: your region's endpoint from the table
- HTTPS: on
- Addressing: path style (not virtual-host style)
- Region:
us-east-1
Keep your keys safe
- Never share your keys or paste them in a chat or email, including with us. Gewape Cloud will never ask for them.
- Running production and test, or several services? Give each its own keys and only the access it needs: Keep production and test apart, with least-privilege keys.
- Create separate keys for each app or server. You can then revoke one without touching the others.
- If a key may have leaked, delete it straight away and create a new one:
openstack ec2 credentials delete ACCESS_KEY
If something does not work
- InvalidAccessKeyId or SignatureDoesNotMatch: check you copied both keys in full, with no spaces.
- NoSuchBucket: the container name is case sensitive, and the endpoint must be the region the container is in.
- Could not connect to the endpoint URL: check the endpoint starts with
https://and that you set path-style addressing. - The request you have made requires authentication at step 4: the Application Credential ID or Secret is wrong or expired. Create a new one.
Still stuck? Use the chat on this page and send us the exact error message (never your keys).