stolostron · swopebe · Jan 13, 2025 · Jan 13, 2025
diff --git a/apis/api.adoc b/apis/api.adoc
@@ -3,6 +3,8 @@
 
 You can access APIs to create and manage application resources, channels, subscriptions, and to query information.
 
+*Deprecated:* The documentation for the APIs is deprecated. Use the _API Explorer_ in the console to view current and supported APIs.
+
 *User required access:* You can only perform actions that your role is assigned. Learn about access requirements from the link:../access_control/rbac.adoc#role-based-access-control[Role-based access control] documentation. 
 
 You can also access all APIs from the integrated console. From the `local-cluster` view, navigate to *Home* > *API Explorer* to explore API groups.

diff --git a/apis/application.json.adoc b/apis/application.json.adoc
@@ -1,6 +1,7 @@
 [#applications-api]
 = Applications API
 
+*Deprecated:* The documentation for the APIs is deprecated. Use the _API Explorer_ in the console to view current and supported APIs. 
 
 [[_rhacm-docs_apis_application_jsonoverview]]
 == Overview

diff --git a/apis/channels.json.adoc b/apis/channels.json.adoc
@@ -1,6 +1,7 @@
 [#channels-api]
 = Channels API
 
+*Deprecated:* The documentation for the APIs is deprecated. Use the _API Explorer_ in the console to view current and supported APIs.
 
 [[_rhacm-docs_apis_channels_jsonoverview]]
 == Overview

diff --git a/apis/cluster.json.adoc b/apis/cluster.json.adoc
@@ -1,6 +1,8 @@
 [#clusters-api]
 = Clusters API
 
+*Deprecated:* The documentation for the APIs is deprecated. Use the _API Explorer_ in the console to view current and supported APIs.
+
 [[_rhacm-docs_apis_cluster_jsonoverview]]
 == Overview
 This documentation is for the cluster resource for {acm}. Cluster resource has four possible requests: create, query, delete and update. `ManagedCluster` represents the desired state and current status of a managed cluster. `ManagedCluster` is a cluster-scoped resource.

diff --git a/apis/clusterinstance.json.adoc b/apis/clusterinstance.json.adoc
@@ -1,6 +1,8 @@
 [#clusterinstance-api]
 = ClusterInstance API
 
+*Deprecated:* The documentation for the APIs is deprecated. Use the _API Explorer_ in the console to view current and supported APIs.
+
 [[_rhacm-docs_apis_clusterinstance_jsonoverview]]
 == Overview
 This documentation is for the ClusterInstance resource for {acm}. The ClusterInstance resource has four possible requests: create, query, delete and update.

diff --git a/apis/clustermanagementaddon.json.adoc b/apis/clustermanagementaddon.json.adoc
@@ -1,6 +1,8 @@
 [#clustermanagementaddon-api]
 = ClusterManagementAddOn API (v1alpha1)
 
+*Deprecated:* The documentation for the APIs is deprecated. Use the _API Explorer_ in the console to view current and supported APIs.
+
 [[_rhacm-docs_apis_clustermanagementaddon_jsonoverview]]
 == Overview
 This documentation is for the ClusterManagementAddOn resource for {acm}. The ClusterManagementAddOn resource has four possible requests: create, query, delete, and update. 

diff --git a/apis/clusterset.json.adoc b/apis/clusterset.json.adoc
@@ -1,6 +1,8 @@
 [#clustersets-api]
 = Clustersets API (v1beta2)
 
+*Deprecated:* The documentation for the APIs is deprecated. Use the _API Explorer_ in the console to view current and supported APIs.
+
 [[_rhacm-docs_apis_clusterset_jsonoverview]]
 == Overview
 This documentation is for the ClusterSet resource for {acm}. The ClusterSet resource has four possible requests: create, query, delete, and update. The ManagedClusterSet defines a group of ManagedClusters. You can assign a ManagedCluster to a specific ManagedClusterSet by adding a label with the name `cluster.open-cluster-management.io/clusterset` on the ManagedCluster that refers to the ManagedClusterSet. You can only add or remove this label on a ManagedCluster when you have an RBAC rule that allows the `create` permissions on a virtual subresource of `managedclustersets/join`. You must have this permission on both the source and the target ManagedClusterSets to update this label.

diff --git a/apis/clustersetbinding.json.adoc b/apis/clustersetbinding.json.adoc
@@ -1,6 +1,8 @@
 [#clustersetbindings-api]
 = Clustersetbindings API (v1beta2)
 
+*Deprecated:* The documentation for the APIs is deprecated. Use the _API Explorer_ in the console to view current and supported APIs.
+
 [[_rhacm-docs_apis_clustersetbinding_jsonoverview]]
 == Overview
 This documentation is for the ClusterSetBinding resource for {acm}. The ClusterSetBinding resource has four possible requests: create, query, delete, and update. ManagedClusterSetBinding projects a ManagedClusterSet into a certain namespace. You can create a ManagedClusterSetBinding in a namespace and bind it to a ManagedClusterSet if you have an RBAC rule that allows you to `create` on the virtual subresource of `managedclustersets/bind`.

diff --git a/apis/clusterview.json.adoc b/apis/clusterview.json.adoc
@@ -1,6 +1,8 @@
 [#clusterview-api]
 = Clusterview API (v1alpha1)
 
+*Deprecated:* The documentation for the APIs is deprecated. Use the _API Explorer_ in the console to view current and supported APIs.
+
 [[_rhacm-docs_apis_clusterview_jsonoverview]]
 == Overview
 This documentation is for the `clusterview` resource for {acm}. The `clusterview` resource provides a CLI command that enables you to view a list of the managed clusters and managed cluster sets that that you can access. The three possible requests are: list, get, and watch.

diff --git a/apis/discoveredcluster.json.adoc b/apis/discoveredcluster.json.adoc
@@ -1,6 +1,8 @@
 [#discovered-clusters-api]
 = DiscoveredCluster API
 
+*Deprecated:* The documentation for the APIs is deprecated. Use the _API Explorer_ in the console to view current and supported APIs.
+
 [[_rhacm-docs_apis_discoveredcluster_jsonoverview]]
 == Overview
 This documentation is for the DiscoveredCluster resource for {acm}. The DiscoveredCluster resource has four possible requests: create, query, delete, and update.

diff --git a/apis/discoveryconfig.json.adoc b/apis/discoveryconfig.json.adoc
@@ -1,6 +1,8 @@
 [#discovery-config-api]
 = DiscoveryConfig API
 
+*Deprecated:* The documentation for the APIs is deprecated. Use the _API Explorer_ in the console to view current and supported APIs.
+
 [[_rhacm-docs_apis_discoveryconfig_jsonoverview]]
 == Overview
 This documentation is for the DiscoveryConfig resource for {acm}. The DiscoveryConfig resource has four possible requests: create, query, delete, and update.

diff --git a/apis/helmreleases.json.adoc b/apis/helmreleases.json.adoc
@@ -1,6 +1,7 @@
 [#helm-api]
 = Helm API
 
+*Deprecated:* The documentation for the APIs is deprecated. Use the _API Explorer_ in the console to view current and supported APIs.
 
 [[_rhacm-docs_apis_helmreleases_jsonoverview]]
 == Overview

diff --git a/apis/klusterletconfig.json.adoc b/apis/klusterletconfig.json.adoc
@@ -1,6 +1,8 @@
 [#klusterletconfig-api]
 = KlusterletConfig API (v1alpha1)
 
+*Deprecated:* The documentation for the APIs is deprecated. Use the _API Explorer_ in the console to view current and supported APIs.
+
 [[_rhacm-docs_apis_klusterletconfig_jsonoverview]]
 == Overview
 This documentation is for the KlusterletConfig resource for {acm}. The KlusterletConfig resource has four possible requests: create, query, delete, and update. KlusterletConfig contains configuration information about a klusterlet, such as `nodeSelector`, `tolerations`, and `pullSecret`.  KlusterletConfig is a cluster-scoped resource and only works on klusterlet pods in the `open-cluster-managemnet-agent` namespace. KlusterletConfig does not affect add-on deployment configurations.

diff --git a/apis/managedclusteraddon.json.adoc b/apis/managedclusteraddon.json.adoc
@@ -1,6 +1,8 @@
 [#managedclusteraddon-api]
 = ManagedClusterAddOn API (v1alpha1)
 
+*Deprecated:* The documentation for the APIs is deprecated. Use the _API Explorer_ in the console to view current and supported APIs.
+
 [[_rhacm-docs_apis_managedclusteraddon_jsonoverview]]
 == Overview
 This documentation is for the ManagedClusterAddOn resource for {acm}. The ManagedClusterAddOn resource has four possible requests: create, query, delete, and update. 

diff --git a/apis/managedclusterset.json.adoc b/apis/managedclusterset.json.adoc
@@ -1,6 +1,8 @@
 [#managedclusterset-api]
 = ManagedClusterSet API (v1beta2)
 
+*Deprecated:* The documentation for the APIs is deprecated. Use the _API Explorer_ in the console to view current and supported APIs.
+
 [[_rhacm-docs_apis_managedclusterset_jsonoverview]]
 == Overview
 This documentation is for the ManagedClusterSet resource for {acm}. The ManagedClusterSet resource has four possible requests: create, query, delete, and update. ManagedClusterSet groups two or more managed clusters into a set that you can operate together. Managed clusters that belong to a set can have similar attributes, such as shared use purposes or the same deployment region.

diff --git a/apis/multicluster_hub.json.adoc b/apis/multicluster_hub.json.adoc
@@ -1,6 +1,7 @@
 [#multicluster-hub-api]
 = MultiClusterHub API
 
+*Deprecated:* The documentation for the APIs is deprecated. Use the _API Explorer_ in the console to view current and supported APIs.
 
 [[_rhacm-docs_apis_mch_jsonoverview]]
 == Overview

diff --git a/apis/observability.json.adoc b/apis/observability.json.adoc
@@ -1,6 +1,7 @@
 [#observability-api]
 = Observability API
 
+*Deprecated:* The documentation for the APIs is deprecated. Use the _API Explorer_ in the console to view current and supported APIs.
 
 [[_rhacm-docs_apis_multiclusterobservability_jsonoverview]]
 == Overview

diff --git a/apis/placement.json.adoc b/apis/placement.json.adoc
@@ -1,6 +1,8 @@
 [#placement-api]
 = Placement API (v1beta1)
 
+*Deprecated:* The documentation for the APIs is deprecated. Use the _API Explorer_ in the console to view current and supported APIs.
+
 [[_rhacm-docs_apis_placement_jsonoverview]]
 == Overview
 This documentation is for the Placement resource for {acm}. The Placement resource has four possible requests: create, query, delete, and update. Placement defines a rule to select a set of ManagedClusters from the ManagedClusterSets that are bound to the placement namespace. A slice of PlacementDecisions with the label `cluster.open-cluster-management.io/placement={placement name}` is created to represent the ManagedClusters that are selected by this placement.

diff --git a/apis/placementdecision.json.adoc b/apis/placementdecision.json.adoc
@@ -1,6 +1,8 @@
 [#placementdecisions-api]
 = PlacementDecisions API (v1beta1)
 
+*Deprecated:* The documentation for the APIs is deprecated. Use the _API Explorer_ in the console to view current and supported APIs.
+
 [[_rhacm-docs_apis_placementdecision_jsonoverview]]
 == Overview
 This documentation is for the PlacementDecision resource for {acm}. The PlacementDecision resource has four possible requests: create, query, delete, and update. A PlacementDecision indicates a decision from a placement. A PlacementDecision uses the label `cluster.open-cluster-management.io/placement={placement name}` to reference a certain placement.

diff --git a/apis/placementrules.json.adoc b/apis/placementrules.json.adoc
@@ -1,6 +1,7 @@
 [#placementrules-api]
 = PlacementRules API (deprecated)
 
+*Deprecated:* This API is deprecated. The _documentation_ for all remaining APIs is also deprecated. Use the _API Explorer_ in the console to view current and supported APIs. 
 
 [[_rhacm-docs_apis_placementrules_jsonoverview]]
 == Overview

diff --git a/apis/policy.json.adoc b/apis/policy.json.adoc
@@ -1,6 +1,7 @@
 [#policy-api]
 = Policy API
 
+*Deprecated:* The documentation for the APIs is deprecated. Use the _API Explorer_ in the console to view current and supported APIs.
 
 [[_rhacm-docs_apis_policy_jsonoverview]]
 == Overview

diff --git a/apis/searchquery.json.adoc b/apis/searchquery.json.adoc
@@ -1,7 +1,9 @@
 [#search-query-api]
 = Search query API
 
-The search query API is not a Kubernetes API, therefore is not displayed through the {ocp} API Explorer. Continue reading to understand the search query API capabilities.  
+The search query API is not a Kubernetes API, therefore is not displayed through the {ocp} API Explorer. Continue reading to understand the search query API capabilities.
+
+*Deprecated:* The documentation for the APIs is deprecated. Use the _API Explorer_ in the console to view current and supported APIs.
 
 == Overview
 

diff --git a/apis/subscriptions.json.adoc b/apis/subscriptions.json.adoc
@@ -1,6 +1,7 @@
 [#subscriptions-api]
 = Subscriptions API
 
+*Deprecated:* The documentation for the APIs is deprecated. Use the _API Explorer_ in the console to view current and supported APIs.
 
 [[_rhacm-docs_apis_subscriptions_jsonoverview]]
 == Overview

diff --git a/clusters/api/api_intro.adoc b/clusters/api/api_intro.adoc
@@ -1,15 +1,15 @@
 [#apis]
 = APIs
-//lets consider changing this to mce-apis bc we use the apis anchor in the apis folder
+
+*Deprecated:* The documentation for the APIs is deprecated. Use the _API Explorer_ in the console to view current and supported APIs.
 
 You can access the following APIs for cluster lifecycle management with the {mce-short}. *User required access:* You can only perform actions that your role is assigned. 
 
 *Note:* You can also access all APIs from the integrated console. From the `local-cluster` view, navigate to *Home* > *API Explorer* to explore API groups.
 
 
 For more information, review the API documentation for each of the following resources:
-//i believe we need to change from xref to link or add extra directory im on board to change to link
-//placementdecisions-api
+
 
 * xref:../api/cluster.json.adoc#clusters-api[Clusters API]
 * xref:../api/clusterset.json.adoc#clustersets-api[ClusterSets API (v1beta2)]

diff --git a/clusters/api/cluster.json.adoc b/clusters/api/cluster.json.adoc
@@ -1,6 +1,8 @@
 [#clusters-api]
 = Clusters API
 
+*Deprecated:* The documentation for the APIs is deprecated. Use the _API Explorer_ in the console to view current and supported APIs.
+
 [[_rhacm-docs_apis_cluster_jsonoverview]]
 == Overview
 This documentation is for the cluster resource for {mce}. Cluster resource has four possible requests: create, query, delete and update.

diff --git a/clusters/api/clusterset.json.adoc b/clusters/api/clusterset.json.adoc
@@ -1,6 +1,8 @@
 [#clustersets-api]
 = Clustersets API (v1beta2)
 
+*Deprecated:* The documentation for the APIs is deprecated. Use the _API Explorer_ in the console to view current and supported APIs.
+
 [[_rhacm-docs_apis_clusterset_jsonoverview]]
 == Overview
 This documentation is for the Clusterset resource for {mce}. Clusterset resource has four possible requests: create, query, delete and update.

diff --git a/clusters/api/clustersetbinding.json.adoc b/clusters/api/clustersetbinding.json.adoc
@@ -1,6 +1,8 @@
 [#clustersetbindings-api]
 = Clustersetbindings API (v1beta2)
 
+*Deprecated:* The documentation for the APIs is deprecated. Use the _API Explorer_ in the console to view current and supported APIs.
+
 [[_rhacm-docs_apis_clustersetbinding_jsonoverview]]
 == Overview
 This documentation is for the clustersetbinding resource for multicluster engine for Kubernetes. Clustersetbinding resource has four possible requests: create, query, delete and update.

diff --git a/clusters/api/clusterview.json.adoc b/clusters/api/clusterview.json.adoc
@@ -1,6 +1,8 @@
 [#clusterview-api]
 = Clusterview API (v1alpha1)
 
+*Deprecated:* The documentation for the APIs is deprecated. Use the _API Explorer_ in the console to view current and supported APIs.
+
 [[_rhacm-docs_apis_clusterview_jsonoverview]]
 == Overview
 This documentation is for the `clusterview` resource for multicluster engine for Kubernetes. The `clusterview` resource provides a CLI command that enables you to view a list of the managed clusters and managed cluster sets that that you can access. The three possible requests are: list, get, and watch.

diff --git a/clusters/api/klusterletconfig.json.adoc b/clusters/api/klusterletconfig.json.adoc
@@ -1,6 +1,7 @@
 [#klusterletconfig-api]
 = KlusterletConfig API (v1alpha1)
 
+*Deprecated:* The documentation for the APIs is deprecated. Use the _API Explorer_ in the console to view current and supported APIs.
 
 [[_rhacm-docs_apis_klusterletconfig_jsonoverview]]
 == Overview

diff --git a/clusters/api/managed_serviceaccount.json.adoc b/clusters/api/managed_serviceaccount.json.adoc
@@ -1,6 +1,8 @@
 [#serviceaccount-api]
 = ManagedServiceAccount API (v1alpha1) (Deprecated)
 
+*Deprecated:* The documentation for the APIs is deprecated. Use the _API Explorer_ in the console to view current and supported APIs.
+
 [[_serviceaccount_jsonoverview]]
 == Overview
 This documentation is for the `ManagedServiceAccount` resource for the {mce-short}. The `ManagedServiceAccount` resource has four possible requests: create, query, delete, and update.

diff --git a/clusters/api/multicluster_engine.json.adoc b/clusters/api/multicluster_engine.json.adoc
@@ -1,6 +1,9 @@
 [#multiclusterengine-api]
 = MultiClusterEngine API (v1alpha1)
 
+*Deprecated:* The documentation for the APIs is deprecated. Use the _API Explorer_ in the console to view current and supported APIs.
+
+
 [[_mce_jsonoverview]]
 == Overview
 This documentation is for the MultiClusterEngine resource for multicluster engine for Kubernetes. The `MultiClusterEngine` resource has four possible requests: create, query, delete, and update.

diff --git a/clusters/api/placement.json.adoc b/clusters/api/placement.json.adoc
@@ -1,6 +1,8 @@
 [#placements-clusters-api]
 = Placements API (v1beta1)
 
+*Deprecated:* The documentation for the APIs is deprecated. Use the _API Explorer_ in the console to view current and supported APIs.
+
 [[_rhacm-docs_apis_placement_jsonoverview]]
 == Overview
 This documentation is for the Placement resource for multicluster engine for Kubernetes. Placement resource has four possible requests: create, query, delete and update.

diff --git a/clusters/api/placementdecision.json.adoc b/clusters/api/placementdecision.json.adoc
@@ -1,6 +1,8 @@
 [#placementdecisions-api]
 = PlacementDecisions API (v1beta1)
 
+*Deprecated:* The documentation for the APIs is deprecated. Use the _API Explorer_ in the console to view current and supported APIs.
+
 [[_rhacm-docs_apis_placementdecision_jsonoverview]]
 == Overview
 This documentation is for the PlacementDecision resource for multicluster engine for Kubernetes. PlacementDecision resource has four possible requests: create, query, delete and update.