nebari-dev / nebari-dev/nebari-docs

AWS Private deployments(network)

Open
#405 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

needs: PR 📬 type: enhancement 💅🏼
Dominant language
No language data
Stars
21
Forks
40
Avg merge
19h 50m
Merged PRs (30d)
6

Description

Context

When doing a private implementation subnets and security groups and other might need to be passed down into the deployment implementation, there minimal AWS guidance on how to achieve this.

Value and/or benefit

Improving current documentation: https://www.nebari.dev/docs/explanations/custom-overrides-configuration#deployment-inside-a-virtual-private-network

Anything else?

To create a session that explain a private deployment using AWS:
You can deploy your Nebari environment in an AWS private VPC using the following subnets and security groups. Here is a sample of that confirguration. Using also permissiuons boundary and tagging as a sample:

amazon_web_services:
  tags:
    application: "nebari"
    project: "datascience"
    owner: "michael.scott"
    costid: "12345"
  permissions_boundary: arn:aws:iam::1234567890123:policy/<Permissions-Boundary>
  existing_subnet_ids: ["subnet-0c3daad2dc0a12345", "subnet-0962123454112394a"]
  existing_security_group_id: sg-123456787c33c051cc
  kubernetes_version: '1.26'
  region: us-east-1
  node_groups:
    general:
      instance: m5.2xlarge
      min_nodes: 1
      max_nodes: 1
    user:
      instance: m5.xlarge
      min_nodes: 1
      max_nodes: 100
    worker:
      instance: m5.xlarge
      min_nodes: 0
      max_nodes: 450

Deployment inside a virtual network is slightly different from deploying inside a public network. As the name suggests, since it's a virtual private network, you need to be inside the network to able to deploy and access Nebari. One way to achieve this is by creating a Virtual Machine (VM) inside the virtual network. Select the virtual network and subnet name under the networking settings of your cloud provider while creating the VM and then follow the usual deployment instructions as you would deploy from your local machine.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the linked custom-overrides configuration section and the AWS configuration example in the issue. Compare the existing private-network guidance with the supplied VPC, subnet, security-group, permissions-boundary, and tagging details; the documentation is done when it clearly explains the private deployment prerequisites and includes an accurate example.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, kubernetes
Domain
cloud, documentation, networking
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.