Requirements setup (#2)

Requirements setup

Author: fntlnz

README.md

@@ -1,10 +1,14 @@
 # BPF Workshop
 
+Let's share some eBPF love!
+
 ## Authors
 
 - [David Calavera](https://github.com/calavera)
 - [Lorenzo Fontana](https://github.com/fntlnz)
 
+*Add your name here if you contributed to this workshop*
+
 ## Build and run
 
 You need [hugo](https://gohugo.io/) in your path, then

config.yaml

@@ -1,4 +1,4 @@
-baseURL: "http://example.org/"
+baseURL: "https://workshop.bpf.sh/"
 languageCode: "en-us"
 title: "BPF Workshop"
 theme: "workshop"
@@ -8,23 +8,34 @@ menu:
  main:
    - identifier: introduction
      weight: 100
+     title: "Introduction"
    - identifier: program-types
      weight: 200
+     title: "eBPF Program types"
    - identifier: bpf-vm 
      weight: 300
+     title: "The BPF in Kernel Virtual Machine"
    - identifier: bcc 
      weight: 400
+     title: "BCC"
    - identifier: bpftrace
      weight: 500
+     title: "bpftrace"
    - identifier: gobpf 
      weight: 600
+     title: "gobpf"
    - identifier: kubernetes
      weight: 700
+     title: "eBPF and Kubernetes"
    - identifier: clang
      weight: 800
+     title: "Clang BPF backend"
    - identifier: tools
      weight: 900
+     title: "Any other tools?"
    - identifier: networking
      weight: 1000
+     title: "eBPF and Linux Networking"
    - identifier: security
      weight: 1100
+     title: "Linux Kernel security and eBPF"

content/31-environment-setup.md

@@ -0,0 +1,19 @@
+---
+title:  "requirements"
+weight: 30
+class: extra-details
+---
+
+# Pre-requirements
+
+- A machine with Linux Kernel 4.18+ (or the provided Vagrant machine)
+
+- Be comfortable with the UNIX command line
+
+  - navigating directories
+
+  - editing files
+
+  - a little bit of bash-fu (environment variables, loops)
+
+

content/32-environment-setup-tmux.md

@@ -0,0 +1,20 @@
+---
+title:  "environment-setup-tmux"
+weight: 32
+---
+
+# Terminals
+
+Once in a while, the instructions will say:
+<br/>"Open a new terminal."
+
+There are multiple ways to do this:
+
+- create a new window or tab on your machine, and SSH into the VM;
+
+- use screen or tmux on the VM and open a new window from there;
+
+- Or if you are executing in a local Linux machine just open a new terminal in there;
+
+You are welcome to use the method that you feel the most comfortable with.
+

content/33-environment-tmux-cheat.md

@@ -0,0 +1,26 @@
+---
+title:  "environment-tmux-cheat"
+weight: 33
+---
+
+# Tmux cheatsheet
+
+[Tmux](https://en.wikipedia.org/wiki/Tmux) is a terminal multiplexer like `screen`.
+
+*You don't have to use it or even know about it to follow along.
+<br/>
+But some of us like to use it to switch between terminals.
+<br/>
+It comes preinstalled in the Vagrant machine we provided*
+
+- Ctrl-b c → creates a new window
+- Ctrl-b n → go to next window
+- Ctrl-b p → go to previous window
+- Ctrl-b " → split window top/bottom
+- Ctrl-b % → split window left/right
+- Ctrl-b Alt-1 → rearrange windows in columns
+- Ctrl-b Alt-2 → rearrange windows in rows
+- Ctrl-b arrows → navigate to other windows
+- Ctrl-b d → detach session
+- tmux attach → reattach to session
+

content/33-toc.md

@@ -0,0 +1,29 @@
+---
+title:  "environment-vagrant"
+weight: 34
+---
+
+# Vagrant
+
+- If you don't know what Vagrant is, **don't worry**.
+- It's just a tool to create Virtual machines that we use to create a common VM with all the eBPF tools for everyone!
+- This workshop comes with a reference environment expressed in a `Vagrantfile`.
+- You don't have to use this one, but be prepared to install stuff!
+OS X
+
+```
+brew cask install virtualbox
+brew cask install vagrant
+```
+
+Windows
+
+Download [Vagrant](https://www.vagrantup.com/downloads.html) and [Virtualbox](https://www.virtualbox.org/)
+
+
+Ubuntu
+
+```
+apt install vagrant virtualbox
+```
+

content/34-environment-vagrant.md

@@ -0,0 +1,29 @@
+---
+title:  "environment-vagrant-cheatsheet"
+weight: 35
+---
+
+# Vagrant
+
+After cloning the workshop repository, enter the environment folder:
+
+```
+git clone https://github.com/bpftools/bpf-workshop.git
+cd bpf-workshop/environment
+```
+
+Then there are three major things you can do:
+
+```bash
+# Start the environment
+vagrant up
+
+# Stop the environment
+vagrant halt
+
+# Destroy the environment
+vagrant destroy
+
+# Obtain a shell
+vagrant ssh
+```

content/35-environment-vagrant-cheatsheet.md

@@ -0,0 +1,17 @@
+---
+title:  "environment-others"
+weight: 35
+---
+
+# Non-Vagrant (aka. All the other environments)
+
+Make sure to have:
+
+- git
+- an editor of your choice
+- gcc
+- clang
+- go
+
+The other tools we need, `bpftrace` and `bcc` will have their own setup
+instructions in the respective chapters.

content/36-environment-others.md

@@ -1,6 +1,6 @@
 ---
 title:  "intro-exercises"
-weight: 32
+weight: 42
 ---
 
 ## Hands-on sections

content/32-intro-exercieses.md content/42-intro-exercieses.md

@@ -0,0 +1,8 @@
+---
+title:  "toc"
+weight: 43
+---
+
+# Table of content
+
+{{< toc >}}

content/43-toc.md

@@ -0,0 +1,15 @@
+---
+title:  "credits"
+weight: 999
+class: extra-details
+---
+
+## Credits
+
+- Thanks to all the eBPF authors and tools makers for their awesome work on it;
+- Many thanks to [Jérôme Petazzoni](https://github.com/jpetazzo), we adapted Jérôme's template
+from [container.training](https://container.training) to Hugo, we also used the terminals setup instructions and the tmux cheatsheet from that deck!
+- Thanks to the [remark](https://github.com/gnab/remark) authors for their work on it, it's the tool
+we use to generate the slides;
+- Thanks to the [hugo](https://gohugo.io/) authors, for the awesome static site generator;
+

content/999999-thanks.md

@@ -2,7 +2,7 @@
 title:  "bcc"
 weight: 400
 class: title
-navTitle: "BCC"
+
 ---
 {{< nav >}}
 

content/bcc/intro.md

@@ -2,7 +2,7 @@
 title:  "bpf-vm"
 weight: 300
 class: title
-navTitle: "The BPF in Kernel Virtual Machine"
+
 ---
 {{< nav >}}
 

content/bpf-vm/index.md

@@ -0,0 +1,26 @@
+---
+title:  "bpftrace-install"
+weight: 502
+---
+
+# bpftrace: Installation
+
+We will need to do some exercises with bpftrace.
+If you are not using the Vagrant environment, you might want to install it now!
+
+Ubuntu snap package
+
+```
+sudo snap install --devmode bpftrace
+sudo snap connect bpftrace:system-trace
+```
+
+Fedora (28 or later)
+
+```
+sudo dnf install bpftrace
+```
+
+You can find further instructions [here](https://github.com/iovisor/bpftrace/blob/master/INSTALL.md)
+
+

content/bpftrace/502-bpftrace-install.md

@@ -1,7 +1,7 @@
 
 ---
 title:  "bpftrace-oneliners-uretprobe-contd"
-weight: 528
+weight: 529
 class: extra-details
 ---
 
@@ -21,6 +21,7 @@ bpftrace -e \
   'uretprobe:./randomnumbers:"main.giveMeNumber"
   { printf("%d\n", retval) }'
 ```
-Bonus point, try to do an `objdump -t randomnumbers | grep -i giveMe`, what do you notice?
 ]
 
+.footnote[.smaller[Bonus point! Try to do an `objdump -t randomnumbers | grep -i giveMe`, what do you notice?]]
+

content/bpftrace/529-bpftrace-oneliner-uretprobe-contd.md

@@ -1,7 +1,6 @@
-
 ---
-title:  "bpftrace-credits"
-weight: 599
+title:  "bpftrace-takeaways"
+weight: 598
 ---
 
 # Takeaways

content/bpftrace/598-takeaways.md content/bpftrace/598-bpftrace-takeaways.md

@@ -1,4 +1,3 @@
-
 ---
 title:  "bpftrace-credits"
 weight: 599

content/bpftrace/599-bpftrace-credits.md

@@ -2,7 +2,7 @@
 title: "bpftrace"
 weight: 500
 class: title
-navTitle: "bpftrace"
+
 ---
 {{< nav >}}
 

content/bpftrace/index.md content/bpftrace/intro.md

@@ -2,7 +2,7 @@
 title:  "clang"
 weight: 800
 class: title
-navTitle: "Clang BPF backend"
+
 ---
 {{< nav >}}
 

content/clang/intro.md

@@ -2,7 +2,7 @@
 title:  "gobpf"
 weight: 600
 class: title
-navTitle: "gobpf"
+
 ---
 {{< nav >}}
 

content/gobpf/intro.md

@@ -1,5 +1,5 @@
 ---
-title:  "introduction"
+title:  "introduction-content"
 weight: 101
 ---
 # Introduction

content/introduction/101-introduction.md

@@ -2,7 +2,6 @@
 title:  "introduction"
 weight: 100
 class: title
-navTitle: "Introduction"
 ---
 {{< nav >}}
 

content/introduction/intro.md

@@ -2,7 +2,7 @@
 title:  "kubernetes"
 weight: 700
 class: title
-navTitle: "eBPF and Kubernetes"
+
 ---
 {{< nav >}}
 

content/kubernetes/intro.md

@@ -2,7 +2,7 @@
 title:  "networking"
 weight: 1000
 class: title
-navTitle: "eBPF and Linux Networking"
+
 ---
 {{< nav >}}
 

content/networking/intro.md

@@ -2,7 +2,6 @@
 title:  "program-types"
 weight: 200
 class: title
-navTitle: "eBPF Program types"
 ---
 {{< nav >}}
 

content/program-types/intro.md

@@ -2,7 +2,6 @@
 title:  "security"
 weight: 1100
 class: title
-navTitle: "Linux Kernel security and eBPF"
 ---
 {{< nav >}}