nebari-dev / nebari-dev/nebari-docs
[DOC] - Add AWS private subnet deployment info to docs
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 21
- Forks
- 40
- Avg merge
- 19h 50m
- Merged PRs (30d)
- 6
Description
Preliminary Checks
- This issue is not a question, feature request, RFC, or anything other than a bug report. Please post those things in GitHub Discussions: https://github.com/nebari-dev/nebari/discussions
Summary
https://www.nebari.dev/docs/explanations/custom-overrides-configuration#deployment-inside-a-virtual-private-network details how to deploy nebari within a private subnet for Azure and GCP. We should add a section for AWS.
To do this on AWS, the nebari config file will look something like the below:
amazon_web_services:
terraform_overrides:
existing_subnet_ids: ["subnet-0bf040134a53b8a6c", "subnet-0c9817baf30a85128"] # These are your private subnets where you've set up a NAT Gateway in the routing table and removed the internet gateway. Picture below.
existing_security_group_id: "sg-0efb1b832e3540289"
eks_endpoint_private_access: true
Routing table example:
It's important to note that the security group entered for existing_security_group_id must have an inbound rule that allows traffic with any source within the VPC's CIDR block (example of adding this in the image below). The exact range will depend on the VPC's CIDR block. When I failed to do this, the jupyterhub-sftp helm chart failed to deploy b/c it couldn't mount the EFS drive to the jupyterhub-sftp pod.
This is also dependent on https://github.com/nebari-dev/nebari/pull/1841 getting merged.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the custom overrides configuration page section “Deployment inside a virtual private network,” which already covers Azure and GCP. Add the AWS private-subnet configuration and routing/security-group guidance shown in the issue, including the EFS mount requirement, after checking the dependency on nebari pull request #1841. Done means the documentation explains the AWS setup clearly alongside the existing providers.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- aws, terraform
- Domain
- cloud, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100