Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Telemaco019 committed Oct 7, 2024
1 parent f66a1d5 commit d03d988
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 27 deletions.
35 changes: 21 additions & 14 deletions .terraform-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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/):
Expand Down
33 changes: 20 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit d03d988

Please sign in to comment.