Skip to content

Commit df2b7cc

Browse files
authored
update documentation (#33)
As we are providing discovery only through ACM, we update the documentation to explain the enclave approach is a one-time installation convenience. Any changes should be done via ACM. And in general it is recommended to configure all nodes via ACM to begin with.
1 parent 976dde1 commit df2b7cc

3 files changed

Lines changed: 39 additions & 3 deletions

File tree

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,8 @@ Comprehensive documentation is available in the `docs/` folder:
120120
- **[Deployment Guide](docs/DEPLOYMENT_GUIDE.md)**: Complete guide on what gets deployed, prerequisites, and deployment workflow
121121
- **[Configuration Reference](docs/CONFIGURATION_REFERENCE.md)**: Detailed explanation of all configuration variables with examples
122122

123+
> **Note on Host Discovery Management:** While Phase 7 allows you to configure hardware discovery through the Enclave configuration as a one-time convenience, **Red Hat Advanced Cluster Management (ACM) is the recommended approach for managing bare metal host discovery and lifecycle operations** in production. For adding, removing, or modifying nodes after initial deployment, use ACM. See the [Deployment Guide](docs/DEPLOYMENT_GUIDE.md#discovering-new-nodes) for details.
124+
123125
## Local Development & Testing
124126

125127
### Prerequisites

docs/CONFIGURATION_REFERENCE.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -499,6 +499,12 @@ curl -k -u user:pass https://<redfish-ip>/redfish/v1/Systems/1/EthernetInterface
499499

500500
## Discovery Hosts Configuration
501501

502+
> **⚠️ Important: Use Red Hat ACM for Production Host Management**
503+
>
504+
> **Red Hat Advanced Cluster Management (ACM) is the recommended approach for managing bare metal host discovery and lifecycle operations.** The discovery hosts configuration in this file is provided as a convenience for initial one-time setup only.
505+
>
506+
> For ongoing operations such as adding nodes, removing nodes, changing configurations, or scaling the cluster, use Red Hat ACM instead. See the [Managing bare metal hosts documentation](https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.12/html/clusters/cluster_mce_overview#managing-bare-metal-hosts-console) for details.
507+
502508
The discovery hosts configuration is defined in `config/global.yaml` for discovering new nodes after the initial cluster deployment. This configuration uses the same network settings (defaultDNS, defaultGateway, defaultPrefix, lzBmcIP) as the main cluster deployment.
503509

504510
### Discovery Hosts Settings

docs/DEPLOYMENT_GUIDE.md

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -730,9 +730,35 @@ For diagnostic log collection, see the [Log Collection Tool](../lz-gather-logs/R
730730

731731
## Discovering New Nodes
732732

733-
After the initial cluster deployment, you can discover and add new bare metal nodes to the cluster using the discovery process. This is useful for adding compute nodes or additional infrastructure nodes.
733+
After the initial cluster deployment, you can discover and add new bare metal nodes to the cluster.
734734

735-
### Prerequisites
735+
### Recommended Approach: Red Hat Advanced Cluster Management (ACM)
736+
737+
**Red Hat ACM is the recommended way to manage host discovery and bare metal infrastructure.** ACM provides a comprehensive interface for managing the complete lifecycle of bare metal hosts, including:
738+
739+
- Adding new hosts to the cluster
740+
- Removing hosts from the cluster
741+
- Modifying host configurations
742+
- Monitoring host status and health
743+
- Managing host scaling operations
744+
745+
For detailed information on managing bare metal hosts with ACM, refer to the official documentation:
746+
- [Managing bare metal hosts using Red Hat ACM](https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.15/html/clusters/cluster_mce_overview#cim-intro)
747+
748+
### Alternative: Enclave Configuration (One-Time Convenience)
749+
750+
As a convenience for initial setup, you can configure hosts in the Enclave configuration (`config/global.yaml`) and use the discovery playbook to boot them. **However, this is intended as a one-time operation.**
751+
752+
**Important:** If you need to perform any of the following operations, you must use Red Hat ACM instead of the Enclave configuration:
753+
- Add more nodes after initial deployment
754+
- Remove nodes from the cluster
755+
- Change node configurations
756+
- Scale up or down the cluster
757+
- Perform day-2 operations on bare metal hosts
758+
759+
The Enclave configuration method is provided only for initial convenience and is not suitable for ongoing infrastructure management.
760+
761+
### Prerequisites for Enclave Configuration Method
736762

737763
- The management cluster must be fully deployed and operational
738764
- You must have access to the cluster's kubeconfig file
@@ -778,7 +804,9 @@ Each node in `discovery_hosts` requires:
778804
| `redfishUser` | Redfish username | `admin` |
779805
| `redfishPassword` | Redfish password | `Password` |
780806

781-
### Running Discovery
807+
### Running Discovery (One-Time Setup Only)
808+
809+
> **⚠️ Warning:** This method is intended for initial setup only. For any subsequent host management operations, use Red Hat ACM instead.
782810

783811
1. **Edit the configuration** in `config/global.yaml`:
784812
```bash

0 commit comments

Comments
 (0)