diff --git a/.terraform-docs.yml b/.terraform-docs.yml index 426a77a..f763946 100644 --- a/.terraform-docs.yml +++ b/.terraform-docs.yml @@ -20,22 +20,29 @@ 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 - - ## Quotas - - Name: GPUs (all regions) + ## Prerequisites + ### Nebuly Credentials - ## Quickstart + 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. + + ### 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) - > ⚠️ **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. + You can enable the APIs using either the GCP Console or the gcloud CLI. For more information, refer to the [GCP Documentation](https://cloud.google.com/endpoints/docs/openapi/enable-api#gcloud). + + ### Required GCP Quotas + - Name: GPUs (all regions) + + ## Quickstart To get started with Nebuly installation on GCP, you can follow the steps below. @@ -55,7 +62,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 index ddf2402..73312d6 100644 --- a/README.md +++ b/README.md @@ -4,22 +4,29 @@ 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 - -## Quotas -- Name: GPUs (all regions) +## Prerequisites +### Nebuly Credentials -## Quickstart +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. + +### 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) -> ⚠️ **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. +You can enable the APIs using either the GCP Console or the gcloud CLI. For more information, refer to the [GCP Documentation](https://cloud.google.com/endpoints/docs/openapi/enable-api#gcloud). + +### Required GCP Quotas +- Name: GPUs (all regions) + +## Quickstart To get started with Nebuly installation on GCP, you can follow the steps below.