Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Improve BYOB config #174

Merged
merged 2 commits into from
Oct 16, 2024
Merged

fix: Improve BYOB config #174

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
60eb4d4
improved the Readmes to point to our public documentations
mkaesz-wandb Oct 11, 2024
fe4c588
improved the Readmes to point to our public documentations
mkaesz-wandb Oct 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions examples/byob/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# Bring Your Own Bucket (BYOB)

This example does not deploy an instance of Weights & Biases. It creates a
google bucket configured for support managed single tenant installs.
## About

---
Weights & Biases can connect to a GCP Bucket created and owned by the customer. This is called BYOB (Bring your own bucket). More details (here)[https://docs.wandb.ai/guides/hosting/data-security/secure-storage-connector#provision-the-gcs-bucket].

This example does not deploy a Weights & Biases instance. It deploys all required resources (GCP bucket and permissions) in the customer's account and grants the W&B GCP Service Account access to the bucket.

When using bring your own bucket you will need to grant our service account
access to an google bucket provisioned in project account.
---

## Provision Bucket using Terraform
## Using Terraform

1. Install [Terraform
1.0+](https://learn.hashicorp.com/tutorials/terraform/install-cli?in=terraform/gcp-get-started)
Expand All @@ -26,6 +26,6 @@ access to an google bucket provisioned in project account.
7. Fill out any required information and approve.
8. Please provide the resulting output to customer support.

## Provision Bucket Manually
## Using the GCP Console

_WIP_
Please refer to the (public documentation)[https://docs.wandb.ai/guides/hosting/data-security/secure-storage-connector#provision-the-gcs-bucket] on how to create all required resources manually.
27 changes: 21 additions & 6 deletions modules/secure_storage_connector/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
# Weights & Biases Secure Storage Connector Module

## About

Weights & Biases can connect to a GCP Bucket created and owned by the customer. This is called BYOB (Bring your own bucket). More details (here)[https://docs.wandb.ai/guides/hosting/data-security/secure-storage-connector#provision-the-gcs-bucket].

This example does not deploy a Weights & Biases instance. It deploys all required resources (GCP bucket and permissions) in the customer's account and grants the W&B GCP Service Account access to the bucket.

---

## Using Terraform

This is a Terraform module for provisioning a google cloud storage bucket to be used with Weights and Biases. To use this bucket
with Weights and Biases multi-tenant cloud, pass `[email protected]` for the
`service_account_email` variable.
Expand All @@ -8,7 +18,7 @@ with Weights and Biases multi-tenant cloud, pass `wandb-integration@wandb-produc

- Google Storage Bucket

## How to Use This Module
### How to Use This Module

- Ensure account meets module pre-requisites from above.
- Create a Terraform configuration that pulls in this module and specifies
Expand All @@ -32,20 +42,20 @@ module "wandb" {

<!-- BEGIN_TF_DOCS -->

## Requirements
### Requirements

| Name | Version |
|------|---------|
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | ~> 1.0 |
| <a name="requirement_google"></a> [google](#requirement\_google) | ~> 4.31 |

## Providers
### Providers

| Name | Version |
|-----------------------------------------------------------|---------|
| <a name="provider_google"></a> [google](#provider_google) | 4.31 |

## Inputs
### Inputs

| Name | Description | Type | Default | Required |
|--------------------------------------------------------------------------------------------------|--------------------------------------------------------|----------|---------|:--------:|
Expand All @@ -55,10 +65,15 @@ module "wandb" {
| <a name="input_service_account_email"></a> [service_account_email](#input_service_account_email) | The service account that can access the bucket | `string` | `null` | yes |
| <a name="input_deletion_protection"></a> [wandb_deletion_protection](#input_deletion_protection) | If deletion protection should be enabled on the bucket | `bool` | `false` | no |

## Outputs
### Outputs

| Name | Description |
|-----------------------------------------------------------------------------|-------------------------------------------------------------------------|
| <a name="bucket_name"></a> [bucket_name](#bucket_name) | The name of the bucket created |

<!-- END_TF_DOCS -->
<!-- END_TF_DOCS -->


## Using the GCP Console

Please refer to the (public documentation)[https://docs.wandb.ai/guides/hosting/data-security/secure-storage-connector#provision-the-gcs-bucket] on how to create all required resources manually.
Loading