AWS-specific server setup instructions

These instructions are part of the instructions for Setting up upspinserver. Please make sure you have read that document first.

Build upspinserver-aws and upspin-setupstorage-aws

To use Amazon Web Services fetch the aws.upspin.io repository and use the upspinserver-aws and upspin-setupstorage-aws variants.

Fetch the repository and its dependencies:

local$ go get -d aws.upspin.io/cmd/...

Install the upspin-setupstorage-aws command:

local$ go install aws.upspin.io/cmd/upspin-setupstorage-aws

Build the upspinserver-aws binary:

local$ GOOS=linux GOARCH=amd64 go build aws.upspin.io/cmd/upspinserver-aws

Install the AWS CLI

Ensure you have a working AWS environment set up before continuing and that you are able to run basic commands using the CLI tool.

Set up storage, role account, and instance profile

Use upspin setupstorage-aws to create an S3 bucket, an associated role account, and instance profile for accessing the bucket and provisioning. Note that the bucket name must be globally unique among all AWS users, so it is prudent to include your domain name in the bucket name. (We will use example-com-upspin.)

local$ upspin setupstorage-aws -domain=example.com example-com-upspin

It should produce output like this:

You should now deploy the upspinserver binary and run 'upspin setupserver'.

If the command fails, it may leave things in an incomplete state. You can use the -clean flag to clean up any potential entities created:

local$ upspin setupstorage-aws -clean -role_name=upspinstorage -domain=example.com example-com-upspin

Notes:

  • The role has access to all S3 buckets by default. To restrict its access to only one bucket, follow this guide.
  • The role name is also used as the name for the instance profile you should use to provision the instance.
  • If you are running upspinserver on an EC2 instance, ensure that your security group allows inbound TCP traffic on ports 80 and 443.

Continue

You can now continue following the instructions in Setting up upspinserver.