Merge pull request #7240 from aniruddha2000/aniruddha/github-pat-doc

📖Add GitHub PAT doc

Author: k8s-ci-robot

docs/book/src/clusterctl/commands/init.md

@@ -181,7 +181,7 @@ If this happens, there are no guarantees about the proper functioning of `cluste
 
 Cluster API providers require a cert-manager version supporting the `cert-manager.io/v1` API to be installed in the cluster.
 
-While doing init, clusterctl checks if there is a version of cert-manager already installed. If not, clusterctl will 
+While doing init, clusterctl checks if there is a version of cert-manager already installed. If not, clusterctl will
 install a default version (currently cert-manager v1.9.1). See [clusterctl configuration](../configuration.md) for
 available options to customize this operation.
 
@@ -190,8 +190,11 @@ available options to customize this operation.
 <h1>Warning</h1>
 
 Please note that, if clusterctl installs cert-manager, it will take care of its lifecycle, eventually upgrading it
-during clusterctl upgrade. Instead, if cert-manager is provided by the users, the user is responsible for 
+during clusterctl upgrade. Instead, if cert-manager is provided by the users, the user is responsible for
 upgrading this component when required.
 
 </aside>
 
+## Avoiding GitHub rate limiting
+
+Follow [this](../overview.md#avoiding-github-rate-limiting)

docs/book/src/clusterctl/configuration.md

@@ -95,6 +95,10 @@ If no value is specified, or the format is invalid, the default value of 10 minu
 
 Please note that the configuration above will be considered also when doing `clusterctl upgrade plan` or `clusterctl upgrade plan`.
 
+## Avoiding GitHub rate limiting
+
+Follow [this](./overview.md#avoiding-github-rate-limiting)
+
 ## Overrides Layer
 
 <aside class="note warning">

docs/book/src/clusterctl/overview.md

@@ -22,9 +22,15 @@ Below you can find a list of main clusterctl commands:
 
 For the full list of clusterctl commands please refer to [commands](commands/commands.md).
 
+### Avoiding GitHub rate limiting
+
+While using providers hosted on GitHub, clusterctl is calling GitHub API which are rate limited; for normal usage free tier is enough but when using clusterctl extensively users might hit the rate limit.
+
+To avoid rate limiting for the public repos set the `GITHUB_TOKEN` environment variable. To generate a token [follow this](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) documentation. The token only needs `repo` scope for clusterctl.
+
 # Installing clusterctl
 Instructions are available in the [Quick Start](../user/quick-start.md#install-clusterctl).
 
 <!-- links -->
 [management cluster]: ../reference/glossary.md#management-cluster
-[provider components]: ../reference/glossary.md#provider-components
+[provider components]: ../reference/glossary.md#provider-components