update doc

nebuly-ai · Oct 7, 2024 · c4a2f9b · c4a2f9b
1 parent f66a1d5
commit c4a2f9b
Show file tree

Hide file tree

Showing 2 changed files with 55 additions and 25 deletions.
diff --git a/.terraform-docs.yml b/.terraform-docs.yml
@@ -20,22 +20,37 @@ content: |-
 
   Available on [Terraform Registry](https://registry.terraform.io/modules/nebuly-ai/nebuly-platform/gcp/latest).
 
-  ## APIs to Enable
-  - sqladmin.googleapis.com 
-  - servicenetworking.googleapis.com
-  - cloudresourcemanager.googleapis.com
-  - container.googleapis.com
-  - secretmanager.googleapis.com
+  ## Prerequisites
 
-  ## Quotas
-  - Name: GPUs (all regions)
+  ### Nebuly Credentials
 
+  Before using this Terraform module, ensure that you have your Nebuly credentials ready. 
+  These credentials are necessary to activate your installation and should be provided as input via the `nebuly_credentials` input.
 
-  ## Quickstart
+  ### Required GCP APIs
+
+  Before using this Terraform module, ensure that the following GCP APIs are enabled in your Google Cloud project:
+
+  - [sqladmin.googleapis.com](https://cloud.google.com/sql/docs/mysql/admin-api)
+  - [servicenetworking.googleapis.com](https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started)
+  - [cloudresourcemanager.googleapis.com](https://cloud.google.com/resource-manager/reference/rest)
+  - [container.googleapis.com](https://cloud.google.com/kubernetes-engine/docs/reference/rest)
+  - [secretmanager.googleapis.com](https://cloud.google.com/secret-manager/docs/reference/rest)
+
+  You can enable the APIs using either the GCP Console or the gcloud CLI, as explained in the [GCP Documentation](https://cloud.google.com/endpoints/docs/openapi/enable-api#gcloud).
+
+  ### Required GCP Quotas
 
-  > ⚠️  **Prerequisite**:
-  > before using this Terraform module, ensure that you have your Nebuly credentials ready. 
-  > These credentials are necessary to activate your installation and should be provided as input via the `nebuly_credentials` input.
+  Ensure that your GCP project has the necessary quotas for the following resources over the regions you plan to deploy Nebuly:
+
+  - **Name**: GPUs (all regions) - **Min Value**: 2
+  - **Name**: NVIDIA L4 GPUs -  **Min Value**: 1
+  - **Name**: NVIDIA T4 GPUs -  **Min Value**: 1
+
+  For more information on how to check and increase quotas, refer to the [GCP Documentation](https://cloud.google.com/docs/quotas/view-manage).
+    
+
+  ## Quickstart
 
   To get started with Nebuly installation on GCP, you can follow the steps below. 
 
@@ -55,7 +70,7 @@ content: |-
 
   For connecting to the created GKE cluster, you can follow the steps below. For more information, 
   refer to the [GKE Documentation](https://cloud.google.com/kubernetes-engine/docs/how-to/cluster-access-for-kubectl).
- 
+
   * Install the [GCloud CLI](https://cloud.google.com/sdk/docs/install-sdk).
 
   * Install [kubectl](https://kubernetes.io/docs/reference/kubectl/):

diff --git a/README.md b/README.md
@@ -4,22 +4,37 @@ Terraform module for provisioning Nebuly Platform resources on GCP.
 
 Available on [Terraform Registry](https://registry.terraform.io/modules/nebuly-ai/nebuly-platform/gcp/latest).
 
-## APIs to Enable
-- sqladmin.googleapis.com 
-- servicenetworking.googleapis.com
-- cloudresourcemanager.googleapis.com
-- container.googleapis.com
-- secretmanager.googleapis.com
+## Prerequisites
 
-## Quotas
-- Name: GPUs (all regions)
+### Nebuly Credentials
 
+Before using this Terraform module, ensure that you have your Nebuly credentials ready. 
+These credentials are necessary to activate your installation and should be provided as input via the `nebuly_credentials` input.
 
-## Quickstart
+### Required GCP APIs
+
+Before using this Terraform module, ensure that the following GCP APIs are enabled in your Google Cloud project:
+
+- [sqladmin.googleapis.com](https://cloud.google.com/sql/docs/mysql/admin-api)
+- [servicenetworking.googleapis.com](https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started)
+- [cloudresourcemanager.googleapis.com](https://cloud.google.com/resource-manager/reference/rest)
+- [container.googleapis.com](https://cloud.google.com/kubernetes-engine/docs/reference/rest)
+- [secretmanager.googleapis.com](https://cloud.google.com/secret-manager/docs/reference/rest)
+
+You can enable the APIs using either the GCP Console or the gcloud CLI, as explained in the [GCP Documentation](https://cloud.google.com/endpoints/docs/openapi/enable-api#gcloud).
+
+### Required GCP Quotas
 
-> ⚠️  **Prerequisite**:
-> before using this Terraform module, ensure that you have your Nebuly credentials ready. 
-> These credentials are necessary to activate your installation and should be provided as input via the `nebuly_credentials` input.
+Ensure that your GCP project has the necessary quotas for the following resources over the regions you plan to deploy Nebuly:
+
+- **Name**: GPUs (all regions) - **Min Value**: 2
+- **Name**: NVIDIA L4 GPUs -  **Min Value**: 1
+- **Name**: NVIDIA T4 GPUs -  **Min Value**: 1
+
+For more information on how to check and increase quotas, refer to the [GCP Documentation](https://cloud.google.com/docs/quotas/view-manage).
+
+
+## Quickstart
 
 To get started with Nebuly installation on GCP, you can follow the steps below.