Move files up a level, tidy up some challenge instructions

opensourcecorp · Oct 20, 2024 · 8e07711 · 8e07711
1 parent 3bc2fbe
commit 8e07711
Show file tree

Hide file tree

Showing 49 changed files with 44 additions and 48 deletions.
diff --git a/linux/Makefile → Makefile b/linux/Makefile → Makefile
diff --git a/README.md b/README.md
@@ -1,4 +1,42 @@
-Workshops, Hackathons, etc
-==========================
+Linux System Breakfixing
+========================
 
-This repository houses workshop, etc. content put on by OpenSourceCorp.
+In this workshop, teams will work to fix the broken deployment of an application
+running on a Linux server.
+
+System Requirements
+-------------------
+
+Note that this workshop content was authored on a Debian Linux machine, and so
+the various scripts & utilities are written in support of that. There may be a
+few instances of code that is non-portable to BSDs like macOS, but should work
+fine on WSL.
+
+---
+
+As a ***workshop administrator***, you will need the following:
+
+- A terminal emulator capable of running the `bash` shell program
+
+- [HashiCorp Terraform](https://terraform.io) (if running workshop on a cloud
+  platform)
+
+- x
+
+In addition, for local testing you will need [HashiCorp
+Vagrant](https://www.vagrantup.com/), and at least one installation of a
+supported Vagrant provider. At the time of this writing, those supported
+providers were VirtualBox and `libvirt`. If on WSLv2 on Windows, you will have a
+MUCH easier time using the `libvirt` provider.
+
+---
+
+***Workshop participants*** will need the following:
+
+- An SSH client
+  - On Windows, this is typically `puTTY` as a standalone tool, or Git Bash or
+    WSL. macOS should already have the `ssh` client program installed.
+  - Note: participants will ***not*** need knowledge of SSH key management, etc.
+    -- auth to the team servers will be password-based.
+
+- Little enough knowledge of Linux OSes to not figure out how to cheat `:)`
diff --git a/linux/Vagrantfile → Vagrantfile b/linux/Vagrantfile → Vagrantfile
diff --git a/linux/docs/Linux-Workshop.odp → docs/Linux-Workshop.odp b/linux/docs/Linux-Workshop.odp → docs/Linux-Workshop.odp
diff --git a/linux/dummy-app-src/.gitignore → dummy-app-src/.gitignore b/linux/dummy-app-src/.gitignore → dummy-app-src/.gitignore
diff --git a/...mmy-app-src/dist/linux/app/DEBIAN/control → dummy-app-src/dist/linux/app/DEBIAN/control b/...mmy-app-src/dist/linux/app/DEBIAN/control → dummy-app-src/dist/linux/app/DEBIAN/control
diff --git a/...dummy-app-src/dist/linux/app/usr/bin/.env → dummy-app-src/dist/linux/app/usr/bin/.env b/...dummy-app-src/dist/linux/app/usr/bin/.env → dummy-app-src/dist/linux/app/usr/bin/.env
diff --git a/linux/dummy-app-src/go.mod → dummy-app-src/go.mod b/linux/dummy-app-src/go.mod → dummy-app-src/go.mod
diff --git a/linux/dummy-app-src/main.go → dummy-app-src/main.go b/linux/dummy-app-src/main.go → dummy-app-src/main.go
diff --git a/linux/dummy-web-app/README.md → dummy-web-app/README.md b/linux/dummy-web-app/README.md → dummy-web-app/README.md
diff --git a/linux/dummy-web-app/go.mod → dummy-web-app/go.mod b/linux/dummy-web-app/go.mod → dummy-web-app/go.mod
diff --git a/linux/dummy-web-app/go.sum → dummy-web-app/go.sum b/linux/dummy-web-app/go.sum → dummy-web-app/go.sum
diff --git a/linux/dummy-web-app/main.go → dummy-web-app/main.go b/linux/dummy-web-app/main.go → dummy-web-app/main.go
diff --git a/linux/instructions/challenge_0.md → instructions/challenge_0.md b/linux/instructions/challenge_0.md → instructions/challenge_0.md
diff --git a/linux/instructions/challenge_1.md → instructions/challenge_1.md b/linux/instructions/challenge_1.md → instructions/challenge_1.md
@@ -12,4 +12,4 @@ a Go binary.
 Take note of any error messages when trying to build it, and fix any issues you
 find.
 
-NOTE APP NEEDS TO BE CALLED `app`, NOT `main`
+(NOTE: the built application needs to be named `app`, NOT `main`)
diff --git a/linux/instructions/challenge_2.md → instructions/challenge_2.md b/linux/instructions/challenge_2.md → instructions/challenge_2.md
diff --git a/linux/instructions/challenge_3.md → instructions/challenge_3.md b/linux/instructions/challenge_3.md → instructions/challenge_3.md
diff --git a/linux/instructions/challenge_4.md → instructions/challenge_4.md b/linux/instructions/challenge_4.md → instructions/challenge_4.md
diff --git a/linux/instructions/challenge_5.md → instructions/challenge_5.md b/linux/instructions/challenge_5.md → instructions/challenge_5.md
@@ -20,9 +20,9 @@ number is:
 
 1. Higher than `6000`
 
-1. *Not* `8080`
+2. *Not* `8080`
 
-1. *Not* managed by the `iptables` tool.
+3. *Not* managed by the `iptables` tool.
 
 Finally, you will want to figure out what firewall issue your own server has
 that seems to be causing problems, and fix it.
diff --git a/linux/instructions/challenge_6.md → instructions/challenge_6.md b/linux/instructions/challenge_6.md → instructions/challenge_6.md
diff --git a/linux/instructions/challenge_7.md → instructions/challenge_7.md b/linux/instructions/challenge_7.md → instructions/challenge_7.md
diff --git a/linux/instructions/congrats.md → instructions/congrats.md b/linux/instructions/congrats.md → instructions/congrats.md
diff --git a/linux/README.md b/linux/README.md
diff --git a/linux/score-server/README.md → score-server/README.md b/linux/score-server/README.md → score-server/README.md
diff --git a/linux/score-server/content/content.go → score-server/content/content.go b/linux/score-server/content/content.go → score-server/content/content.go
diff --git a/linux/score-server/content/www/index.html → score-server/content/www/index.html b/linux/score-server/content/www/index.html → score-server/content/www/index.html
diff --git a/linux/score-server/go.mod → score-server/go.mod b/linux/score-server/go.mod → score-server/go.mod
diff --git a/linux/score-server/go.sum → score-server/go.sum b/linux/score-server/go.sum → score-server/go.sum
diff --git a/linux/score-server/main.go → score-server/main.go b/linux/score-server/main.go → score-server/main.go
diff --git a/linux/score-server/pkg/fetch-server/serve.go → score-server/pkg/fetch-server/serve.go b/linux/score-server/pkg/fetch-server/serve.go → score-server/pkg/fetch-server/serve.go
diff --git a/...ore-server/pkg/fetch-server/serve_test.go → score-server/pkg/fetch-server/serve_test.go b/...ore-server/pkg/fetch-server/serve_test.go → score-server/pkg/fetch-server/serve_test.go
diff --git a/linux/scripts/ci.sh → scripts/ci.sh b/linux/scripts/ci.sh → scripts/ci.sh
diff --git a/linux/scripts/init-db.sh → scripts/init-db.sh b/linux/scripts/init-db.sh → scripts/init-db.sh
diff --git a/linux/scripts/init.sh → scripts/init.sh b/linux/scripts/init.sh → scripts/init.sh
diff --git a/linux/scripts/linux-workshop-admin.sh → scripts/linux-workshop-admin.sh b/linux/scripts/linux-workshop-admin.sh → scripts/linux-workshop-admin.sh
diff --git a/...cripts/provision-ec2-team-parallelizer.sh → scripts/provision-ec2-team-parallelizer.sh b/...cripts/provision-ec2-team-parallelizer.sh → scripts/provision-ec2-team-parallelizer.sh
diff --git a/linux/scripts/provision-ec2.sh → scripts/provision-ec2.sh b/linux/scripts/provision-ec2.sh → scripts/provision-ec2.sh
diff --git a/linux/scripts/setup-git.sh → scripts/setup-git.sh b/linux/scripts/setup-git.sh → scripts/setup-git.sh
diff --git a/linux/scripts/test.bats → scripts/test.bats b/linux/scripts/test.bats → scripts/test.bats
diff --git a/linux/services/dummy-web-app.service → services/dummy-web-app.service b/linux/services/dummy-web-app.service → services/dummy-web-app.service
diff --git a/linux/services/linux-workshop-admin.service → services/linux-workshop-admin.service b/linux/services/linux-workshop-admin.service → services/linux-workshop-admin.service
diff --git a/linux/services/linux-workshop-admin.timer → services/linux-workshop-admin.timer b/linux/services/linux-workshop-admin.timer → services/linux-workshop-admin.timer
diff --git a/linux/services/score-server.service → services/score-server.service b/linux/services/score-server.service → services/score-server.service
diff --git a/linux/terraform/.gitignore → terraform/.gitignore b/linux/terraform/.gitignore → terraform/.gitignore
diff --git a/linux/terraform/.terraform.lock.hcl → terraform/.terraform.lock.hcl b/linux/terraform/.terraform.lock.hcl → terraform/.terraform.lock.hcl
diff --git a/linux/terraform/data.tf → terraform/data.tf b/linux/terraform/data.tf → terraform/data.tf
diff --git a/linux/terraform/main.tf → terraform/main.tf b/linux/terraform/main.tf → terraform/main.tf
diff --git a/linux/terraform/outputs.tf → terraform/outputs.tf b/linux/terraform/outputs.tf → terraform/outputs.tf
diff --git a/linux/terraform/variables.tf → terraform/variables.tf b/linux/terraform/variables.tf → terraform/variables.tf