Skip to content

Commit

Permalink
Merge pull request #51 from anyscale/brent/example-kms-cleanup
Browse files Browse the repository at this point in the history
fix: Example documentation for KMS
  • Loading branch information
brent-anyscale authored Sep 5, 2024
2 parents 832ac72 + 7fcd9bd commit d1d15d1
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 9 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[![AWS Provider Version][badge-tf-aws]](https://github.com/terraform-providers/terraform-provider-aws/releases)

# Terraform Modules for Anyscale Cloud Foundations on AWS
[Terraform] modules to manage cloud infrastructure for Anyscale. This builds the foundational cloud resources needed to run Anyscale in a cloud environment. This module and sub-modules support Google Cloud.
[Terraform] modules to manage cloud infrastructure for Anyscale. This builds the foundational cloud resources needed to run Anyscale in a cloud environment. This module and sub-modules support AWS Cloud.

**THIS IS PROVIDED AS A STARTING POINT**

Expand Down
14 changes: 7 additions & 7 deletions examples/anyscale-v2-kms/README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
# Anyscale Networking Stack v2 - KMS Encryption for S3 and EFS

This **example** will build the resources necessary to run Anyscale in an AWS account. This example will build a
This **example** will build the resources necessary to run Anyscale in an AWS account. This example will create a
[Direct Networking](https://docs.anyscale.com/cloud-deployment/aws/manage-clouds#anyscale-clouds-on-aws) solution.

EFS and S3 will use a common KMS Key, however each of these could be unique.
In this example, the EFS and S3 will use a shared KMS Key; however, each could be unique.

## To execute
A general understanding of Terraform and AWS are useful for executing this Terraform. For a high level overview of both,
please see the [getting started guide](https://github.com/anyscale/terraform-aws-anyscale-cloudfoundation-modules/blob/main/getting-started.md).
A general understanding of Terraform and AWS is helpful for understanding how to execute this Terraform. For a high-level overview of both,
please see the [Getting Started guide](https://github.com/anyscale/terraform-aws-anyscale-cloudfoundation-modules/blob/main/getting-started.md).

## Using with Anyscale CLI
## Using with the Anyscale CLI

The outputs from this Terraform can be used to build an anyscale cloud with the anyscale CLI. To use:
1. Make sure you have the latest Anyscale CLI installed `pip install anyscale --upgrade`
2. The terraform output, `anyscale_register_command` will provide an example Anyscale CLI command that can be used to register an Anyscale Cloud. You will need to change `<CUSTOMER_DEFINED_NAME>` to a cloud name that you would like to use.
2. The terraform output: `anyscale_register_command` will provide an example of an Anyscale CLI command you can use to register an Anyscale Cloud. You must change the value: `<CUSTOMER_DEFINED_NAME>` to a cloud name you would like to use.

example:
Example:

```
anyscale cloud register --provider aws \
Expand Down
1 change: 0 additions & 1 deletion examples/anyscale-v2-kms/main.tf
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# ---------------------------------------------------------------------------------------------------------------------
# Create core Anyscale v2 Stack resources with minimal parameters but a common name
# Should be executed in us-east-2
# Creates a v2 stack including
# - IAM Roles
# - S3 Bucket
Expand Down

0 comments on commit d1d15d1

Please sign in to comment.