docs: add examples section (#24)

* docs: add examples section Signed-off-by: Nianyu Shen <[email protected]> * docs: improve wording in readme Signed-off-by: Nianyu Shen <[email protected]> --------- Signed-off-by: Nianyu Shen <[email protected]>
spectrocloud · Oct 9, 2024 · 7ec6767 · 7ec6767
1 parent b8b242b
commit 7ec6767
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,9 @@
-# agent-mode
+# Agent Mode
 
 ## Prerequisites
 
+Before you begin, ensure you have the following installed:
+
 - `bash`
 - `systemd`
 - `rsync`
@@ -11,13 +13,15 @@
 
 ## Quick Start
 
+To quickly install the agent, run the following command:
+
 ```bash
 curl -Ls https://github.com/spectrocloud/agent-mode/releases/latest/download/palette-agent-install.sh | bash
 ```
 
 ## Usage
 
-### specify userdata
+### Specify Userdata
 
 Userdata can be a URL or a file path.
 
@@ -27,12 +31,26 @@ curl -Ls https://github.com/spectrocloud/agent-mode/releases/latest/download/pal
 curl -Ls https://github.com/spectrocloud/agent-mode/releases/latest/download/palette-agent-install.sh | USERDATA=/path/to/userdata bash
 ```
 
-### specify palette version
+### Specify Palette version
 
 ```bash
 curl -Ls https://github.com/spectrocloud/agent-mode/releases/latest/download/palette-agent-install.sh | VERSION=v4.5.0 bash
 ```
 
+## Userdata
+
+Refer to [Palette Agent Parameters Documentation](https://docs.spectrocloud.com/clusters/edge/edge-configuration/installer-reference/#palette-agent-parameters) for more details.
+
+## Examples
+
+Here are some examples of how to use the install script on different platforms.
+
+### MAAS
+
+Use [maas.yml](examples/maas.yml) as cloudinit to provision your machine.
+
+> **Note:** You might need to modify the cloudinit with your own userdata.
+
 ## Development
 
 ### Build install script

diff --git a/cloud-init-examples/maas.yml → examples/maas.yml b/cloud-init-examples/maas.yml → examples/maas.yml
@@ -40,7 +40,7 @@ write_files:
       #!/bin/bash
       # export USERDATA variable local path or with URL
       export USERDATA=/home/ubuntu/user-data
-      curl -Ls https://github.com/spectrocloud/agent-mode/releases/download/v4.5.0-rc9/palette-agent-install.sh | bash
+      curl -Ls https://github.com/spectrocloud/agent-mode/releases/latest/download/palette-agent-install.sh | bash
 
 runcmd:
   - /home/ubuntu/install.sh