|
1 | 1 | # Amazon Web Services |
2 | 2 |
|
3 | | -This quickstart shows you how to set up the Coder server on AWS which will |
4 | | -provision AWS-hosted, Linux workspaces. |
| 3 | +This quickstart is designed to get you up and running with a Coder proof-of-concept VM on AWS EC2 using a [Coder-provided AMI](https://github.com/coder/packages). If you are familiar with EC2 however, you can use our [install script](../install/install.sh.md) to run Coder on any popular Linux distribution. |
5 | 4 |
|
6 | 5 | ## Requirements |
7 | 6 |
|
8 | | -This quickstart assumes you are assigned the `AdministratorAccess` policy on AWS. |
| 7 | +This quickstart assumes your AWS account has `AmazonEC2FullAccess` permissions. |
9 | 8 |
|
10 | | -## Setting Up Security Groups for EC2 |
| 9 | +## Launch a Coder instance from the from AWS Marketplace |
11 | 10 |
|
12 | | -To set up a security group for an EC2 instance, navigate to the AWS EC2 Dashboard. In the side panel click `Security Groups`. |
| 11 | +We publish an Ubuntu 22.04 AMI with Coder and Docker pre-installed. Search for `Coder` in the EC2 "Launch an Instance" screen or [launch directly from the marketplace](https://aws.amazon.com/marketplace/pp/prodview-5gxjyur2vc7rg). |
13 | 12 |
|
14 | | -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. |
| 13 | + |
15 | 14 |
|
16 | | -<img src="../images/quickstart/aws/aws1.png"> |
| 15 | +Be sure to keep the default firewall (SecurityGroup) options checked so you can connect over HTTP, HTTPS, and SSH. |
17 | 16 |
|
18 | | -For ease of use, we are going to set this up using the simplest rules. |
| 17 | + |
19 | 18 |
|
20 | | -<img src="../images/quickstart/aws/aws2.png"> |
| 19 | +We recommend at least 4 cores and 16 GB memory if you plan on provisioning Docker containers as workspaces on this EC2 instance. Keep in mind this quickstart is intended for proof-of-concept deployments and you should adjust your infrastructure when preparing for production use. |
21 | 20 |
|
22 | | -Create a new `Inbound Rule` that allows for SSH from your computer’s IP address. |
| 21 | +Be sure to add a keypair so that you can connect over SSH to further [configure Coder](../admin/configure.md). |
23 | 22 |
|
24 | | -You’ve now created a security group that will be used by your EC2 instance. |
| 23 | +After launching the instance, wait 30 seconds and navigate to the public IPv4 address. You should be redirected to a public tunnel URL. |
25 | 24 |
|
26 | | -## Setting Up Your EC2 instance |
| 25 | +<video playsinline loop> |
| 26 | + <source src="https://github.com/coder/coder/blob/main/docs/images/quickstart/aws/launch.mp4" type="video/mp4"> |
| 27 | +Your browser does not support the video tag. |
| 28 | +</video> |
27 | 29 |
|
28 | | -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. |
| 30 | +That's all! Use the UI to create your first user, template, and workspace. We recommend starting with a Docker template since the instance has Docker pre-installed. |
29 | 31 |
|
30 | | -<img src="../images/quickstart/aws/aws3.png"> |
| 32 | + |
31 | 33 |
|
32 | | -For this tutorial, we are going to launch this as the base Ubuntu server. |
| 34 | +## Configuring Coder server |
33 | 35 |
|
34 | | -For the `Create key pair`, we are using ED25519 and `.pem` as we will SSH into the instance later in the tutorial. |
35 | | -<img src="../images/quickstart/aws/aws4.png"> |
| 36 | +Coder is primarily configured by server-side flags and environment variables. Given you created or added key-pairs when launching the instance, you can [configure your Coder deployment](../admin/configure.md) by logging in via SSH or using the console: |
36 | 37 |
|
37 | | -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. |
38 | | - |
39 | | -You don’t need to change anything else - click `Launch Instance`. |
40 | | - |
41 | | -<img src="../images/quickstart/aws/aws5.png"> |
42 | | - |
43 | | -It’ll take a few minutes for it to show up in your existing instances, so take a break as it starts up. |
44 | | - |
45 | | -## SSHing into the EC2 instance |
46 | | - |
47 | | -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`. |
48 | | - |
49 | | -You will also need the IP address of the server. Click on the server in the `Instances` dashboard, and copy the IPv4 address |
50 | | - |
51 | | -<img src="../images/quickstart/aws/aws6.png"> |
52 | | - |
53 | | -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: |
54 | | - |
55 | | -```console |
56 | | -chmod 400 [mykey].pem |
57 | | -``` |
58 | | - |
59 | | -This adds the required permissions for SSH-ing into an EC2 instance. |
60 | | - |
61 | | -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: |
62 | | - |
63 | | -```console |
64 | | -ssh -i [mykey].pem username@ip-address |
65 | | -``` |
66 | | - |
67 | | -Congrats you’ve SSH’d into the server. |
68 | | - |
69 | | -## Install Coder |
70 | | - |
71 | | -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). |
72 | | - |
73 | | -In the EC2 instance, run the following command to install Coder |
74 | | - |
75 | | -```console |
76 | | -curl -fsSL https://coder.com/install.sh | sh |
77 | | -``` |
78 | | - |
79 | | -## Run Coder |
80 | | - |
81 | | -Run the following command to start Coder as a system level service: |
82 | | - |
83 | | -```console |
84 | | -sudo systemctl enable --now coder |
85 | | -``` |
86 | | - |
87 | | -The following command will get you information about the Coder launch service |
88 | | - |
89 | | -```console |
90 | | -journalctl -u coder.service -b |
| 38 | +```sh |
| 39 | +ssh ubuntu@<ec2-public-IPv4> |
91 | 40 | ``` |
92 | 41 |
|
93 | | -This will return a series of Coder logs, however, embedded in the launch is the URL for accessing Coder. |
94 | | - |
95 | | -<img src="../images/quickstart/aws/aws8.png"> |
96 | | - |
97 | | -In this instance, Coder can be accessed at the url `https://fccad1b6c901511b30cf2cf4fbd0973e.pit-1.try.coder.app`. |
98 | | - |
99 | | -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. |
100 | | - |
101 | | -```console |
102 | | -coder login <url***.try.coder.app> |
103 | | -``` |
104 | | - |
105 | | -Fill out the prompts. Be sure to save use email and password as these are your admin username and password. |
106 | | - |
107 | | -You can now access Coder on your local machine with the relevant `***.try.coder.app` URL and logging in with the username and password. |
| 42 | +## Give developers EC2 workspaces (optional) |
108 | 43 |
|
109 | | -## Creating and Uploading Your First Template |
| 44 | +Instead of running containers on the Coder instance, you can offer developers full EC2 instances with the [aws-linux](https://github.com/coder/coder/tree/main/examples/templates/aws-linux) template. |
110 | 45 |
|
111 | | -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. |
| 46 | +Before you add the AWS template from the dashboard or CLI, you'll need to modify the instance IAM role. |
112 | 47 |
|
113 | | -<img src="../images/quickstart/aws/aws9.png"> |
| 48 | + |
114 | 49 |
|
115 | | -Press `enter` to select `Develop in Linux` on AWS template. This will return the following: |
| 50 | +You must create or select a role that has `EC2FullAccess` permissions or a limited [Coder-specific permissions policy](https://github.com/coder/coder/tree/main/examples/templates/aws-linux#required-permissions--policy). |
116 | 51 |
|
117 | | -<img src="../images/quickstart/aws/aws10.png"> |
118 | | - |
119 | | -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). |
120 | | - |
121 | | -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. |
122 | | - |
123 | | -Run the following command to create a folder for the AWS credentials to live in: |
124 | | - |
125 | | -```console |
126 | | -sudo mkdir /home/coder/.aws |
127 | | -``` |
128 | | - |
129 | | -Run the following commands to copy the AWS credentials and give the `coder` user access to them: |
130 | | - |
131 | | -```console |
132 | | -sudo cp ~/.aws/credentials /home/coder/.aws/credentials |
133 | | -sudo chown coder:coder /home/coder/.aws/credentials |
134 | | -``` |
135 | | - |
136 | | -Navigate to the `./aws-linux` folder where you created your template and run the following command to put the template on your Coder instance. |
137 | | - |
138 | | -```console |
139 | | -coder templates create |
140 | | -``` |
| 52 | +From there, you can import the AWS starter template in the dashboard and begin creating VM-based workspaces. |
141 | 53 |
|
142 | | -Congrats! You can now navigate to your Coder dashboard and use this Linux on AWS template to create a new workspace! |
| 54 | + |
143 | 55 |
|
144 | | -## Next Steps |
| 56 | +## Next steps |
145 | 57 |
|
146 | | -- [Port-forward](../networking/port-forwarding.md) |
147 | | -- [Learn more about template configuration](../templates.md) |
148 | | -- [Configure more IDEs](../ides/web-ides.md) |
| 58 | +- [IDEs with Coder](../ides.md) |
| 59 | +- [Writing custom templates for Coder](../templates.md) |
| 60 | +- [Configure the Coder server](../admin/configure.md) |
| 61 | +- [Use your own domain + TLS](../admin/configure.md#tls--reverse-proxy) |
0 commit comments