@stolostron/multicluster-sdk/lib/api/useFleetClusterSetNames.d.ts

Provides extensions and APIs that dynamic plugins can use to leverage multicluster capabilities provided by Red Hat Advanced Cluster Management.

/**
 * Hook that returns unique cluster set names from managed clusters with optional filtering by cluster proxy addon and availability status.
 *
 * This hook watches ManagedCluster resources and by default filters them to only include clusters
 * that have both the label `feature.open-cluster-management.io/addon-cluster-proxy: available` AND
 * the condition `ManagedClusterConditionAvailable` with status `True`. It then collects unique
 * values from the `cluster.open-cluster-management.io/clusterset` label.
 *
 * @param considerAllClusters - Optional boolean to consider all clusters regardless of labels and conditions.
 *   Defaults to false. When false (default), only considers clusters with the
 *   'feature.open-cluster-management.io/addon-cluster-proxy: available' label AND
 *   'ManagedClusterConditionAvailable' status: 'True'.
 *   When true, considers all clusters regardless of labels and conditions.
 *
 * @returns A tuple containing:
 *   - clusterSets: Array of unique cluster set names from the clusterset labels
 *   - loaded: Boolean indicating if the resource watch has loaded
 *   - error: Any error that occurred during the watch operation
 *
 * @example
 * ```tsx
 * // Get cluster sets from only clusters with cluster proxy addon available AND ManagedClusterConditionAvailable: 'True' (default behavior)
 * const [availableClusterSets, loaded, error] = useFleetClusterSetNames()
 *
 * // Get cluster sets from all clusters regardless of labels and conditions
 * const [allClusterSets, loaded, error] = useFleetClusterSetNames(true)
 *
 * // Explicitly filter by cluster proxy addon and availability (same as default)
 * const [filteredClusterSets, loaded, error] = useFleetClusterSetNames(false)
 *
 * if (!loaded) {
 *   return <Loading />
 * }
 *
 * if (error) {
 *   return <ErrorState error={error} />
 * }
 *
 * return (
 *   <div>
 *     {availableClusterSets.map(setName => (
 *       <div key={setName}>{setName}</div>
 *     ))}
 *   </div>
 * )
 * ```
 */
export declare function useFleetClusterSetNames(considerAllClusters?: boolean): [string[], boolean, any];
//# sourceMappingURL=useFleetClusterSetNames.d.ts.map