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.

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

Instructions to launch a test instance from a VM #348

Merged
merged 4 commits into from
Dec 2, 2024

Conversation

phbnf
Copy link
Contributor

@phbnf phbnf commented Dec 2, 2024

Towards #312 and #24

This PR adds a terraform module, terragrunt config and documentation to launch a Trillian Tessera test stack from an AWS EC2 VM, and to launch a conformance binary on that VM.

It brings minor modifications to the base /storage module, which will be also relied on for the CI environment.

@phbnf phbnf added documentation Improvements or additions to documentation enhancement New feature or request labels Dec 2, 2024
@phbnf phbnf added this to the alpha milestone Dec 2, 2024
@phbnf phbnf requested a review from AlCutter December 2, 2024 12:14
@phbnf phbnf mentioned this pull request Dec 2, 2024
Copy link
Collaborator

@AlCutter AlCutter left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a very cursory review as I'm not really a terraform or AWS expert.

Couple of rando nits inline.

This codelab helps you bring a test Trillian Tessera stack on AWS,
and to use it running a test personality server on an EC2 VM.
The Tessera test stack will be comprised of an Aurora RDS MySQL database
and a private S3 bubket. This codelab will also guide you to connect both
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/bubket/bucket


aws s3 ls --profile AdministratorAccess-<REDACTED>
```
1. Set these environment variables according to the you chose when configuring
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"to the you chose"?

```
git clone https://github.com/transparency-dev/trillian-tessera
```
1. Init terragrunt:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this need to be done in a particular directory?

terragrunt apply --terragrunt-working-dir=deployment/live/aws/codelab/
```
This brings up the Terraform infrastructure (S3 bucket + dynanoDB table
for locking) and the Trillian Tessera stack: an RDS Aurora instance,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
for locking) and the Trillian Tessera stack: an RDS Aurora instance,
for terraform state locking only) and the Trillian Tessera stack: an RDS Aurora instance,

```
mkdir -p /home/ec2-user/tessera-keys
go run github.com/transparency-dev/serverless-log/cmd/generate_keys@80334bc9dc573e8f6c5b3694efad6358da50abd4 \
--key_name=$LOG_NAME/test/conformance \
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's in ${LOG_NAME} output from terragrunt?
Should it also contain ".../test/conformance"?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the prefix that is used to name resources. It doesn't use slashes, but dashes. For the purpose of this example, it will be trillian-tessera-codelab-<ACCOUNT_ID>. I've aligned the name of the key with this.

Log entries can be read directly from S3 without going through the server,
at `READ_URL=https://$LOG_BUCKET.s3.$AWS_REGION.amazonaws.com/`
1. Head over to the [remainder of this codelab](https://github.com/transparency-dev/trillian-tessera/tree/main/cmd/conformance#codelab)
add leaves to the log.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
add leaves to the log.
to add leaves to the log.

@phbnf phbnf merged commit e709953 into transparency-dev:main Dec 2, 2024
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants