Skip to content

Commit

Permalink
Remove infracost docs, update in prep for 2023.9.1 (#366)
Browse files Browse the repository at this point in the history
  • Loading branch information
iameskild authored Sep 26, 2023
1 parent 28c7a9b commit 6c544aa
Show file tree
Hide file tree
Showing 7 changed files with 44 additions and 140 deletions.
49 changes: 33 additions & 16 deletions docs/docs/explanations/advanced-custom-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,37 +143,54 @@ This is quite useful for pinning the IP Address of the load balancer.

<TabItem value="azure" label="Azure" default="true" >

Using terraform overrides you can also deploy inside a Virtual Private Network (VPN).
You can deploy your cluster into a Virtual Private Network (VPN) or Virtual Network (VNET).

An example configuration for Azure is given below:

```yaml
azure:
terraform_overrides:
private_cluster_enabled: true
vnet_subnet_id: '/subscriptions/<subscription_id>/resourceGroups/<resource_group>/providers/Microsoft.Network/virtualNetworks/<vnet-name>/subnets/<subnet-name>'
region: Central US
...
vnet_subnet_id: '/subscriptions/<subscription_id>/resourceGroups/<resource_group>/providers/Microsoft.Network/virtualNetworks/<vnet-name>/subnets/<subnet-name>'
```

If you want the AKS cluster to be [private cluster](https://learn.microsoft.com/en-us/azure/aks/private-clusters?tabs=azure-portal).

For extra security, you can deploy your cluster from an [Azure Bastion host](https://learn.microsoft.com/en-us/azure/aks/operator-best-practices-network#securely-connect-to-nodes-through-a-bastion-host) (or jump host), making the Kubernetes API only accessible from this one secure machine. You will likely need to also modify the network_profile as follows:

```yaml
azure:
region: Central US
private_cluster_enabled: true
vnet_subnet_id: '/subscriptions/<subscription_id>/resourceGroups/<resource_group>/providers/Microsoft.Network/virtualNetworks/<vnet-name>/subnets/<subnet-name>'
network_profile:
service_cidr: "10.0.2.0/24" # how many IPs would you like to reserve for Nebari
network_plugin: "azure"
network_policy: "azure"
dns_service_ip: "10.0.2.10" # must be within the `service_cidr` range from above
docker_bridge_cidr: "172.17.0.1/16" # no real need to change this

```


</TabItem>

<TabItem value="gcp" label="GCP" default="true" >

Using terraform overrides you can also deploy inside a [Virtual Private Cloud (VPC) in GCP](https://cloud.google.com/vpc/docs/overview), making the Kubernetes cluster private. Here is an example configuration:
You can also deploy inside a [Virtual Private Cloud (VPC) in GCP](https://cloud.google.com/vpc/docs/overview), making the Kubernetes cluster private. Here is an example configuration:

```yaml
google_cloud_platform:
terraform_overrides:
networking_mode: "VPC_NATIVE"
network: "your-vpc-name"
subnetwork: "your-vpc-subnet-name"
private_cluster_config:
enable_private_nodes: true
enable_private_endpoint: true
master_ipv4_cidr_block: "172.16.0.32/28"
master_authorized_networks_config:
cidr_block: null
display_name: null
networking_mode: "VPC_NATIVE"
network: "your-vpc-name"
subnetwork: "your-vpc-subnet-name"
private_cluster_config:
enable_private_nodes: true
enable_private_endpoint: true
master_ipv4_cidr_block: "172.16.0.32/28"
master_authorized_networks_config:
cidr_block: null
display_name: null
```
As the name suggests the cluster will be private, which means it would not have access to the internet - not ideal for deploying pods in the cluster. Therefore, we need
Expand Down
6 changes: 5 additions & 1 deletion docs/docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ and so which way depends on your use-case.

The longer answer:

- For global environments, you can specify the environment in `nebari_config.yml`, and it will be made available for all users and services (for example, CDSDashboards).
- For global environments, you can specify the environment in `nebari-config.yml`, and it will be made available for all users and services.
- By comparison, creating the environments through conda-store will provide more granular control over certain settings and permissions.

As Nebari and conda-store mature, the intent is to migrate exclusively to conda-store for environment creation and management.
Expand All @@ -30,6 +30,10 @@ There are drop-in replacements for `distributed`, `dask`, and `dask-gateway` wit

## What packages are needed in your environment to create a dashboard?

:::info
CDS Dashboards has been deprecated in version `2023.9.1`.
:::

When deploying an app via CDS Dashboards, you will always need to have `cdsdashboards-singleuser` installed in your environment. This allows your environment to show up on the environment options menu when creating your app.

Furthermore, with each framework, you will need to make sure that the specific framework you are deploying is installed. You will need to install `streamlit` for a streamlit app, `panel` for a panel app, etc.
Expand Down
4 changes: 4 additions & 0 deletions docs/docs/how-tos/nebari-aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,10 @@ nebari init aws --project projectname \
You will be prompted to enter values for some choices above if they are absent from the command line arguments (for example, project name and domain)
:::

:::note
Nebari can also be deployed into an [AWS GovCloud](https://docs.aws.amazon.com/govcloud-us/latest/UserGuide/whatis.html) account, you simply need to ensure you specify the appropriate AWS GovCloud region in the `amazon_web_services.region` field of your `nebari-config.yaml`.
:::

Once `nebari init` is executed, you should then be able to see the following output:

```bash
Expand Down
116 changes: 0 additions & 116 deletions docs/docs/tutorials/cost-estimate-report.md

This file was deleted.

6 changes: 2 additions & 4 deletions docs/docs/tutorials/creating-cds-dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,8 @@ description: Quickly build and deploy a panel and CDS Dashboards

:::danger

CDS Dashboards will be deprecated soon.
Nebari 2023.7.1 will be the last release with support for CDS Dashboards integration.
A new dashboard sharing mechanism added in the near future, but some releases in the interim will not have dashboard sharing capabilities.

CDS Dashboards has been deprecated in `2023.9.1`.
Nebari 2023.7.1 is the last release that support CDS Dashboards. A new dashboard sharing mechanism will be added in the near future.
:::

## Introduction
Expand Down
2 changes: 0 additions & 2 deletions docs/docs/welcome.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,6 @@ If you are setting up Nebari and managing the platform for your organization or

🔸 After setup, [provide your team members access to your Nebari instance by configuring Keycloak][configure-keycloak].

🔸 Learn to [estimate the cost of your cloud resources](./tutorials/cost-estimate-report) to inform future configuratios and allocations.

🔸 If you face issues or challenges, check out the [Troubleshooting section](./troubleshooting) and [GitHub Discussions][github-discussions] to learn from the community. You can also look into [debugging your deployment](./how-tos/debug-nebari).

🔸 As a good security practice, [create and keep a manual backup](./how-tos/manual-backup) of your configurations and your team's work.
Expand Down
1 change: 0 additions & 1 deletion docs/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@ module.exports = {
"tutorials/creating-cds-dashboard",
"tutorials/creating-new-environments",
"tutorials/kbatch",
"tutorials/cost-estimate-report",
"tutorials/jupyter-scheduler",
"tutorials/argo-workflows-walkthrough",
],
Expand Down

0 comments on commit 6c544aa

Please sign in to comment.