start_here.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "id": "0c2da6f1",
   "metadata": {},
   "source": [
    "# Fablib FABRIC API Examples: Jupyter Notebooks\n",
    "\n",
    "Your FABRIC JupyterHub environment comes with a set of example notebooks. Below is a list of many of the examples. Click the links to open the example notebooks.\n",
    "\n",
    "### Update the Example Notebooks\n",
    "\n",
    "Occasionally, we will add example notebooks and update existing examples. The examples are stored in this [github repo](https://github.com/fabric-testbed/jupyter-examples)."
   ]
  },
  {
   "cell_type": "markdown",
   "id": "19651fde-76e0-4e82-ada1-29e3b8d0541a",
   "metadata": {
    "tags": []
   },
   "source": [
    "## Getting Started\n",
    "\n",
    "- Setup Environment\n",
    "    - [Configure Environment](./configure_and_validate/configure_and_validate.ipynb): Configure you Environment including creating the `fabric_rc` and `ssh_config` files.\n",
    "- First Experiment\n",
    "    - [Hello, FABRIC](./fabric_examples/fablib_api/hello_fabric/hello_fabric.ipynb): Simple First Slice Example.\n",
    "- Artifact Manager\n",
    "    - [Explore FABRIC Artifacts](./artifact_manager.ipynb): Download Reproducible Experiments with FABRIC Artifacts Manager.\n",
    "    - [Manage Artifacts via API](./fabric_examples/fablib_api/manage_artifacts/manage_artifacts.ipynb): Manage Artifacts using FablibManager.\n",
    "\n",
    "## Basic Examples\n",
    "\n",
    "- Available Sites and Resources\n",
    "    - [Listing Available Resources](./fabric_examples/fablib_api/sites_and_resources/list_all_resources.ipynb) List resrource capacity and availability. Ouput options: Text, Pandas, JSON, and Python List\\[Dict\\] \n",
    "    - [Finding Sites with Available Resources](./fabric_examples/fablib_api/sites_and_resources/filter_sites_by_available_resources.ipynb): Find sites containing available components and capacities\n",
    "\n",
    "- Managing Slices\n",
    "    - [Validate and Submit a Slice](./fabric_examples/fablib_api/create_slice/create_slice.ipynb): Options that can be used when creating, validating and submitting current or future slices.\n",
    "    - [Delete Slice(s)](./fabric_examples/fablib_api/delete_slice/delete_slice.ipynb): Options for deleting a slice or slices.\n",
    "    - [List All Slices](./fabric_examples/fablib_api/slices/list_slices.ipynb): Options for listing slices.\n",
    "    - [Show Slice Info](./fabric_examples/fablib_api/slices/show_slice.ipynb): Options for getting a slice.\n",
    "    - [Listing a Slice's Nodes, Networks, Components, and Interfaces](./fabric_examples/fablib_api/slices/list_node_and_networks.ipynb): Find and list parts of a slice.\n",
    "    - [Extending a Slice Reservation](./fabric_examples/fablib_api/renew_slice/renew_slice.ipynb): Extend a slice reservation for a longer period of time.\n",
    "    - [Save/Load Slices](./fabric_examples/fablib_api/save_and_load/save_and_load.ipynb): Save an experimental topology and load it at a later time.\n",
    "    - [Add/Remove SSH Keys](./fabric_examples/fablib_api/ssh_keys/ssh_keys.ipynb): Add/Remove SSH Keys to VMs in your slice.    \n",
    "    - [Share Slices](fabric_examples/fablib_api/slice_sharing/slice_sharing.ipynb): Collabortative Slice Access between project members.    \n",
    "    - [Modifying Slices](fabric_examples/fablib_api/modify_slice/modify-add-node-network.ipynb): Modify an existing slice by adding/removing resources.    \n",
    "\n",
    "- Compute Nodes\n",
    "    - [Customizing Nodes](./fabric_examples/fablib_api/customizing_nodes/customizing_nodes.ipynb): Set node properties (site, image, cores, ram, disk, etc.)\n",
    "    - [Execute Commands on Nodes](./fabric_examples/fablib_api/ssh_to_nodes/execute_commands.ipynb): Show how to remotely log into a running FABRIC node.\n",
    "    - [SSH Tunnels](./fabric_examples/fablib_api/ssh_tunnels/create_ssh_tunnels.ipynb): Create SSH tunnels from your local machine (i.e. your laptop) to FABRIC Nodes\n",
    "\n",
    "- Storage\n",
    "    - [Local Disk](./fabric_examples/fablib_api/local_disk/local_disk.ipynb): Create a node with a custom local disk size.\n",
    "    - [NVMe Devices](./fabric_examples/fablib_api/basic_nvme_devices/basic_nvme_devices.ipynb): Create a node with a NVMe device.\n",
    "    - [Persistent Storage](./fabric_examples/fablib_api/persistent_storage/persistent_storage.ipynb): Connect to your project's persisent storage volume.\n",
    "- GPUs\n",
    "    - [All FABRIC GPUs: Tesla T4, RTX6000, A30, A40](./fabric_examples/fablib_api/fabric_all_gpus/fabric_gpu.ipynb): Create a node with any GPU type.\n",
    "\n",
    "- Networking\n",
    "\n",
    "    - FABNet IPv4 (Layer 3): Connect to FABRIC's IPv4 internet ([manual](./fabric_examples/fablib_api/create_l3network_fabnet_ipv4/create_l3network_fabnet_ipv4_manual.ipynb), [auto](./fabric_examples/fablib_api/create_l3network_fabnet_ipv4/create_l3network_fabnet_ipv4_auto.ipynb), [full auto](./fabric_examples/fablib_api/create_l3network_fabnet_ipv4/create_l3network_fabnet_ipv4_full_auto.ipynb))\n",
    "    - FABNet IPv4 Ext (Layer 3): Connect to FABRIC's IPv4 internet with external access ([manual](./fabric_examples/fablib_api/create_l3network_fabnet_ipv4ext_manual/create_l3network_fabnet_ipv4ext_manual.ipynb))\n",
    "    - FABNet IPv6 (Layer 3): Connect to FABRIC's IPv6 internet ([manual](./fabric_examples/fablib_api/create_l3network_fabnet_ipv6/create_l3network_fabnet_ipv6_manual.ipynb), [auto](./fabric_examples/fablib_api/create_l3network_fabnet_ipv6/create_l3network_fabnet_ipv6_auto.ipynb), [full auto](./fabric_examples/fablib_api/create_l3network_fabnet_ipv6/create_l3network_fabnet_ipv6_full_auto.ipynb))\n",
    "    - FABNet IPv6 Ext (Layer 3): Connect to FABRIC's IPv6 internet with external access ([manual](./fabric_examples/fablib_api/create_l3network_fabnet_ipv6ext_manual/create_l3network_fabnet_ipv6ext_manual.ipynb))\n",
    "    - Local Ethernet (Layer 2): Create a private local Ethernet network on a FABRIC site ([manual](./fabric_examples/fablib_api/create_l2network_basic/create_l2network_basic_manual.ipynb), [auto](./fabric_examples/fablib_api/create_l2network_basic/create_l2network_basic_auto.ipynb), [user defined](./fabric_examples/fablib_api/create_l2network_basic/create_l2network_basic_config.ipynb))\n",
    "    - Wide Area Link (Layer 2): Create a private WAN Ethernet link between FABRIC sites ([manual](./fabric_examples/fablib_api/create_l2network_wide_area/create_l2network_wide_area_manual.ipynb), [auto](./fabric_examples/fablib_api/create_l2network_wide_area/create_l2network_wide_area_auto.ipynb), [user defined](./fabric_examples/fablib_api/create_l2network_wide_area/create_l2network_wide_area_config.ipynb), [explicit routes](./fabric_examples/fablib_api/create_l2network_wide_area/create_l2network_wide_area_ero_auto.ipynb))\n",
    "    - [Facility Ports](./fabric_examples/fablib_api/facility_port/facility_port.ipynb): Connect a FABRIC experiment to an external facility such as [Chameleon](https://www.chameleoncloud.org/). \n",
    "    - Port Mirroring: Listen in on traffic in FABRIC dataplane using PortMirror service ([Infrastructure](./fabric_examples/fablib_api/create_port_mirror/port_mirror.ipynb), [InSlice](./fabric_examples/fablib_api/create_port_mirror/port_mirror_basic.ipynb))\n",
    "    - [Sub Interfaces](./fabric_examples/fablib_api/sub_interfaces/sub_interfaces.ipynb): Create VLAN-tagged sub-interfaces for Smart NICs, enabling multiple Network Services connections.\n",
    "\n",
    "- FPGAs\n",
    "    - [Provision a single FPGA](./fabric_examples/fablib_api/fabric_fpgas/fpga_u280_simple.ipynb)\n",
    "    - [Create a P4 FPGA slice using ESnet workflow](./fabric_examples/fablib_api/fabric_fpgas/fpga_simple_p4.ipynb)\n",
    "\n",
    "## Experiment Configuration\n",
    "\n",
    "- Manual Tasks\n",
    "    - [Adding other users' keys into slice](./fabric_examples/fablib_api/other_ssh_keys/add_keys_into_slice.ipynb): Add new keys on submit or add later via POA (Perform Operational Action)\n",
    "    - [Upload and Execute Scripts](./fabric_examples/fablib_api/upload_and_execute/upload_and_execute.ipynb): Upload a script and execute it.\n",
    "    - [Accessing IPv4 Sites from IPv6 Nodes](./fabric_examples/fablib_api/accessing_ipv4_services_from_ipv6_nodes/accessing_ipv4_services_from_ipv6_nodes.ipynb): Access non-IPv6 services (i.e. GitHub) from IPv6 FABRIC nodes.   \n",
    "    - [Parallel Experiment Configuration](./fabric_examples/fablib_api/parallel_config/parallel_config.ipynb): Use threads to configure experiments in parallel.\n",
    "- Automated Tasks\n",
    "    - [Post Boot Tasks](./fabric_examples/fablib_api/post_boot_tasks/post_boot_tasks.ipynb): Define post boot tasks to upload files and execute commands.\n",
    "    - [Post Boot Tasks with Templates](./fabric_examples/fablib_api/post_boot_task_templates/post_boot_task_templates.ipynb): Define templated post boot tasks to upload files and execute commands.\n",
    "- Docker\n",
    "    - [Deploy Docker Containers](./fabric_examples/fablib_api/docker_containers/docker_containers.ipynb): Docker\n",
    "\n",
    "## Complex Recipes\n",
    "\n",
    "The following notebooks are examples of creating and configuring complex FABRIC topologies. They are intended to serve as examples of techniques that might help you build your own experiments. \n",
    "\n",
    "- Networking\n",
    "    - Routing and Switching\n",
    "        - [FRRouting OSPF](./fabric_examples/complex_recipes/FRRouting/frr_ospf_triangle.ipynb): Example of deploying OSPF across a wide-area using FRRouting (similar to Quagga)\n",
    "        - [OpenVSwitch](./fabric_examples/complex_recipes/openvswitch/openvswitch.ipynb): Example of deploying OpenVSwitch in a node.\n",
    "    - Connecting to External Facilities\n",
    "        - Chameleon Facility Ports: Create slices spanning Chameleon and FABRIC ([L2 connection](./fabric_examples/complex_recipes/Chameleon_Facility_Port/Chameleon_Facility_Port_L2.ipynb), [L3 FABnetv4](./fabric_examples/complex_recipes/Chameleon_Facility_Port/Chameleon_Facility_Port_fabnetv4.ipynb))\n",
    "    - Performance Measurements and Tuning\n",
    "        - [iPerf3](./fabric_examples/complex_recipes/iPerf3/iperf3.ipynb): Test bandwidth across your FABRIC slice.\n",
    "        - [CPU Pinning and Numa Tuning Basic NIC](./fabric_examples/complex_recipes/iPerf3/iperf3_optimized.ipynb): Apply CPU Pinning and Numa tuning with NIC_Basic and test bandwidth across your FABRIC slice.\n",
    "        - [CPU Pinning and Numa Tuning ConnectX_5/ConnectX_6](./fabric_examples/complex_recipes/iPerf3/iperf3_optimized_smart_nic.ipynb): Apply CPU Pinning and Numa tuning with NIC_ConnectX_5 and test bandwidth across your FABRIC slice.\n",
    "        - [One-Way Latency (OWL) Measurements](./fabric_examples/complex_recipes/owl/owl.ipynb)\n",
    "        - [Running One-Way Latency Measurements with InfluxDB]()\n",
    "    - Programmable Networking\n",
    "        - [DPDK and Pktgen with Smart NICs](./fabric_examples/complex_recipes/networking/programmable_networking/dpdk_smart_nic/dpdk_packet_gen_smart_nic.ipynb): Program your smart nics with DPDK.\n",
    "    - [Peering Client](./fabric_examples/complex_recipes/networking/peering_client/peering-client-setup.ipynb): setting up a PEERING client on FABRIC\n",
    "- Component Benchmarking\n",
    "    - Storage\n",
    "        - [Benchmarking FABRIC Storage: Local disk and NVMe](./fabric_examples/fablib_api/benchmarking_storage/benchmarking_storage.ipynb): Create and benchmark a node with local disk and NVMe device.\n",
    "- Experiment Measurements\n",
    "    - Measuring and Visualizing with Grafana and Prometheus\n",
    "        - [Grafana/Prometheus Server](./fabric_examples/complex_recipes/grafana_prometheus_servers/grafana-prometheus-servers.ipynb): Deploy a Grafana/Prometheus services on a FABIRC node using Docker.\n",
    "        - [Prometheus Node Exporter](./fabric_examples/complex_recipes/grafana_prometheus_servers/node_exporter.ipynb): Create a slice that can be monitored by a Grafana/Prometheus server. \n",
    "    - Using FABRIC Measurement Framework (MFLib)\n",
    "        - [Monitoring with MFLib Examples](./fabric_examples/mflib/mflib_example_index.ipynb): Examples for setting up automated monitoring in your slice. \n",
    "- Dynamic Infrastructure\n",
    "    - [Kubernetes Cluster](./fabric_examples/complex_recipes/kubernetes/kubernetes_simple.ipynb): Create a private Kubernetes cluster on FABRIC resources.\n",
    "- Accessing and Managing Slices\n",
    "    -  [Tailscale Mesh VPN](./fabric_examples/complex_recipes/tailscale/tailscale_mesh_vpn.ipynb): Create a private mesh VPN with [Tailscale](http://tailscale.com) to accesss and manage your slice.\n",
    "    \n",
    "## Complete Tutorial Sets\n",
    "\n",
    "- Programmable Networking\n",
    "    - [P4 Labs (BMv2)](./fabric_examples/complex_recipes/p4_labs_bmv2/main.ipynb): Lab series on P4 programmable switches using the Behavioral Model (BMv2).\n",
    "\n",
    "## Live Demos and Tutorials\n",
    "\n",
    "- [Demos and Tutorials](./fabric_examples/public_demos/demos_and_tutorials.ipynb): Files for live demos and tutorials. "
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "76146b01",
   "metadata": {},
   "outputs": [],
   "source": []
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Bash",
   "language": "bash",
   "name": "bash"
  },
  "language_info": {
   "codemirror_mode": "shell",
   "file_extension": ".sh",
   "mimetype": "text/x-sh",
   "name": "bash"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 5
}