jupyter-deploy-tf-aws-ec2-ngrok-test 0.1.0a1

No project description provided

Jupyter Deploy Terraform AWS EC2 Ngrok

This package provides a Terraform preset for deploying a Jupyter Server on AWS EC2 using ngrok for TLS.

Description

This terraform project creates an AWS EC2 instance in the default VPC that connects to ngrok for TLS.

The instance is configured so that you can access it using AWS SSM.

This project:

• places the instance in the first subnet of the default VPC
• select the latest AL 2023 AMI for x86_64 architecture
• sets up an IAM role to enable SSM access
• passes on the root volume of the AMI
• adds an EBS volume which will mount on the Jupyter Server container
• creates an SSM instance-startup script, which references 3 files:
  • cloudinit.sh for the basic setup of the instance
  • docker-compose.yml for the docker services to run in the instance
  • docker-startup.sh to run the docker-compose up cmd and post docker-start instructions
• creates an SSM association, which runs the startup script on the instance

Installation

From the root of this package, run:

pip install -e jupyter-deploy-tf-aws-ec2-ngrok

Usage

This package is used by jupyter-deploy. Once installed, the template will be automatically available for use via the jupyter-deploy CLI.

jupyter-deploy terraform generate --provider aws --infra ec2 --template tls-via-ngrok

Requirements

Name	Version
terraform	>= 1.0
aws	>= 4.66

Resources

Name	Type
aws_security_group	resource
aws_instance	resource
aws_iam_role	resource
aws_iam_role_policy_attachment	resource
aws_iam_instance_profile	resource
aws_ebs_volume.jupyter_data	resource
aws_volume_attachment	resource
aws_ssm_document	resource
aws_ssm_association	resource

Inputs

Name	Type	Default	Description
aws_region	string	null	AWS region where the resources should be created
instance_type	string	t3.micro	The type of instance to start
key_name	string	null	The name of key pair
ami_id	string	null	The ID of the AMI to use for the instance
jupyter_data_volume_size	number	30	The size in GB of the EBS volume the Jupyter Server has access to
jupyter_data_volume_type	string	gp3	The type of EBS volume the Jupyter Server will has access to
iam_role_prefix	string	JD-TlsViaNgrok-Exec	The prefix for the name of the IAM role for the instance
custom_tags	map(string)	{}	The custom tags to add to all the resources
cloudinit.sh	file	-	bash script to install packages, mount volumes and setup permissions
docker-compose.yml	file	docker compose file to start the docker services
docker-startup.sh	file	bash script to run docker-compose and post docker-start instructions

Outputs

Name	Description
aws_instance.id	The ID of the EC2 instance