Add an example

Author: debovema

README.md

@@ -4,11 +4,16 @@
 
 This Terraform module can be used to create cheap and disposable development machines with Scaleway cloud provider. For instance, these machines are well suited to be used with [Visual Studio Code SSH remote developement feature](https://code.visualstudio.com/docs/remote/ssh).
 
+## Examples
+
+* [Full-featured development instance on a Scaleway DEV1-S instance running Ubuntu 20.04](examples/ubuntu_dev1-s_full)
+
 ## Prerequisites
 
 * Terraform 1.0+
-* [jq](https://stedolan.github.io/jq/)
 * A [Scaleway project](https://console.scaleway.com/project/) (default project is fine but [creating a new one](https://www.scaleway.com/en/docs/scaleway-project/) is encouraged)
+* Git, OpenSSH
+* [jq](https://stedolan.github.io/jq/) (only for magic commands)
 
 ## Introduction
 
@@ -20,16 +25,18 @@ set_tfvar() { ( [ $(grep "$1" terraform.tfvars 2>/dev/null | wc -l) -gt 0 ] && s
 
 > This shell function takes two arguments (the variable key and value) and put the *key = value* in the *terraform.tfvars* file regardless of the existence of the variable (create or replace behaviour)
 
-2. Create your SSH key pair and [add it in your authorized keys](https://console.scaleway.com/project/credentials)
+2. Create your SSH key pair and [add the public key in authorized keys of your Scleway project in the Scaleway console](https://console.scaleway.com/project/credentials)
 
 ```
 ssh-keygen -t rsa -b 4096 -q -C 'scaleway' -N '' -f ~/.ssh/scaleway
 ```
 
-> Add the SSH key file in Terraform variables
-> ```
-> set_tfvar ssh_key_file '"~/.ssh/scaleway"'
-> ```
+> if using an existing SSH key, it is assumed its name is *~/.ssh/scaleway*
+
+Add the SSH key file in Terraform variables
+```
+set_tfvar ssh_key_file '"~/.ssh/scaleway"'
+```
 
 3. [Retrieve your project credentials](https://console.scaleway.com/project/credentials) and export them:
 
@@ -43,21 +50,28 @@ export SCW_DEFAULT_ZONE=fr-par-1
 
 ## Usage
 
-1. Initialize Terraform
+1. Clone this repository
+
+```
+git clone https://github.com/debovema/terraform-scaleway-dev-instance.git
+cd terraform-scaleway-dev-instance
+```
+
+2. Initialize Terraform
 
 ```
 terraform init
 ```
 
-2. Define username
+3. Define username
 
 ```
 set_tfvar username '"developer"'
 ```
 
 > Mind the double quotes
 
-3. Select optional features
+4. Select optional features
 
 * [Oh My ZSH](https://ohmyz.sh/):
 ```
@@ -79,12 +93,12 @@ set_tfvar feature_nvm true
 set_tfvar feature_sdkman true
 ```
 
-4. Apply default plan
+5. Apply default plan
 ```
 terraform apply
 ```
 
-5. SSH to the (first) created host
+6. SSH to the (first) created host
 
 ```
 eval `terraform output --json ssh_commands | jq -r ".[0]"`

examples/ubuntu_dev1-s_full/.terraform.lock.hcl

@@ -0,0 +1,62 @@
+# Example : Full-featured development instance on a Scaleway DEV1-S instance running Ubuntu 20.04
+
+Read the [module documentation](../../README.md) for further explanation.
+
+## Prerequisites
+
+* Terraform 1.0+
+* A [Scaleway project](https://console.scaleway.com/project/) (default project is fine but [creating a new one](https://www.scaleway.com/en/docs/scaleway-project/) is encouraged)
+* curl, OpenSSH
+* [jq](https://stedolan.github.io/jq/) (only for magic commands)
+
+## Introduction
+
+1. Create your SSH key pair and [add the public key in authorized keys of your Scleway project in the Scaleway console](https://console.scaleway.com/project/credentials)
+
+```
+ssh-keygen -t rsa -b 4096 -q -C 'scaleway' -N '' -f ~/.ssh/scaleway
+```
+
+> if using an existing SSH key, it is assumed its name is *~/.ssh/scaleway*
+
+2. [Retrieve your project credentials](https://console.scaleway.com/project/credentials) and export them:
+
+```
+export SCW_DEFAULT_PROJECT_ID=<REDACTED>
+export SCW_ACCESS_KEY=<REDACTED>
+export SCW_SECRET_KEY=<REDACTED>
+export SCW_DEFAULT_REGION=fr-par
+export SCW_DEFAULT_ZONE=fr-par-1
+```
+
+## Usage
+
+1. Retrieve the (root) Terraform module of this example
+
+```
+mkdir ubuntu_dev1-s_full
+cd ubuntu_dev1-s_full
+curl -fsSL -O https://raw.githubusercontent.com/debovema/terraform-scaleway-dev-instance/main/examples/ubuntu_dev1-s_full/main.tf
+```
+
+2. Initialize Terraform
+
+```
+terraform init
+```
+
+3. Apply default plan
+```
+terraform apply
+```
+
+4. SSH to the (first) created host
+
+```
+eval `terraform output --json ssh_commands | jq -r ".[0]"`
+```
+
+> To display the SSH command used to connect:
+> ```
+> echo $(terraform output --json ssh_commands | jq -r ".[0]")
+> ```

examples/ubuntu_dev1-s_full/README.md

@@ -0,0 +1,28 @@
+//--------------------------------------------------------------------
+// Variables
+variable "dev_ssh_key_file" { default = "~/.ssh/scaleway" }
+variable "dev_username" { default = "developer" }
+
+//--------------------------------------------------------------------
+// Modules
+module "dev" {
+  source  = "app.terraform.io/scwdev/dev/scaleway"
+  version = "0.0.2"
+
+  feature_docker = "true"
+  feature_nvm = "true"
+  feature_omz = "true"
+  feature_sdkman = "true"
+  ssh_key_file = var.dev_ssh_key_file
+  username = var.dev_username
+}
+
+//--------------------------------------------------------------------
+// Outputs
+output "public_ips" {
+  value = module.dev.public_ips
+}
+
+output "ssh_commands" {
+  value = module.dev.ssh_commands
+}