Improve README for master/slave setup with hostname explanation #186
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Thanks for opening this pull request! Be sure to follow the pull request template!
zongsforce
changed the title
|
I am a bot, here are the test results for this PR:
|
|
Please note this part of the contribution document https://github.com/linuxserver/docker-smokeping/blob/master/.github/CONTRIBUTING.md#readme |
|
I am a bot, here are the test results for this PR:
|
The content I want to add is not compatible with the current YAML structure. Do I need to modify the code that generates the README? Could you please provide some suggestions? Reasons for the conflict:
|
|
These are the relevant variables for readme-vars https://github.com/linuxserver/docker-jenkins-builder/blob/b4796d74eef8d234fa6577696c2dd85720f895a5/vars/_container-vars-blank#L41-L43 |
|
I am a bot, here are the test results for this PR:
|
I tried modifying the Is this modification/validation process working as expected? Additional TestingTo further test, I also modified the variables Thank you for your patience and support in helping me work through this issue! My Changes
|
|
Generation works as expected. docker run --rm \
-v /git/lsio/docker-smokeping:/tmp \
-e PUID=99 -e PGID=100 \
lscr.io/linuxserver/jenkins-builder:latest--- a/README.md
+++ b/README.md
@@ -82,6 +82,7 @@ services:
smokeping:
image: lscr.io/linuxserver/smokeping:latest
container_name: smokeping
+ hostname: smokeping-main
environment:
- PUID=1000
- PGID=1000
@@ -102,6 +103,7 @@ services:
```bash
docker run -d \
--name=smokeping \
+ --hostname=smokeping-main \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Etc/UTC \
@@ -121,6 +123,7 @@ Containers are configured using parameters passed at runtime (such as those abov
| Parameter | Function |
| :----: | --- |
+| `--hostname=` | In a master-slave architecture, the hostname of the master node is displayed as its name in the web interface, while the hostname of the slave nodes represents their device aliases. These aliases must match the ones defined in the master's Slaves file. |
| `-p 80:80` | Allows HTTP access to the internal webserver. |
| `-e PUID=1000` | for UserID - see below for explanation |
| `-e PGID=1000` | for GroupID - see below for explanation |
diff --git a/readme-vars.yml b/readme-vars.yml
index 4583d34..f16ec2f 100644
--- a/readme-vars.yml
+++ b/readme-vars.yml
@@ -24,6 +24,9 @@ opt_param_env_vars:
- {env_var: "MASTER_URL", env_value: "http://<master-host-ip>:80/smokeping/", desc: "Specify the master url to connect to. Used when in slave mode."}
- {env_var: "SHARED_SECRET", env_value: "password", desc: "Specify the master shared secret for this host. Used when in slave mode."}
- {env_var: "CACHE_DIR", env_value: "/tmp", desc: "Specify the cache directory for this host. Used when in slave mode."}
+param_usage_include_hostname: true # you can set it to 'optional'
+param_hostname: "smokeping-main"
+param_hostname_desc: "In a master-slave architecture, the hostname of the master node is displayed as its name in the web interface, while the hostname of the slave nodes represents their device aliases. These aliases must match the ones defined in the master's Slaves file."
# application setup block
app_setup_block_enabled: true
app_setup_block: | |
zongsforce
force-pushed
the
master
branch
4 times, most recently
from
c893fd7 to
224bf01
Compare
It's done. There were some issues with my previous changes, but I've made a new commit and have already tested it. Please help me review the changes again. Thank you for your patient assistance. |
|
I am a bot, here are the test results for this PR:
|
|
I am a bot, here are the test results for this PR:
|
|
I am a bot, here are the test results for this PR:
|
|
I am a bot, here are the test results for this PR:
|
|
I am a bot, here are the test results for this PR:
|
|
I am a bot, here are the test results for this PR:
|
Description:
This pull request addresses the lack of clarity surrounding the
hostnameparameter in theREADME.mdfile, specifically regarding its role in configuring master/slave setups for SmokePing.Changes:
hostnameparameter to the configuration examples inREADME.md.hostnameparameter's purpose and usage, especially in the context of master/slave deployments.Benefits of this PR and context:
The existing documentation did not adequately explain the
hostnameparameter, which can be crucial when setting up SmokePing in a distributed, master/slave configuration. This omission could lead to confusion and configuration issues for users attempting to implement such setups.This enhancement aims to improve the documentation by:
hostnameparameter in the provided examples.hostnamefor both master and slave instances, ensuring proper communication and data aggregation.By adding this information, users will have a better understanding of how to properly configure SmokePing in master/slave mode, leading to a more robust and reliable monitoring setup.
How Has This Been Tested?
This change is a documentation update to
README.md. It does not modify any code logic and therefore does not require specific testing. The accuracy of the added information regarding thehostnameparameter and its use in master/slave configurations has been manually verified against the SmokePing documentation and common deployment practices.Source / References: