-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Update deployment template to use ECR. * Prepare the v1.0.0 release 🎉 * Update ECS deployment example and documentation.
- Loading branch information
Showing
15 changed files
with
87 additions
and
51 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
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 |
---|---|---|
|
@@ -155,3 +155,4 @@ cython_debug/ | |
.terraform.lock.hcl | ||
*.tfstate | ||
*.tfstate.backup | ||
*.lock.info |
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
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 |
---|---|---|
@@ -1,6 +1,6 @@ | ||
"""Grove metadata.""" | ||
|
||
__version__ = "1.0.0rc6" | ||
__version__ = "1.0.0" | ||
__title__ = "grove" | ||
__license__ = "Mozilla Public License 2.0" | ||
__copyright__ = "Copyright 2023 HashiCorp, Inc." |
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,24 @@ | ||
## AWS ECS (Fargate) Scheduled Deployment | ||
|
||
This deployment example uses AWS ECS Fargate to deploy Grove into AWS. This configures | ||
Grove to execute every 10-minutes, and allows configuration of connections using JSON | ||
documents placed under the `connectors/` directory in this folder. | ||
|
||
To deploy using this template, Terraform should be installed on the machine used to | ||
deploy Grove. | ||
|
||
1. Login to an AWS account with the required permissions to deploy new services on the command-line. | ||
2. Use Terraform to create the infrastructure required. You will be prompted for the name of the S3 bucket to create to output collected logs to. | ||
1. `terraform init` | ||
1. `terraform plan` | ||
1. `terraform apply` | ||
3. Note the output ECR repository URL, as this is required to publish a Grove container image to. | ||
|
||
This deployment requires a container image to be created and pushed into the created ECR | ||
repository. The steps for building this image using Docker can be found below: | ||
|
||
1. Build a new image using the `Dockerfile` in the root of this repository. | ||
1. `docker image build -t grove:latest` | ||
|
||
To authenticate with AWS ECR, tag and publish the container image ready for use, please | ||
follow the AWS documentation on ["Publishing a Docker image"](https://docs.aws.amazon.com/AmazonECR/latest/userguide/docker-push-ecr-image.html). |
2 changes: 1 addition & 1 deletion
2
templates/deployment/terraform-aws-ecs/connectors/local_heartbeat/local_heartbeat.json
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 |
---|---|---|
@@ -1,6 +1,6 @@ | ||
{ | ||
"name": "local_heartbeat", | ||
"connector": "local_heartbeat", | ||
"identity": "b603c5cd-16f5-4a80-bf03-7e2289a046e7", | ||
"identity": "deployment_demo", | ||
"key": "local_heartbeat" | ||
} |
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
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
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
6 changes: 6 additions & 0 deletions
6
templates/deployment/terraform-aws-ecs/modules/grove/output.tf
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,6 @@ | ||
# Copyright (c) HashiCorp, Inc. | ||
# SPDX-License-Identifier: MPL-2.0 | ||
|
||
output "ecr_repository_url" { | ||
value = aws_ecr_repository.grove.repository_url | ||
} |
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
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
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,6 @@ | ||
# Copyright (c) HashiCorp, Inc. | ||
# SPDX-License-Identifier: MPL-2.0 | ||
|
||
output "ecr_repository_url" { | ||
value = module.grove.ecr_repository_url | ||
} |
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
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,13 @@ | ||
# Copyright (c) HashiCorp, Inc. | ||
# SPDX-License-Identifier: MPL-2.0 | ||
|
||
variable "container_image_tag" { | ||
description = "The tag to use when deploying the Grove container image (ECR)." | ||
type = string | ||
default = "latest" | ||
} | ||
|
||
variable "output_bucket_name" { | ||
description = "The name of the S3 bucket to create for outputting logs to." | ||
type = string | ||
} |