updates user docs

Signed-off-by: Michael Hausenblas <hausenbl@amazon.com>
mhausenblas · Jan 7, 2020 · cd15ab5 · cd15ab5
1 parent 0d83de3
commit cd15ab5
Show file tree

Hide file tree

Showing 3 changed files with 68 additions and 11 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -1,5 +1,3 @@
-# awsometag
-
 If you want to tag AWS resources via the CLI in a uniform manner, then `awsometag` might be just the tool you're looking for.
 
 ## Install it
@@ -37,13 +35,38 @@ Hence, the general usage pattern for `awsometag` is:
 $ awsometag RESOURCE_ARN "TAG_KEY1=TAG_VAL1,TAG_KEY2=TAG_VAL2,..."
 ```
 
-Currently, `awsometag` supports tagging resources in:
+## Supported resources
+
+Currently, `awsometag` supports tagging resources for the following services:
+
+**Fundamental** services:
 
-- AWS Identity and Access Management: users, roles
-- Amazon Simple Storage Service:  buckets, objects
+- AWS Identity and Access Management:
+    - users
+    - roles
+- Amazon Simple Storage Service:
+    - buckets
+    - objects
 - AWS Lambda: functions
 - Amazon DynamoDB: tables
 - Amazon Elastic Compute Cloud: all resources
+
+**Networking** services:
+
+- Elastic Load Balancing:
+    - Classic LBs
+    - ALBs
+    - NLBs
+
+**Container** services:
+
 - Amazon Elastic Container Registry: repositories
-- Amazon Elastic Container Service: capacity providers, clusters, tasks, task definitions, services, and container instances
-- Amazon Elastic Kubernetes Service: clusters, managed node groups
+- Amazon Elastic Container Service:
+    - capacity providers
+    - clusters
+    - tasks and task definitions
+    - services
+    - container instances
+- Amazon Elastic Kubernetes Service:
+    - clusters
+    - managed node groups
diff --git a/docs/networking.md b/docs/networking.md
@@ -26,6 +26,37 @@ $ aws elbv2 describe-tags \
 }
 ```
 
+!!! note
+    In the same way that you can tag an ALB, you can tag an NLB. You can tell the
+    difference in the type by looking at the ARN: `loadbalancer/app` vs `loadbalancer/net`.
+
+If you want to tag a classic LB, say `my-test-clb`, then you'd need to assemble the
+ARN yourself (based on region, account ID) since CLBs don't deal with ARNs explicitly.
+Then, use:
+
+```sh
+# tag
+$ awsometag arn:aws:elasticloadbalancing:us-west-2:123456789102:loadbalancer/my-test-clb some=thing
+2020/01/07 11:31:46 Tagging classic load balancer 'my-test-clb' in region 'us-west-2' with some:thing
+
+# verify the tagging:
+$ aws elb describe-tags \
+      --load-balancer-names my-test-clb
+{
+    "TagDescriptions": [
+        {
+            "LoadBalancerName": "my-test-clb",
+            "Tags": [
+                {
+                    "Key": "some",
+                    "Value": "thing"
+                }
+            ]
+        }
+    ]
+}
+```
+
 !!! tip
-    The original elastic load balancer uses the [API v1](https://docs.aws.amazon.com/cli/latest/reference/elb/), while ALBs and NLBs are 
-    using [v2 of the API](https://docs.aws.amazon.com/cli/latest/reference/elbv2/).
+    The classic ELB (or: Classic Load Balancer, CLB for short) uses the [API v1](https://docs.aws.amazon.com/cli/latest/reference/elb/),
+    while "next generation" ELBs, that is, ALBs and NLBs, are using [v2 of the API](https://docs.aws.amazon.com/cli/latest/reference/elbv2/).
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -5,16 +5,19 @@ repo_name: 'mhausenblas/awsometag'
 repo_url: 'https://github.com/mhausenblas/awsometag'
 copyright: 'Copyright &copy; 2020 Amazon'
 nav:
-    - Home: index.md
+    - Overview: index.md
     - Fundamental: fundamental.md
     - Networking: networking.md
     - Containers: containers.md
     - About: about.md
 theme:
     name: 'material'
+    font:
+      text: 'Lato'
+      code: 'PT Mono'
     palette:
       primary: 'orange'
-      accent: 'amber'
+      accent: 'blue'
     highlightjs: true
     hljs_languages:
         - yaml