-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: fully working configuration for Private access (#318)
* chore: fully working configuration for Private access * fix: Rate limiting of aws R53 (#314) AWS rate limiting fix of route 53 * chore(release): version 5.2.1 [skip ci] ### [5.2.1](v5.2.0...v5.2.1) (2024-12-19) ### Bug Fixes * Rate limiting of aws R53 ([#314](#314)) ([55854a3](55854a3)) * fix: Bump obsolete aws-mysql-engine verions in examples (#316) * chore(release): version 5.2.2 [skip ci] ### [5.2.2](v5.2.1...v5.2.2) (2024-12-26) ### Bug Fixes * Bump obsolete aws-mysql-engine verions in examples ([#316](#316)) ([47a904e](47a904e)) --------- Co-authored-by: PNarode <[email protected]> Co-authored-by: Zachary Blasczyk <[email protected]> Co-authored-by: semantic-release-bot <[email protected]> Co-authored-by: Jonathan Meeks <[email protected]> Co-authored-by: Flamarion Jorge <[email protected]>
- Loading branch information
1 parent
4f21156
commit 633e06c
Showing
1 changed file
with
95 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,95 @@ | ||
# README for Private Access Only Example | ||
|
||
## Overview | ||
|
||
This example demonstrates how to set up a private access-only configuration for Weights & Biases (W&B) using Terraform on AWS. This configuration ensures that W&B services are accessible only within a specified Virtual Private Cloud (VPC), enhancing security by preventing public internet access. | ||
|
||
## Prerequisites | ||
|
||
Before you begin, ensure you have the following: | ||
|
||
- **AWS Account**: An active AWS account is required. | ||
- **Terraform**: Install Terraform on your local machine. You can download it from [Terraform's official website](https://www.terraform.io/downloads.html). | ||
- **AWS CLI**: Install and configure the AWS CLI with appropriate permissions to create resources in your account. | ||
|
||
## Getting Started | ||
|
||
### Clone the Repository | ||
|
||
Clone the repository to your local machine: | ||
|
||
```bash | ||
git clone https://github.com/wandb/terraform-aws-wandb.git | ||
cd terraform-aws-wandb/examples/private-access-only | ||
``` | ||
|
||
### Configuration | ||
|
||
1. **Modify Variables**: Open the `variables.tf` file and adjust the variables according to your requirements, such as VPC ID, subnet IDs, and region. | ||
|
||
2. **Create a Terraform Variables File**: Create a `terraform.tfvars` file to specify values for the variables defined in `variables.tf`. For example: | ||
|
||
```hcl | ||
namespace = "your-namespace" | ||
allowed_inbound_cidr = "inbound cidr" | ||
vpc_id = "your-vpc-id" | ||
subnet_ids = ["subnet-xxxxxx", "subnet-yyyyyy"] | ||
region = "us-west-2" | ||
``` | ||
|
||
### Initialize Terraform | ||
|
||
Run the following command to initialize Terraform. This command downloads the necessary provider plugins: | ||
|
||
```bash | ||
terraform init | ||
``` | ||
|
||
### Plan the Deployment | ||
|
||
Before applying changes, it's a good practice to see what will be created: | ||
|
||
```bash | ||
terraform plan | ||
``` | ||
|
||
### Apply the Configuration | ||
|
||
To create the resources defined in your Terraform configuration, run: | ||
|
||
```bash | ||
terraform apply | ||
``` | ||
|
||
You will be prompted to confirm before proceeding. Type `yes` to continue. | ||
|
||
### Accessing W&B | ||
|
||
After deployment, you will have a private access-only setup for W&B. Ensure that any services or applications that need to access W&B are running within the same VPC or have appropriate connectivity (e.g., VPN). | ||
|
||
## Cleanup | ||
|
||
To remove all resources created by this example, run: | ||
|
||
```bash | ||
terraform destroy | ||
``` | ||
|
||
You will again be prompted to confirm. Type `yes` to proceed with resource deletion. | ||
|
||
## Additional Resources | ||
|
||
- [Terraform Documentation](https://www.terraform.io/docs/index.html) | ||
- [Weights & Biases Documentation](https://docs.wandb.ai/) | ||
- [AWS Documentation](https://docs.aws.amazon.com/) | ||
|
||
## License | ||
|
||
This project is licensed under the MIT License - see the [LICENSE](https://github.com/wandb/terraform-aws-wandb/blob/main/LICENSE) file for details. | ||
|
||
--- | ||
|
||
This README provides a concise guide for users looking to deploy a private access-only W&B setup using Terraform on AWS. Adjust any sections as necessary based on specific configurations or additional instructions relevant to your use case. | ||
|
||
Citations: | ||
[1] https://github.com/wandb/terraform-aws-wandb/tree/main/examples/private-access-only |