Okteto Registry with Amazon S3 Bucket
This guide will walk you through the process of setting up the Okteto Registry with S3 storage to store your container images.
Requirements
Before you start, make sure you have the following CLI installed in your machine:
eksctl>= 0.171 (eksctl installation guide)aws>= 2.15 (AWS CLI installation guide)kubectl>= 1.28 (kubectl installation guide)
Setting up environment variables
The following environment variables help you script the Okteto Registry configuration.
Your Kubernetes cluster name:
export CLUSTER_NAME="okteto"
Your bucket name:
export BUCKET_NAME="${CLUSTER_NAME}-registry-bucket"
S3 bucket names must be globally unique. Add a random string to the bucket name to make sure it's unique.
Your AWS Account ID:
export AWS_ACCOUNT_ID="$(aws sts get-caller-identity --query "Account" --output text)"
Your AWS Region:
export AWS_REGION="$(aws configure get region)"
Disable AWS CLI pagination (optional):
export AWS_PAGER=""
Create S3 Bucket
Create your S3 bucket with the following command:
aws s3api create-bucket \
--bucket="${BUCKET_NAME}" \
--region="${AWS_REGION}" \
--create-bucket-configuration=LocationConstraint="${AWS_REGION}"
Create IAM Role
Save the following IAM Policy definition to a file, and update the Resource fields to match your S3 bucket name:
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"s3:ListBucket",
"s3:GetBucketLocation",
"s3:ListBucketMultipartUploads"
],
"Resource": "arn:aws:s3:::REPLACE-ME-WITH-YOUR-BUCKET-NAME"
},
{
"Effect": "Allow",
"Action": [
"s3:PutObject",
"s3:GetObject",
"s3:DeleteObject",
"s3:ListMultipartUploadParts",
"s3:AbortMultipartUpload"
],
"Resource": "arn:aws:s3:::REPLACE-ME-WITH-YOUR-BUCKET-NAME/*"
}
]
}
The IAM policy is maintained by the distribution/distribution project. You can find the latest version of the policy here.
Create the IAM Policy with the following command:
aws iam create-policy \
--policy-name="${CLUSTER_NAME}-okteto-registry-policy" \
--policy-document="file://okteto-registry-iam-policy.json"
Point your Kubernetes context to the cluster where Okteto is installed, and get the Okteto Registry service account name with the following command:
export OKTETO_REGISTRY_SERVICE_ACCOUNT_NAME="$(kubectl get sa -n=okteto -l=app.kubernetes.io/component=registry -o=jsonpath='{.items[0].metadata.name}')"
Create the IAM Role with the following command:
eksctl create iamserviceaccount \
--region="${AWS_REGION}" \
--name="${OKTETO_REGISTRY_SERVICE_ACCOUNT_NAME}" \
--namespace="okteto" \
--cluster="${CLUSTER_NAME}" \
--role-name="${CLUSTER_NAME}-okteto-registry-role" \
--role-only \
--attach-policy-arn="arn:aws:iam::${AWS_ACCOUNT_ID}:policy/${CLUSTER_NAME}-okteto-registry-policy" \
--approve
Configure Okteto to use your IAM Role
Set the IAM Role ARN with the following command:
export ROLE_ARN="arn:aws:iam::${AWS_ACCOUNT_ID}:role/${CLUSTER_NAME}-okteto-registry-role"
Add the following snippet to your Okteto Helm configuration file and replace the highlighted values:
registry:
storage:
provider:
aws:
enabled: true
bucket: "REPLACE ME WITH YOUR BUCKET NAME"
region: "REPLACE ME WITH YOUR AWS REGION"
iam:
enabled: false
serviceAccount:
annotations:
eks.amazonaws.com/role-arn: "REPLACE_ME_WITH_YOUR_ROLE_ARN"
Upgrade your Okteto instance to apply the new configuration. Upgrade to the same version you already run: it keeps the changes to a minimum and makes any issue easier to troubleshoot.