Update readmes for webserver, fix formatting in url-shortener readme (pulumi#30)

lindydonna · web-flow · commit 71fd0bd806d1 · 2018-03-28T19:58:28.000-07:00
diff --git a/url-shortener/README.md b/url-shortener/README.md
@@ -8,49 +8,49 @@ A sample URL shortener SPA that uses the high-level `cloud.Table` and `cloud.Htt
 
 1. Create a new stack:
 
-  ```
-  $ pulumi stack init
-  Enter a stack name: url-shortener-test
-  ```
+    ```
+    $ pulumi stack init
+    Enter a stack name: url-shortener-test
+    ```
 
 1. Set the provider and region:
 
-  ```
-  $ pulumi config set cloud:provider aws
-  $ pulumi config set aws:region us-west-2
-  ```
+    ```
+    $ pulumi config set cloud:provider aws
+    $ pulumi config set aws:region us-west-2
+    ```
 
 1. Compile the program via `tsc` or `npm run build`.
 
 1. Preview the program deployment:
 
-  ```
-  $ pulumi preview
-  [many lines elided...]
-  ---outputs:---
-  endpointUrl: computed<string>
-  info: 48 changes previewed:
-      + 48 resources to create
-  ```
+    ```
+    $ pulumi preview
+    [many lines elided...]
+    ---outputs:---
+    endpointUrl: computed<string>
+    info: 48 changes previewed:
+        + 48 resources to create
+    ```
 
 1. Perform the deployment:
 
-  ```
-  $ pulumi update
-  [many lines elided...]
-  ---outputs:---
-  endpointUrl: "https://gs8t66u634.execute-api.us-east-1.amazonaws.com/stage/"
-  info: 48 changes performed:
-      + 48 resources created
-  Update duration: 4m7.023449447s
-  ```
+    ```
+    $ pulumi update
+    [many lines elided...]
+    ---outputs:---
+    endpointUrl: "https://gs8t66u634.execute-api.us-east-1.amazonaws.com/stage/"
+    info: 48 changes performed:
+        + 48 resources created
+    Update duration: 4m7.023449447s
+    ```
 
 1. The API endpoint will be shown as the value for `endpointUrl` in the CLI output. You can always get this value by running `pulumi stack output`:
 
-  ```
-  $ pulumi stack output endpointUrl
-  https://gs8t66u634.execute-api.us-east-1.amazonaws.com/stage/
-  ```
+    ```
+    $ pulumi stack output endpointUrl
+    https://gs8t66u634.execute-api.us-east-1.amazonaws.com/stage/
+    ```
 
 1. Open this page in a browser and you'll see a single page app for creating and viewing short URLs.
 
diff --git a/webserver-component/README.md b/webserver-component/README.md
@@ -0,0 +1,5 @@
+# AWS web server component example
+
+Deploy an EC2 instances using `@pulumi/aws`, using a common module for creating an instance. A function `createInstance` is defined in [webserver.js](webserver.js) which is then used in main program.
+
+For a detailed walkthrough, see [Programming AWS](https://docs.pulumi.com/quickstart/aws.html) in the Pulumi documentation.
diff --git a/webserver-zones/README.md b/webserver-zones/README.md
@@ -1,3 +1,85 @@
 # Pulumi web server with availability zones
 
-Pulumi example that deploys multiple EC2 instances, one in each availability zone for the region.
+Pulumi example that deploys multiple EC2 instances, one in each availability zone for the region. The example uses `aws.getAvailabilityZones()` which calls an an AWS API to retrieve all availability zones for the selected region. The program then loops over these AZs and creates an EC2 instance in each zone.
+
+This example shows how to use dynamic data when deploying infrastructure. 
+
+## Deploying and running the program
+
+1. Run `pulumi init`. (Note: this command will not be required in a future SDK release.)
+
+1. Create a new stack:
+
+    ```
+    $ pulumi stack init
+    Enter a stack name: webserver-testing
+    ```
+
+1. Set the provider and region, such as `us-west-2`:
+
+    ```
+    $ pulumi config set cloud:provider aws
+    $ pulumi config set aws:region us-west-2
+    ```
+
+1. Compile the program via `tsc` or `npm run build`.
+
+1. Preview the program deployment:
+
+    ```
+    $ pulumi preview
+    [... many lines elided ...]
+    ---outputs:---
+    serverUrls: [
+        [0]: computed<string>
+        [1]: computed<string>
+        [2]: computed<string>
+    ]
+    info: 5 changes previewed:
+        + 5 resources to create
+    ```
+
+1. Perform the deployment. Depending on the region you've selected, you should see two or three EC2 instances created.
+
+    ```
+    $ pulumi update
+    [... many lines elided ...]
+    ---outputs:---
+    serverUrls: [
+        [0]: "http://ec2-54-148-246-71.us-west-2.compute.amazonaws.com"
+        [1]: "http://ec2-34-213-186-185.us-west-2.compute.amazonaws.com"
+        [2]: "http://ec2-52-33-17-194.us-west-2.compute.amazonaws.com"
+    ]
+    info: 5 changes performed:
+        + 5 resources created
+    Update duration: 57.392733427s    
+    ```
+
+1. View the stack output:
+
+    ```
+    $ pulumi stack output serverUrls
+    ["http://ec2-54-148-246-71.us-west-2.compute.amazonaws.com","http://ec2-34-213-186-185.us-west-2.compute.amazonaws.com","http://ec2-52-33-17-194.us-west-2.compute.amazonaws.com"]
+    ```
+
+1. Call `curl` on one of the endpoints:
+
+    ```
+    $ curl http://ec2-54-148-246-71.us-west-2.compute.amazonaws.com
+    Hello, World!
+    Instance metadata:
+    us-west-2a
+    ```
+
+### Delete resources
+
+When you're done, run `pulumi destroy` to delete the program's resources:
+
+```
+$ pulumi destroy
+This will permanently destroy all resources in the 'webserver-testing' stack!
+Please confirm that this is what you'd like to do by typing ("webserver-testing"): webserver-testing
+```
+
+
+
diff --git a/webserver/README.md b/webserver/README.md
@@ -1,3 +1,3 @@
-# Pulumi web server
+# AWS web server example
 
-Starting point for building the Pulumi web server sample.
+Deploy an EC2 instance using `@pulumi/aws`. This example shows how to use multiple infrastructure resources in one program. For a detailed walkthrough, see [Programming AWS](https://docs.pulumi.com/quickstart/aws.html) in the Pulumi documentation.
