deploy: 91c941c

open-cluster-management-io · Apr 28, 2024 · 286cfae · 286cfae
1 parent 73b8cce
commit 286cfae
Show file tree

Hide file tree

Showing 8 changed files with 118 additions and 12 deletions.
diff --git a/getting-started/installation/index.xml b/getting-started/installation/index.xml
@@ -15,7 +15,7 @@
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
 
       <guid>https://open-cluster-management.io/getting-started/installation/start-the-control-plane/</guid>
-      <description>Prerequisite Install clusteradm CLI tool Bootstrap a cluster manager Check out the running instances of the control plane Uninstall the OCM from the control plane     Prerequisite  The hub cluster should be v1.19+. (To run on hub cluster version between [v1.16, v1.18], please manually enable feature gate &amp;ldquo;V1beta1CSRAPICompatibility&amp;rdquo;). Currently the bootstrap process relies on client authentication via CSR. Therefore, if your Kubernetes distributions (like EKS) don&amp;rsquo;t support it, you can choose the multicluster-controlplane as the hub controlplane.</description>
+      <description>Prerequisite  Network requirements   Install clusteradm CLI tool Bootstrap a cluster manager Check out the running instances of the control plane Uninstall the OCM from the control plane     Prerequisite  The hub cluster should be v1.19+. (To run on hub cluster version between [v1.16, v1.18], please manually enable feature gate &amp;ldquo;V1beta1CSRAPICompatibility&amp;rdquo;). Currently the bootstrap process relies on client authentication via CSR. Therefore, if your Kubernetes distributions (like EKS) don&amp;rsquo;t support it, you can choose the multicluster-controlplane as the hub controlplane.</description>
     </item>
 
     <item>
@@ -25,7 +25,7 @@
 
       <guid>https://open-cluster-management.io/getting-started/installation/register-a-cluster/</guid>
       <description>After the cluster manager is installed on the hub cluster, you need to install the klusterlet agent on another cluster so that it can be registered and managed by the hub cluster.
-   Prerequisite Install clusteradm CLI tool Bootstrap a klusterlet  Bootstrap a klusterlet in hosted mode(Optional) Bootstrap a klusterlet in singleton mode   Accept the join request and verify Apply a Manifestwork  Troubleshooting   Detach the cluster from hub     Prerequisite  The managed clusters should be v1.</description>
+   Prerequisite  Network requirements   Install clusteradm CLI tool Bootstrap a klusterlet  Bootstrap a klusterlet in hosted mode(Optional) Bootstrap a klusterlet in singleton mode   Accept the join request and verify Apply a Manifestwork  Troubleshooting   Detach the cluster from hub     Prerequisite  The managed clusters should be v1.</description>
     </item>
 
   </channel>

diff --git a/getting-started/installation/register-a-cluster/index.html b/getting-started/installation/register-a-cluster/index.html
@@ -271,7 +271,11 @@ <h1>Register a cluster</h1>
 
 
   <div class="gdoc-toc gdoc-toc__level--6"><nav id="TableOfContents"><ul>
-        <li><a href="#prerequisite">Prerequisite</a></li>
+        <li><a href="#prerequisite">Prerequisite</a>
+          <ul>
+            <li><a href="#network-requirements">Network requirements</a></li>
+          </ul>
+        </li>
         <li><a href="#install-clusteradm-cli-tool">Install clusteradm CLI tool</a></li>
         <li><a href="#bootstrap-a-klusterlet">Bootstrap a klusterlet</a>
           <ul>
@@ -295,6 +299,29 @@ <h2 id="prerequisite">Prerequisite</h2>
 <li>The managed clusters should be <code>v1.11+</code>.</li>
 <li>Ensure <a href="https://kubernetes.io/docs/tasks/tools/install-kubectl">kubectl</a> and <a href="https://kubectl.docs.kubernetes.io/installation/kustomize/">kustomize</a> are installed.</li>
 </ul>
+<h3 id="network-requirements">Network requirements</h3>
+<p>Configure your network settings for the managed clusters to allow the following connections.</p>
+<table>
+<thead>
+<tr>
+<th>Direction</th>
+<th>Endpoint</th>
+<th>Protocol</th>
+<th>Purpose</th>
+<th>Used by</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>Outbound</td>
+<td>https://{hub-api-server-url}:{port}</td>
+<td>TCP</td>
+<td>Kubernetes API server of the hub cluster</td>
+<td>OCM agents, including the add-on agents, running on the managed clusters</td>
+</tr>
+</tbody>
+</table>
+<p>To use a proxy, please make sure the proxy server is well configured to allow the above connections and the proxy server is reachable for the managed clusters. See <a href="https://open-cluster-management.io/scenarios/register-cluster-through-proxy/">Register a cluster to hub through proxy server</a> for more details.</p>
 <h2 id="install-clusteradm-cli-tool">Install clusteradm CLI tool</h2>
 <p>It&rsquo;s recommended to run the following command to download and install <strong>the
 latest release</strong> of the <code>clusteradm</code> command-line tool:</p>

diff --git a/getting-started/installation/start-the-control-plane/index.html b/getting-started/installation/start-the-control-plane/index.html
@@ -270,7 +270,11 @@ <h1>Start the control plane</h1>
 
 
   <div class="gdoc-toc gdoc-toc__level--6"><nav id="TableOfContents"><ul>
-        <li><a href="#prerequisite">Prerequisite</a></li>
+        <li><a href="#prerequisite">Prerequisite</a>
+          <ul>
+            <li><a href="#network-requirements">Network requirements</a></li>
+          </ul>
+        </li>
         <li><a href="#install-clusteradm-cli-tool">Install clusteradm CLI tool</a></li>
         <li><a href="#bootstrap-a-cluster-manager">Bootstrap a cluster manager</a></li>
         <li><a href="#check-out-the-running-instances-of-the-control-plane">Check out the running instances of the control plane</a></li>
@@ -287,6 +291,28 @@ <h2 id="prerequisite">Prerequisite</h2>
 <li>Currently the bootstrap process relies on client authentication via CSR. Therefore, if your Kubernetes distributions (like <a href="https://github.com/aws/containers-roadmap/issues/1856">EKS</a>) don&rsquo;t support it, you can choose the <a href="https://github.com/open-cluster-management-io/multicluster-controlplane">multicluster-controlplane</a> as the hub controlplane.</li>
 <li>Ensure <a href="https://kubernetes.io/docs/tasks/tools/install-kubectl">kubectl</a> and <a href="https://kubectl.docs.kubernetes.io/installation/kustomize/">kustomize</a> are installed.</li>
 </ul>
+<h3 id="network-requirements">Network requirements</h3>
+<p>Configure your network settings for the hub cluster to allow the following connections.</p>
+<table>
+<thead>
+<tr>
+<th>Direction</th>
+<th>Endpoint</th>
+<th>Protocol</th>
+<th>Purpose</th>
+<th>Used by</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>Inbound</td>
+<td>https://{hub-api-server-url}:{port}</td>
+<td>TCP</td>
+<td>Kubernetes API server of the hub cluster</td>
+<td>OCM agents, including the add-on agents, running on the managed clusters</td>
+</tr>
+</tbody>
+</table>
 <h2 id="install-clusteradm-cli-tool">Install clusteradm CLI tool</h2>
 <p>It&rsquo;s recommended to run the following command to download and install <strong>the
 latest release</strong> of the <code>clusteradm</code> command-line tool:</p>

diff --git a/index.xml b/index.xml
@@ -146,7 +146,7 @@ And then please install the Prometheus-Operator in your hub cluster.</descriptio
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
 
       <guid>https://open-cluster-management.io/getting-started/installation/start-the-control-plane/</guid>
-      <description>Prerequisite Install clusteradm CLI tool Bootstrap a cluster manager Check out the running instances of the control plane Uninstall the OCM from the control plane     Prerequisite  The hub cluster should be v1.19+. (To run on hub cluster version between [v1.16, v1.18], please manually enable feature gate &amp;ldquo;V1beta1CSRAPICompatibility&amp;rdquo;). Currently the bootstrap process relies on client authentication via CSR. Therefore, if your Kubernetes distributions (like EKS) don&amp;rsquo;t support it, you can choose the multicluster-controlplane as the hub controlplane.</description>
+      <description>Prerequisite  Network requirements   Install clusteradm CLI tool Bootstrap a cluster manager Check out the running instances of the control plane Uninstall the OCM from the control plane     Prerequisite  The hub cluster should be v1.19+. (To run on hub cluster version between [v1.16, v1.18], please manually enable feature gate &amp;ldquo;V1beta1CSRAPICompatibility&amp;rdquo;). Currently the bootstrap process relies on client authentication via CSR. Therefore, if your Kubernetes distributions (like EKS) don&amp;rsquo;t support it, you can choose the multicluster-controlplane as the hub controlplane.</description>
     </item>
 
     <item>
@@ -175,7 +175,7 @@ Usage ClusterCaim is used to specify additional properties of the managed cluste
 
       <guid>https://open-cluster-management.io/getting-started/installation/register-a-cluster/</guid>
       <description>After the cluster manager is installed on the hub cluster, you need to install the klusterlet agent on another cluster so that it can be registered and managed by the hub cluster.
-   Prerequisite Install clusteradm CLI tool Bootstrap a klusterlet  Bootstrap a klusterlet in hosted mode(Optional) Bootstrap a klusterlet in singleton mode   Accept the join request and verify Apply a Manifestwork  Troubleshooting   Detach the cluster from hub     Prerequisite  The managed clusters should be v1.</description>
+   Prerequisite  Network requirements   Install clusteradm CLI tool Bootstrap a klusterlet  Bootstrap a klusterlet in hosted mode(Optional) Bootstrap a klusterlet in singleton mode   Accept the join request and verify Apply a Manifestwork  Troubleshooting   Detach the cluster from hub     Prerequisite  The managed clusters should be v1.</description>
     </item>
 
     <item>

diff --git a/zh/getting-started/installation/index.xml b/zh/getting-started/installation/index.xml
@@ -15,7 +15,7 @@
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
 
       <guid>https://open-cluster-management.io/zh/getting-started/installation/start-the-control-plane/</guid>
-      <description>Prerequisite Install clusteradm CLI tool Bootstrap a cluster manager Check out the running instances of the control plane Uninstall the OCM from the control plane     Prerequisite  The hub cluster should be v1.19+. (To run on hub cluster version between [v1.16, v1.18], please manually enable feature gate &amp;ldquo;V1beta1CSRAPICompatibility&amp;rdquo;). Currently the bootstrap process relies on client authentication via CSR. Therefore, Kubernetes distributions that don&amp;rsquo;t support it can&amp;rsquo;t be used as the hub.</description>
+      <description>Prerequisite  Network requirements   Install clusteradm CLI tool Bootstrap a cluster manager Check out the running instances of the control plane Uninstall the OCM from the control plane     Prerequisite  The hub cluster should be v1.19+. (To run on hub cluster version between [v1.16, v1.18], please manually enable feature gate &amp;ldquo;V1beta1CSRAPICompatibility&amp;rdquo;). Currently the bootstrap process relies on client authentication via CSR. Therefore, Kubernetes distributions that don&amp;rsquo;t support it can&amp;rsquo;t be used as the hub.</description>
     </item>
 
     <item>
@@ -25,7 +25,7 @@
 
       <guid>https://open-cluster-management.io/zh/getting-started/installation/register-a-cluster/</guid>
       <description>After the cluster manager is installed on the hub cluster, you need to install the klusterlet agent on another cluster so that it can be registered and managed by the hub cluster.
-   Prerequisite Install clusteradm CLI tool Bootstrap a klusterlet  Bootstrap a klusterlet in hosted mode(Optional) Bootstrap a klusterlet in singleton mode   Accept the join request and verify Apply a Manifestwork  Troubleshooting   Detach the cluster from hub     Prerequisite  The managed clusters should be v1.</description>
+   Prerequisite  Network requirements   Install clusteradm CLI tool Bootstrap a klusterlet  Bootstrap a klusterlet in hosted mode(Optional) Bootstrap a klusterlet in singleton mode   Accept the join request and verify Apply a Manifestwork  Troubleshooting   Detach the cluster from hub     Prerequisite  The managed clusters should be v1.</description>
     </item>
 
   </channel>

diff --git a/zh/getting-started/installation/register-a-cluster/index.html b/zh/getting-started/installation/register-a-cluster/index.html
@@ -275,7 +275,11 @@ <h1>Register a cluster</h1>
 
 
   <div class="gdoc-toc gdoc-toc__level--6"><nav id="TableOfContents"><ul>
-        <li><a href="#prerequisite">Prerequisite</a></li>
+        <li><a href="#prerequisite">Prerequisite</a>
+          <ul>
+            <li><a href="#network-requirements">Network requirements</a></li>
+          </ul>
+        </li>
         <li><a href="#install-clusteradm-cli-tool">Install clusteradm CLI tool</a></li>
         <li><a href="#bootstrap-a-klusterlet">Bootstrap a klusterlet</a>
           <ul>
@@ -299,6 +303,29 @@ <h2 id="prerequisite">Prerequisite</h2>
 <li>The managed clusters should be <code>v1.11+</code>.</li>
 <li>Ensure <a href="https://kubernetes.io/docs/tasks/tools/install-kubectl">kubectl</a> and <a href="https://kubectl.docs.kubernetes.io/installation/kustomize/">kustomize</a> are installed.</li>
 </ul>
+<h3 id="network-requirements">Network requirements</h3>
+<p>Configure your network settings for the managed clusters to allow the following connections.</p>
+<table>
+<thead>
+<tr>
+<th>Direction</th>
+<th>Endpoint</th>
+<th>Protocol</th>
+<th>Purpose</th>
+<th>Used by</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>Outbound</td>
+<td>https://{hub-api-server-url}:{port}</td>
+<td>TCP</td>
+<td>Kubernetes API server of the hub cluster</td>
+<td>OCM agents, including the add-on agents, running on the managed clusters</td>
+</tr>
+</tbody>
+</table>
+<p>To use a proxy, please make sure the proxy server is well configured to allow the above connections and the proxy server is reachable for the managed clusters. See <a href="https://open-cluster-management.io/scenarios/register-cluster-through-proxy/">Register a cluster to hub through proxy server</a> for more details.</p>
 <h2 id="install-clusteradm-cli-tool">Install clusteradm CLI tool</h2>
 <p>It&rsquo;s recommended to run the following command to download and install <strong>the
 latest release</strong> of the <code>clusteradm</code> command-line tool:</p>

diff --git a/zh/getting-started/installation/start-the-control-plane/index.html b/zh/getting-started/installation/start-the-control-plane/index.html
@@ -274,7 +274,11 @@ <h1>Start the control plane</h1>
 
 
   <div class="gdoc-toc gdoc-toc__level--6"><nav id="TableOfContents"><ul>
-        <li><a href="#prerequisite">Prerequisite</a></li>
+        <li><a href="#prerequisite">Prerequisite</a>
+          <ul>
+            <li><a href="#network-requirements">Network requirements</a></li>
+          </ul>
+        </li>
         <li><a href="#install-clusteradm-cli-tool">Install clusteradm CLI tool</a></li>
         <li><a href="#bootstrap-a-cluster-manager">Bootstrap a cluster manager</a></li>
         <li><a href="#check-out-the-running-instances-of-the-control-plane">Check out the running instances of the control plane</a></li>
@@ -292,6 +296,28 @@ <h2 id="prerequisite">Prerequisite</h2>
 For example: <a href="https://github.com/aws/containers-roadmap/issues/1856">EKS</a>.</li>
 <li>Ensure <a href="https://kubernetes.io/docs/tasks/tools/install-kubectl">kubectl</a> and <a href="https://kubectl.docs.kubernetes.io/installation/kustomize/">kustomize</a> are installed.</li>
 </ul>
+<h3 id="network-requirements">Network requirements</h3>
+<p>Configure your network settings for the hub cluster to allow the following connections.</p>
+<table>
+<thead>
+<tr>
+<th>Direction</th>
+<th>Endpoint</th>
+<th>Protocol</th>
+<th>Purpose</th>
+<th>Used by</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>Inbound</td>
+<td>https://{hub-api-server-url}:{port}</td>
+<td>TCP</td>
+<td>Kubernetes API server of the hub cluster</td>
+<td>OCM agents, including the add-on agents, running on the managed clusters</td>
+</tr>
+</tbody>
+</table>
 <h2 id="install-clusteradm-cli-tool">Install clusteradm CLI tool</h2>
 <p>It&rsquo;s recommended to run the following command to download and install <strong>the
 latest release</strong> of the <code>clusteradm</code> command-line tool:</p>

diff --git a/zh/index.xml b/zh/index.xml
@@ -115,7 +115,7 @@ If you define a valid Placement, the placement controller generates a correspond
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
 
       <guid>https://open-cluster-management.io/zh/getting-started/installation/start-the-control-plane/</guid>
-      <description>Prerequisite Install clusteradm CLI tool Bootstrap a cluster manager Check out the running instances of the control plane Uninstall the OCM from the control plane     Prerequisite  The hub cluster should be v1.19+. (To run on hub cluster version between [v1.16, v1.18], please manually enable feature gate &amp;ldquo;V1beta1CSRAPICompatibility&amp;rdquo;). Currently the bootstrap process relies on client authentication via CSR. Therefore, Kubernetes distributions that don&amp;rsquo;t support it can&amp;rsquo;t be used as the hub.</description>
+      <description>Prerequisite  Network requirements   Install clusteradm CLI tool Bootstrap a cluster manager Check out the running instances of the control plane Uninstall the OCM from the control plane     Prerequisite  The hub cluster should be v1.19+. (To run on hub cluster version between [v1.16, v1.18], please manually enable feature gate &amp;ldquo;V1beta1CSRAPICompatibility&amp;rdquo;). Currently the bootstrap process relies on client authentication via CSR. Therefore, Kubernetes distributions that don&amp;rsquo;t support it can&amp;rsquo;t be used as the hub.</description>
     </item>
 
     <item>
@@ -157,7 +157,7 @@ If you define a valid Placement, the placement controller generates a correspond
 
       <guid>https://open-cluster-management.io/zh/getting-started/installation/register-a-cluster/</guid>
       <description>After the cluster manager is installed on the hub cluster, you need to install the klusterlet agent on another cluster so that it can be registered and managed by the hub cluster.
-   Prerequisite Install clusteradm CLI tool Bootstrap a klusterlet  Bootstrap a klusterlet in hosted mode(Optional) Bootstrap a klusterlet in singleton mode   Accept the join request and verify Apply a Manifestwork  Troubleshooting   Detach the cluster from hub     Prerequisite  The managed clusters should be v1.</description>
+   Prerequisite  Network requirements   Install clusteradm CLI tool Bootstrap a klusterlet  Bootstrap a klusterlet in hosted mode(Optional) Bootstrap a klusterlet in singleton mode   Accept the join request and verify Apply a Manifestwork  Troubleshooting   Detach the cluster from hub     Prerequisite  The managed clusters should be v1.</description>
     </item>
 
     <item>