-
Notifications
You must be signed in to change notification settings - Fork 168
Add: Cluster Resource Model Source node source documentation #1786
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| # Cluster Resource Model Source | ||
|
|
||
| :::enterprise | ||
| ::: | ||
|
|
||
| The **Cluster Resource Model Source** plugin exposes Rundeck cluster members as nodes in the node inventory. This enables administrators to execute jobs and commands directly on cluster members for maintenance, monitoring, and cluster management tasks. | ||
|
|
||
| ## Setup | ||
|
|
||
| To add the Cluster Resource Model Source to a project: | ||
|
|
||
| 1. Navigate to **Project Settings** -> **Edit Nodes** -> **Sources** | ||
| 2. Click **Add a New Node Source** | ||
| 3. Select **Cluster Resource Model Source** from the list | ||
|
|
||
| :::tip Cluster Configuration | ||
| This node source requires a Rundeck cluster environment. See the [Cluster Overview](/administration/cluster/index.md) for information on setting up a cluster. | ||
| ::: | ||
|
|
||
| ## Configuration | ||
|
|
||
| The following configuration option is available: | ||
|
|
||
| * **Show Dead Nodes**: Include cluster members that are no longer active or have stopped responding. When enabled, inactive cluster members will appear in the node inventory. Default: `false` (only active cluster members are shown). | ||
|
|
||
| ## SSH Connection Configuration | ||
|
|
||
| The Cluster Resource Model Source uses the `framework.server.name` property as the SSH connection hostname for each cluster member. By default, this may contain internal or container hostnames that are not DNS-resolvable from other cluster members. | ||
|
|
||
| ### Configuring Resolvable Hostnames | ||
|
|
||
| To enable SSH connections to cluster member nodes, configure the following properties in the `framework.properties` file on each cluster member: | ||
|
|
||
| **Required Properties:** | ||
|
|
||
| * **framework.server.name**: Set to a DNS-resolvable hostname or IP address that other cluster members can reach | ||
| * **framework.server.hostname**: The hostname of the Rundeck server node (can match framework.server.name) | ||
| * **framework.ssh.user**: Default SSH username for connections to cluster members | ||
| * **framework.ssh.keypath**: Path to the SSH private key file used for authentication | ||
|
brmdias marked this conversation as resolved.
|
||
|
|
||
| **Example Configuration:** | ||
|
|
||
| ```properties | ||
| framework.server.name=rundeck-node-1.example.com | ||
| framework.server.hostname=rundeck-node-1.example.com | ||
| framework.ssh.user=rundeck | ||
| framework.ssh.keypath=/var/lib/rundeck/.ssh/id_rsa | ||
| ``` | ||
|
|
||
| :::tip SSH Authentication | ||
| SSH authentication settings can be overridden using node attributes such as `ssh-key-storage-path` or `username`. See [SSH Node Execution](/manual/projects/node-execution/ssh.md) for configuration options and precedence. | ||
| ::: | ||
|
|
||
| See [Configuration File Reference](/administration/configuration/config-file-reference.md#frameworkproperties) for more details on framework properties. | ||
|
|
||
| ## Node Attributes | ||
|
|
||
| The following attributes are automatically populated for each cluster member node: | ||
|
|
||
| * **serverUUID**: Unique identifier for the cluster member | ||
| * **rundeckVersion**: Rundeck version running on the cluster member | ||
| * **cpuLoadPct**: CPU load percentage | ||
| * **heapusagePct**: JVM heap memory usage percentage | ||
| * **memoryAllocatedPct**: Total memory allocation percentage | ||
| * **schedulerRunningCount**: Number of currently running scheduled jobs | ||
| * **osName**: Operating system name | ||
| * **osArch**: Operating system architecture | ||
| * **osVersion**: Operating system version | ||
|
|
||
| These attributes can be used for node filtering, job targeting, and monitoring cluster health. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.