Skip to content

Commit

Permalink
Add Dockerized Agent option and update installation methods
Browse files Browse the repository at this point in the history
Introduce the experimental Dockerized Agent as an alternative installation method. Update documentation to include detailed descriptions and images for various installation methods. Additionally, add new images for the "add-device" and "stacks" sections and incorporate formatting adjustments for clarity.
  • Loading branch information
SquirrelDevelopper committed Oct 11, 2024
1 parent d6e94c1 commit 8de63be
Show file tree
Hide file tree
Showing 6 changed files with 28 additions and 5 deletions.
17 changes: 13 additions & 4 deletions site/docs/devices/add-device.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@
2. **Enter SSH Info**: Port, IP, sudo method, login type.
3. **Verify Master Node URL**: Ensure it is correct and reachable.
4. **Run Connection Tests**: Ansible and Docker checks.
5. **Confirm Details**: Click "Confirm & Install Agent".
6. **Monitor Installation**: Track Ansible's progress.
5. **Select Installation Method**: Directly on the host or dockerized
6. **Confirm Details**: Click "Confirm & Install Agent".
7. **Monitor Installation**: Track Ansible's progress.
:::

## 1. Inventory
Expand All @@ -33,11 +34,19 @@ In the next step, SSM will attempt to ping itself through this URL.
Ansible and Docker connections will automatically be initiated to test your previous inputs. Wait for the results and address any issues that may arise.
If you need to use a different authentication method for Docker, you can later specify it in the Docker configuration (see [Device Configuration](/docs/devices/device-configuration)).

## 5. Adding a device: Confirmation screen
## 4. Installation Method
![adddevice4](/add-device/add-device-7.png)
| Method | Description | Will install if needed |
|-------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------:|------------------------------|
| Node Agent - Default | The default method, it will install directly on the host a PM2 backed Node.js agent | `NodeJS (NVM)`, `NPM`, `PM2` |
| Node Agent - Enhanced Playbook (Experimental) | Experimental method, it will install directly on the host a PM2 backed Node.js agent with an advanced playbook for various configurations and OS. Try this if you have difficulties with the first one | `NodeJS (NVM)`, `NPM`, `PM2` |
| Dockerized Agent (Experimental) | Experimental, a Dockerized version of the agent. As far as tests go, it works very well. Use only on Linux hosts (macOS not supported) | `Docker`, `Docker Compose` |

## 6. Adding a device: Confirmation screen
![adddevice4](/add-device/add-device-4.png)
Verify that all information is correct and click on **"Confirm & Install agent"**.

## 6. Behold! The magic of SSM
## 7. Behold! The magic of SSM
![adddevice5](/add-device/add-device-5.png)
Monitor the progress of Ansible installing the agent on your device.

Expand Down
3 changes: 3 additions & 0 deletions site/docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,9 @@ Docker will create a volume directory *.data.prod* in the directory for persiste

[http://localhost:8000](http://localhost:8000) or [http://127.0.0.1:8000](http://127.0.0.1:8000)


---

### Updating SSM

In the SSM cloned directory:
Expand Down
11 changes: 10 additions & 1 deletion site/docs/requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,11 @@ To avoid any problems, use the **latest versions** of Node and NPM
- Please be aware that MongoDB requires a CPU supporting AVX
- The host of SSM needs port **:8000** opened for the agent to communicate with it.


---

### Agent:
#### Vanilla NodeJS Agent (Recommended):
:::info ℹ️ Agent dependencies
The following dependencies will be automatically installed when the agent is installed from the UI, thanks to the ad-hoc Ansible playbook
:::
Expand All @@ -18,4 +22,9 @@ The following dependencies will be automatically installed when the agent is ins
- **NPM >= 10.5.0**
- **PM2 >= 5.3.1**

Under the hood, the agent uses the package "[systeminformation](https://github.com/sebhildebrandt/systeminformation)". We encourage you to read the [known issues](https://systeminformation.io/issues.html) as some configurations may require additional packages to be installed (macOS, Windows, Linux), even though the playbook will attempt to do this for you.
#### Dockerized Agent (Experimental):
If you don't want to install the agent directly on the host, you can try the Dockerized agent. It will simply spin up a privileged Docker container that gathers the system information for SSM.

---

Under the hood, the agent uses the package "[systeminformation](https://github.com/sebhildebrandt/systeminformation)". We encourage you to read the [known issues](https://systeminformation.io/issues.html) as some configurations may require additional packages to be installed (macOS, Windows, Linux), even though the playbook will attempt to do this for you.
2 changes: 2 additions & 0 deletions site/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,8 @@ features:
## Screenshots
### Dashboard
![dashboard](/home/dashboard.png)
### Stacks
![dashboard](/home/stacks.png)
### Devices
![devices](/home/devices.png)
### Services
Expand Down
Binary file added site/public/add-device/add-device-7.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added site/public/home/stacks.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8de63be

Please sign in to comment.