From d5083713c460b03490d173bf411512773b5b76cf Mon Sep 17 00:00:00 2001 From: Ammar Bandukwala Date: Tue, 4 Oct 2022 17:20:55 +0000 Subject: [PATCH 1/2] Fix up new quickstarts --- docs/quickstart/aws.md | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/docs/quickstart/aws.md b/docs/quickstart/aws.md index 4fca0d1705b91..b709aaf60a0e3 100644 --- a/docs/quickstart/aws.md +++ b/docs/quickstart/aws.md @@ -1,8 +1,8 @@ # Amazon Web Services -## Requirements +## Requirements -This quickstart assumes you are assigned `AdministratorAccess` policy to AWS. +This quickstart assumes you are assigned the `AdministratorAccess` policy to AWS. ## Setting Up Security Groups for EC2 @@ -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 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. @@ -55,7 +55,7 @@ chmod 400 [mykey].pem 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: +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: ```sh ssh -i [mykey].pem username@ip-address @@ -80,6 +80,7 @@ First, edit the `coder.env` file to enable `CODER_TUNNEL` by setting the value t ```sh sudo vim /etc/coder.d/coder.env ``` + Exit vim and run the following command to start Coder as a system level service: @@ -100,7 +101,7 @@ This will return a series of Coder logs, however, embedded in the launch is the In this instance, Coder can be accessed at the url `https://fccad1b6c901511b30cf2cf4fbd0973e.pit-1.try.coder.app`. -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. +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. ```sh coder login @@ -108,15 +109,15 @@ coder login 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. +You can now access Coder on your local machine with the relevant `***.try.coder.app` URL and logging in with the username and password. ## Creating and Uploading Your First Template -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. +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. -Press `enter` to select `Develop in Linux` on AWS template. This will return the following: +Press `enter` to select `Develop in Linux` on AWS template. This will return the following: @@ -133,11 +134,11 @@ sudo mkdir /home/coder/.aws 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 +sudo cp ~/.aws/credentials /home/coder/.aws/credentials sudo chown coder:coder /home/coder/.aws/credentials ``` -Navigate to the `./aws-linux` folder where you created your template and run the following command to put the template on your Coder instance. +Navigate to the `./aws-linux` folder where you created your template and run the following command to put the template on your Coder instance. ```sh coder templates create From 4e9c8d325fe6a2db6e14e99c2603c381264ffebb Mon Sep 17 00:00:00 2001 From: Ammar Bandukwala Date: Tue, 4 Oct 2022 17:30:58 +0000 Subject: [PATCH 2/2] docs: add clarity to new Quickstarts - And fix Telemetry in manifest.json --- docs/images/icons/science.svg | 1 + docs/manifest.json | 10 ++-------- docs/quickstart/aws.md | 7 +++++-- docs/quickstart/azure.md | 28 +++++++++++++++------------- docs/quickstart/docker.md | 2 +- 5 files changed, 24 insertions(+), 24 deletions(-) create mode 100644 docs/images/icons/science.svg diff --git a/docs/images/icons/science.svg b/docs/images/icons/science.svg new file mode 100644 index 0000000000000..5e97fc814cd67 --- /dev/null +++ b/docs/images/icons/science.svg @@ -0,0 +1 @@ + diff --git a/docs/manifest.json b/docs/manifest.json index ca4f9cb7eb09c..d5f2c68c8ccb8 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -207,17 +207,11 @@ "description": "Learn how to enable Enterprise features.", "icon_path": "./images/icons/group.svg", "path": "./admin/enterprise.md" - } - ] - }, - { - "title": "Admin", - "description": "How to administer and manage Coder", - "icon_path": "./images/icons/gear.svg", - "children": [ + }, { "title": "Telemetry", "description": "Learn what usage telemetry Coder collects", + "icon_path": "./images/icons/science.svg", "path": "./admin/telemetry.md" } ] diff --git a/docs/quickstart/aws.md b/docs/quickstart/aws.md index b709aaf60a0e3..13a5bb8498f9c 100644 --- a/docs/quickstart/aws.md +++ b/docs/quickstart/aws.md @@ -1,8 +1,11 @@ # Amazon Web Services +This quickstart shows you how to set up the Coder server on AWS which will +provision AWS-hosted, Linux workspaces. + ## Requirements -This quickstart assumes you are assigned the `AdministratorAccess` policy to AWS. +This quickstart assumes you are assigned the `AdministratorAccess` policy on AWS. ## Setting Up Security Groups for EC2 @@ -148,6 +151,6 @@ Congrats! You can now navigate to your Coder dashboard and use this Linux on AWS ## Next Steps -- [Port-forward](../networking/port-forwarding.md.md) +- [Port-forward](../networking/port-forwarding.md) - [Learn more about template configuration](../templates.md) - [Configure more IDEs](../ides/web-ides.md) diff --git a/docs/quickstart/azure.md b/docs/quickstart/azure.md index 73d53da813c66..0b77406cf31bd 100644 --- a/docs/quickstart/azure.md +++ b/docs/quickstart/azure.md @@ -1,10 +1,11 @@ # Microsoft Azure -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 shows you how to set up the Coder server on Azure which will +provision Azure-hosted Linux workspaces. -## Requirements +## Requirements -This quickstart assumes you have access to admin level access to Azure. +This quickstart assumes you have full administrator privileges on Azure. ## Create An Azure VM @@ -24,11 +25,11 @@ Up next, under `Inbound port rules` modify the Select `inbound ports` to also ta -The set up for the image is complete at this stage. Click `Review and Create` - review the information and click `Create`. A popup will appear asking you to download the key pair for the server. Click `Download private key and create resource` and place it into a folder of your choice on your local system. +The set up for the image is complete at this stage. Click `Review and Create` - review the information and click `Create`. A popup will appear asking you to download the key pair for the server. Click `Download private key and create resource` and place it into a folder of your choice on your local system. -Click `Return to create a virtual machine`. Your VM will start up! +Click `Return to create a virtual machine`. Your VM will start up! @@ -53,6 +54,7 @@ First, edit the `coder.env` file to enable `CODER_TUNNEL` by setting the value t ```sh sudo vim /etc/coder.d/coder.env ``` + Exit vim and run the following command to start Coder as a system level service: @@ -69,7 +71,7 @@ The following command will get you information about the Coder launch service 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. +Copy the URL and run the following command to create the first user, either on your local machine or in the instance terminal. ```sh coder login @@ -77,30 +79,30 @@ coder login 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. +You can now access Coder on your local machine with the relevant `***.try.coder.app` URL and logging in with the username and password. ## Creating and Uploading Your First Template -First, run `coder template init` to create your first template. You’ll be given a list of possible templates to use. This tutorial will show you how to set up your Coder instance to create a Linux based machine on Azure. +First, run `coder template init` to create your first template. You’ll be given a list of possible templates to use. This tutorial will show you how to set up your Coder instance to create a Linux based machine on Azure. -Press `enter` to select `Develop in Linux on Azure` template. This will return the following: +Press `enter` to select `Develop in Linux on Azure` template. This will return the following: -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. +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. 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: ```sh -sudo cp -r ~/.azure /home/coder/.azure +sudo cp -r ~/.azure /home/coder/.azure sudo chown -R coder:coder /home/coder/.azure/ ``` -Navigate to the `./azure-linux` folder where you created your template and run the following command to put the template on your Coder instance. +Navigate to the `./azure-linux` folder where you created your template and run the following command to put the template on your Coder instance. ```sh coder templates create @@ -110,6 +112,6 @@ Congrats! You can now navigate to your Coder dashboard and use this Linux on Azu ## Next Steps -- [Port-forward](../networking/port-forwarding.md.md) +- [Port-forward](../networking/port-forwarding.md) - [Learn more about template configuration](../templates.md) - [Configure more IDEs](../ides/web-ides.md) diff --git a/docs/quickstart/docker.md b/docs/quickstart/docker.md index 9eee190e244ff..3f17877a2cc6e 100644 --- a/docs/quickstart/docker.md +++ b/docs/quickstart/docker.md @@ -61,6 +61,6 @@ Coder with Docker has the following advantages: ## Next Steps -- [Port-forward](../networking/port-forwarding.md.md) +- [Port-forward](../networking/port-forwarding.md) - [Learn more about template configuration](../templates.md) - [Configure more IDEs](../ides/web-ides.md)