Skip to content

Add AWS and Azure quickstarts #4176

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Oct 3, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
adding ammar and ben edits
  • Loading branch information
Ali Diamond committed Sep 28, 2022
commit 03799a9b783fd2a472d5957d49ae46fa85526046
12 changes: 6 additions & 6 deletions docs/quickstart/aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ On the EC2 dashboard, click `Instances`. This will take you to all the EC2 insta

For this tutorial, we are going to launch this as the base Ubuntu server.

For the `Create key pair`, we are using ED25519 and .pem as we will SSH into the instance later in the tutorial.
For the `Create key pair`, we are using ED25519 and `.pem` as we will SSH into the instance later in the tutorial.
<img src="../images/quickstart/aws/aws4.png">

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.
Expand All @@ -45,13 +45,13 @@ You will also need the IP address of the server. Click on the server in the `Ins

<img src="../images/quickstart/aws/aws6.png">

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:
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:

```sh
chmod 400 [mykey].pem
```

This adds the required permissions for ssh-ing into an EC2 instance.
This adds the required permissions for SSH-ing into an EC2 instance.

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:

Expand All @@ -63,7 +63,7 @@ Congrats you’ve SSH’d into the server.

## Install Coder

For this instance, we will run Coder as a service command, 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).
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).

In the EC2 instance, run the following command to install Coder

Expand Down Expand Up @@ -104,7 +104,7 @@ Copy the URL and run the following command to create the first user, either on y
coder login <url***.try.coder.app>
```

Fill out the prompts - be sure to save use email and password - these are your admin username and password.
Fill out the prompts. Be sure to save use email and password as these are your admin username and password.

You can now access Coder on your local machine with the relevant `***.try.coder.app` URL and logging in with the username and password.

Expand All @@ -128,7 +128,7 @@ Run the following command to create a folder for the AWS credentials to live in:
sudo mkdir /home/coder/.aws
```

Then run the following commands to copy the credentials and give the `coder` user access to them:
Run the following commands to copy the AWS credentials and give the `coder` user access to them:

```sh
sudo cp ~/.aws/credentials /home/coder/.aws/credentials
Expand Down
12 changes: 6 additions & 6 deletions docs/quickstart/azure.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
## Requirements
To get started running Coder on Azure, you will need an Azure account with the capability to create new Virtual Machines.

This quickstart will show you how to set up the Coder server on Azure and then set up an Azure hosted Linux based workspace, which allows users to create there own instances of these workspaces and use the Coder product. This quickstart assumes you have access to admin level access to Azure.

## Create An Azure VM

Expand Down Expand Up @@ -27,13 +28,13 @@ Click `Return to create a virtual machine`. Your VM will start up!

<img src="../images/quickstart/azure/azure6.png">

Click `Go to resource` in the Virtual machine and copy the public IP address. You will need it to SSH into the virtual machine via your local machine.
Click `Go to resource` in the virtual machine and copy the public IP address. You will need it to SSH into the virtual machine via your local machine.

Follow [these instructions](https://learn.microsoft.com/en-us/azure/virtual-machines/linux-vm-connect?tabs=Linux) to SSH into the virtual machine. Once on the VM, you can run and install Coder using your method of choice. For the fastest install, we recommend running Coder as a system service.

## Install Coder

For this instance, we will run Coder as a service command, 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).
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).

In the Azure VM instance, run the following command to install Coder

Expand Down Expand Up @@ -62,8 +63,7 @@ The following command will get you information about the Coder launch service
journalctl -u coder.service -b
```

This will return a series of Coder logs, however, embedded in the launch is the URL for accessing Coder.

This will return a series of logs related to running Coder as a system service. Embedded in the logs is the Coder Access URL.

Copy the URL and run the following command to create the first user, either on your local machine or in the instance terminal.

Expand All @@ -87,7 +87,7 @@ Press `enter` to select `Develop in Linux on Azure` template. This will return t

To get started using the Azure template, install the Azure CLI by following the instructions [here](https://learn.microsoft.com/en-us/cli/azure/install-azure-cli-linux?pivots=apt). Run `az login` and follow the instructions to configure the Azure command line.

For this example, Coder was run as a system level service, which creates the system user `coder` for handling processes. The Coder user will require access to the Azure credentials to initialize the template.
Coder is running as a system service, which creates the system user `coder` for handling processes. The Coder user will require access to the Azure credentials to initialize the template.

Run the following commands to copy the Azure credentials and give the `coder` user access to them:

Expand Down