Update README.md and examples

Author: guessi

README.md

@@ -16,11 +16,11 @@ To remove these obstacles, [eks-node-diagnostic](https://github.com/guessi/eks-n
 
 ## 🔢 Prerequisites
 
-* An existing [Amazon EKS](https://docs.aws.amazon.com/eks/latest/userguide/what-is-eks.html) cluster with the node monitoring agent.
+* An existing [Amazon EKS](https://docs.aws.amazon.com/eks/latest/userguide/what-is-eks.html) AutoMode cluster or a cluster with the [Node Monitoring Agent](https://docs.aws.amazon.com/eks/latest/userguide/node-health-nma.html) installed.
 * An existing [kubeconfig](https://docs.aws.amazon.com/eks/latest/userguide/create-kubeconfig.html).
 * [Grant IAM users and roles access to Kubernetes APIs](https://docs.aws.amazon.com/eks/latest/userguide/grant-k8s-access.html).
-* An existing [Amazon S3 bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html) for storing node logs generated by `NodeDiagnostic`. (only required for `destinationType: s3`)
-* An IAM Role/User with [s3:PutObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) permission (to generate presigned S3 url). (only required for `destinationType: s3`)
+* (Only required for `destinationType: s3`) An existing [Amazon S3 bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html) for storing node logs generated by `NodeDiagnostic`.
+* (Only required for `destinationType: s3`) An IAM Role/User with [s3:PutObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) permission (to generate presigned S3 url).
 
 ## 👀 Key differences with [official guidance](https://docs.aws.amazon.com/eks/latest/userguide/auto-get-logs.html)
 
@@ -30,48 +30,39 @@ To remove these obstacles, [eks-node-diagnostic](https://github.com/guessi/eks-n
 
 ## 🚀 Quick start
 
-Make sure you are running with v1.2.0 (or newer version)
+Get `config.yaml` ready, you may find examples at [examples/](./examples/) folder.
 
-```bash
-eks-node-diagnostic version
-```
-
-Get `config.yaml` ready
+Execute
 
 ```bash
-cat config.yaml
----
-region: us-east-1
-expiredSeconds: 300  # optional, default: 300
-timeout: 30          # optional, default: 30 (in seconds)
-destinationType: s3  # optional, default: s3, "s3" or "node"
-bucketName: node-diagnostic-EXAMPLE
-
-# the node name should match the NAME from `kubectl get nodes`
-nodes:
-- i-EXAMPLE1111111111
-- i-EXAMPLE2222222222
-- i-EXAMPLE3333333333
-...
+eks-node-diagnostic [--config-file config.yaml]
 ```
 
-Execute
-
 ```bash
-eks-node-diagnostic
 nodediagnostic.eks.amazonaws.com/i-EXAMPLE1111111111 created
 nodediagnostic.eks.amazonaws.com/i-EXAMPLE2222222222 created
 nodediagnostic.eks.amazonaws.com/i-EXAMPLE3333333333 created
 ...
 ```
 
+Check
+
+```bash
+kubectl describe nodediagnostics
+```
+
 ## :accessibility: FAQ
 
-Where can I find log archive generated by `NodeDiagnostic`?
+Where can I find log archive generated by `NodeDiagnostic` when `destinationType` set as `s3`?
 
 * Log archive generated by `NodeDiagnostic` would be placed at path below,
 
-    > `s3://{{ BUCKET }}/node-diagnostic/log__{{ REGION }}__{{ NODE }}__{{ TIMESTAMP }}.tar.gz`
+    > `s3://{{ BUCKET }}/node-diagnostic/log__{{ REGION }}__{{ NODE_NAME }}__{{ TIMESTAMP }}.tar.gz`
+
+Where can I find log archive generated by `NodeDiagnostic` when `destinationType` set as `node`?
+
+* Generic Linux: Log should be available at `/var/log/support/${NODE_NAME}$-logs.tar.gz`
+* Bottlerocket: Log should be available at `/.bottlerocket/support/${NODE_NAME}$-logs.tar.gz`
 
 How do I report an issue or submit a feature request?
 

config.yaml examples/config-full.yamlconfig.yaml renamed to examples/config-full.yaml

@@ -19,6 +19,5 @@ bucketName: node-diagnostic-EXAMPLE
 # $ kubectl get nodes -o jsonpath='{range .items[*]}{"- "}{.metadata.name}{"\n"}{end}'
 nodes: []
 # nodes:
-# - i-EXAMPLE1111111111
-# - i-EXAMPLE2222222222
-# - i-EXAMPLE3333333333
+# - ip-192-168-100-200.ec2.internal
+# - i-EXAMPLE1111111111

examples/config-node.yaml

@@ -0,0 +1,8 @@
+---
+region: us-east-1
+
+destinationType: node
+
+nodes:
+- ip-192-168-100-200.ec2.internal
+- i-EXAMPLE1111111111

examples/config-s3.yaml

@@ -0,0 +1,10 @@
+---
+region: us-east-1
+
+destinationType: s3
+
+bucketName: node-diagnostic-EXAMPLE
+
+nodes:
+- ip-192-168-100-200.ec2.internal
+- i-EXAMPLE1111111111