|
| 1 | +## Requirements |
| 2 | + |
| 3 | +This quickstart assumes you are assigned `AdministratorAccess` policy to AWS. |
| 4 | + |
| 5 | +## Setting Up Security Groups for EC2 |
| 6 | + |
| 7 | +To set up a security group for an EC2 instance, navigate to the AWS EC2 Dashboard. In the side panel click `Security Groups`. |
| 8 | + |
| 9 | +In the upper right hand corner, click `Create Security Group`. In the creator screen, name the security group something relevant to the EC2 instance you will create. |
| 10 | + |
| 11 | +<img src="../images/quickstart/aws/aws1.png"> |
| 12 | + |
| 13 | +For ease of use, we are going to set this up using the simplest rules. |
| 14 | + |
| 15 | +<img src="../images/quickstart/aws/aws2.png"> |
| 16 | + |
| 17 | +Create a new `Inbound Rule` that allows for SSH from your computer’s IP address. |
| 18 | + |
| 19 | +You’ve now created a security group that will be used by your EC2 instance. |
| 20 | + |
| 21 | +## Setting Up Your EC2 instance |
| 22 | + |
| 23 | +On the EC2 dashboard, click `Instances`. This will take you to all the EC2 instances you have created. Click `Launch New Instance`. Name the EC2 instance following the naming convention of your choice. |
| 24 | + |
| 25 | +<img src="../images/quickstart/aws/aws3.png"> |
| 26 | + |
| 27 | +For this tutorial, we are going to launch this as the base Ubuntu server. |
| 28 | + |
| 29 | +For the `Create key pair`, we are using ED25519 and `.pem` as we will SSH into the instance later in the tutorial. |
| 30 | +<img src="../images/quickstart/aws/aws4.png"> |
| 31 | + |
| 32 | +Next, under `Network Settings`, change your Firewall security group to Select existing security group and from the resulting dropdown, select the security group you created in the previous section. |
| 33 | + |
| 34 | +You don’t need to change anything else - click `Launch Instance`. |
| 35 | + |
| 36 | +<img src="../images/quickstart/aws/aws5.png"> |
| 37 | + |
| 38 | +It’ll take a few minutes for it to show up in your existing instances, so take a break as it starts up. |
| 39 | + |
| 40 | +## SSHing into the EC2 instance |
| 41 | + |
| 42 | +If you’ve launched a new EC2 instance following the previous steps of this tutorial, find the username for the EC2 instance [here](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/connection-prereqs.html). The version launched in the previous steps was a version of the Amazon Linux so the username is `ubuntu`. |
| 43 | + |
| 44 | +You will also need the IP address of the server. Click on the server in the `Instances` dashboard, and copy the IPv4 address |
| 45 | + |
| 46 | +<img src="../images/quickstart/aws/aws6.png"> |
| 47 | + |
| 48 | +Now that we’ve gathered all the information you will need to SSH into your EC2 instance, on a terminal on your local system, navigate to the `.pem` file downloaded when you created the EC2 instance. Run the following command: |
| 49 | + |
| 50 | +```sh |
| 51 | +chmod 400 [mykey].pem |
| 52 | +``` |
| 53 | + |
| 54 | +This adds the required permissions for SSH-ing into an EC2 instance. |
| 55 | + |
| 56 | +Run the following command in terminal, where `mykey` is the security key file, `username` is the username found above for the relevant EC2 operating system image, and the `ip-address` is the IPv4 address for the server: |
| 57 | + |
| 58 | +```sh |
| 59 | +ssh -i [mykey].pem username@ip-address |
| 60 | +``` |
| 61 | + |
| 62 | +Congrats you’ve SSH’d into the server. |
| 63 | + |
| 64 | +## Install Coder |
| 65 | + |
| 66 | +For this instance, we will run Coder as a system service, however you can run Coder a multitude of different ways. You can learn more about those [here](https://coder.com/docs/coder-oss/latest/install). |
| 67 | + |
| 68 | +In the EC2 instance, run the following command to install Coder |
| 69 | + |
| 70 | +```sh |
| 71 | +curl -fsSL https://coder.com/install.sh | sh |
| 72 | +``` |
| 73 | + |
| 74 | +## Run Coder |
| 75 | + |
| 76 | +First, edit the `coder.env` file to enable `CODER_TUNNEL` by setting the value to true with the following command: |
| 77 | + |
| 78 | +```sh |
| 79 | +sudo vim /etc/coder.d/coder.env |
| 80 | +``` |
| 81 | +<img src="../images/quickstart/aws/aws7.png"> |
| 82 | + |
| 83 | +Exit vim and run the following command to start Coder as a system level service: |
| 84 | + |
| 85 | +```sh |
| 86 | +sudo systemctl enable --now coder |
| 87 | +``` |
| 88 | + |
| 89 | +The following command will get you information about the Coder launch service |
| 90 | + |
| 91 | +```sh |
| 92 | +journalctl -u coder.service -b |
| 93 | +``` |
| 94 | + |
| 95 | +This will return a series of Coder logs, however, embedded in the launch is the URL for accessing Coder. |
| 96 | + |
| 97 | +<img src="../images/quickstart/aws/aws8.png"> |
| 98 | + |
| 99 | +In this instance, Coder can be accessed at the url `https://fccad1b6c901511b30cf2cf4fbd0973e.pit-1.try.coder.app`. |
| 100 | + |
| 101 | +Copy the URL and run the following command to create the first user, either on your local machine or in the AWS EC2 instance terminal. |
| 102 | + |
| 103 | +```sh |
| 104 | +coder login <url***.try.coder.app> |
| 105 | +``` |
| 106 | + |
| 107 | +Fill out the prompts. Be sure to save use email and password as these are your admin username and password. |
| 108 | + |
| 109 | +You can now access Coder on your local machine with the relevant `***.try.coder.app` URL and logging in with the username and password. |
| 110 | + |
| 111 | +## Creating and Uploading Your First Template |
| 112 | + |
| 113 | +Run `coder template init` to create your first template. You’ll be given a list of possible templates. This tutorial will show you how to set up your Coder instance to create Linux based machines on AWS. |
| 114 | + |
| 115 | +<img src="../images/quickstart/aws/aws9.png"> |
| 116 | + |
| 117 | +Press `enter` to select `Develop in Linux` on AWS template. This will return the following: |
| 118 | + |
| 119 | +<img src="../images/quickstart/aws/aws10.png"> |
| 120 | + |
| 121 | +Now, we must install the AWS CLI and authorize the template. Follow [these instructions to install the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html) and [add your credentials](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-quickstart.html). |
| 122 | + |
| 123 | +Coder runs as a system service under a system user `coder`. The `coder` user will require access to the AWS credentials to initialize the template and provision workspaces. |
| 124 | + |
| 125 | +Run the following command to create a folder for the AWS credentials to live in: |
| 126 | + |
| 127 | +```sh |
| 128 | +sudo mkdir /home/coder/.aws |
| 129 | +``` |
| 130 | + |
| 131 | +Run the following commands to copy the AWS credentials and give the `coder` user access to them: |
| 132 | + |
| 133 | +```sh |
| 134 | +sudo cp ~/.aws/credentials /home/coder/.aws/credentials |
| 135 | +sudo chown coder:coder /home/coder/.aws/credentials |
| 136 | +``` |
| 137 | + |
| 138 | +Navigate to the `./aws-linux` folder where you created your template and run the following command to put the template on your Coder instance. |
| 139 | + |
| 140 | +```sh |
| 141 | +coder templates create |
| 142 | +``` |
| 143 | + |
| 144 | +Congrats! You can now navigate to your Coder dashboard and use this Linux on AWS template to create a new workspace! |
0 commit comments