Add waypoint for dev environment creation

.github/workflows/cdkactions_docker-waypoint.yaml

@@ -0,0 +1,40 @@
+name: Publish waypoint
+on:
+  push:
+    paths:
+      - docker/waypoint/**
+
+jobs:
+  publish-waypoint:
+    name: Publish waypoint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: docker/setup-qemu-action@v3
+        with:
+          platforms: linux/amd64,linux/arm64
+          image: tonistiigi/binfmt:latest
+      - uses: docker/setup-buildx-action@v3
+        with:
+          platforms: linux/amd64,linux/arm64
+      - name: Cache Docker layers
+        uses: actions/cache@v2
+        with:
+          path: /tmp/.buildx-cache
+          key: buildx-publish-waypoint
+      - uses: docker/login-action@v1
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+      - name: Build/Publish
+        uses: docker/build-push-action@v6
+        with:
+          context: docker/waypoint
+          file: docker/waypoint/Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: true
+          cache-from: type=local,src=/tmp/.buildx-cache,type=registry,ref=pennlabs/waypoint:latest
+          cache-to: type=local,dest=/tmp/.buildx-cache
+          tags: |
+            pennlabs/waypoint:latest
+            pennlabs/waypoint:${{ github.sha }}

.github/workflows/release-waypoint.yaml

@@ -0,0 +1,54 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        include:
+          - os: ubuntu-latest
+            arch: x86_64
+            binary_suffix: "-linux-x86_64"
+          - os: macos-latest
+            arch: x86_64
+            binary_suffix: "-macos-x86_64"
+          - os: macos-latest
+            arch: arm64
+            binary_suffix: "-macos-arm64"
+
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: |
+          pip install pyinstaller
+          cd docker/waypoint && pip install .
+
+      - name: Build binary
+        working-directory: docker/waypoint
+        run: pyinstaller src/waypoint_client.py --onefile --name "waypoint-client${{ matrix.binary_suffix }}"
+
+      - name: Calculate SHA256
+        run: |
+          cd docker/waypoint/dist
+          echo "BINARY_SHA=$(sha256sum waypoint-client${{ matrix.binary_suffix }} | awk '{print $1}')" >> $GITHUB_ENV
+
+      - name: Create Release
+        uses: softprops/action-gh-release@v1
+        with:
+          files: docker/waypoint/dist/waypoint-client*
+          name: Release ${{ github.ref_name }}
+          body: |
+            SHA256 (${{ matrix.os }}-${{ matrix.arch }}): ${{ env.BINARY_SHA }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -6,3 +6,7 @@ creds.txt
 terraform.*
 tf_creds.json
 .DS_Store
+*.log
+
+__pycache__
+waypoint.egg-info

docker/waypoint/Dockerfile

@@ -0,0 +1,67 @@
+FROM ubuntu:20.04
+
+LABEL maintainer="Penn Labs"
+
+
+# --- systems setup
+RUN apt-get update && apt-get install --no-install-recommends -y gcc libpq-dev libc-dev
+
+RUN apt-get update && apt-get install --no-install-recommends -y curl git \
+  sudo python3-dev python3-pip python3-venv libpq-dev postgresql-client nano \
+  htop vim net-tools procps sysstat strace tcpdump lsof \
+  && rm -rf /var/lib/apt/lists/*
+
+# Install locales and configure the correct locale
+# RUN apt-get update && apt-get install -y locales
+# RUN locale-gen en_US.UTF-8
+# RUN update-locale LANG=en_US.UTF-8 LC_ALL=en_US.UTF-8
+
+RUN pip3 install uv pipenv
+
+# --- labs setup
+# TODO: install and set up postgres db w systemd
+RUN apt-get update && DEBIAN_FRONTEND=noninteractive apt-get install --no-install-recommends -y tzdata \
+    && ln -fs /usr/share/zoneinfo/America/New_York /etc/localtime \
+    && dpkg-reconfigure -f noninteractive tzdata
+
+RUN apt-get update && apt-get install -y postgresql postgresql-contrib redis-server systemd
+
+# Install nvm, node, and npm, yarn
+ENV NVM_DIR=/usr/local/nvm
+ENV NODE_VERSION=20
+
+RUN mkdir -p $NVM_DIR && \
+    curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash && \
+    . $NVM_DIR/nvm.sh && \
+    nvm install $NODE_VERSION && \
+    nvm alias default $NODE_VERSION && \
+    nvm use default
+
+RUN . $NVM_DIR/nvm.sh && npm install -g yarn
+
+RUN mkdir /opt/waypoint/
+RUN mkdir /labs/
+
+# For each product, setup the python environment
+COPY waypoint-init /opt/waypoint/waypoint-init
+RUN chmod +x /opt/waypoint/waypoint-init
+RUN /opt/waypoint/waypoint-init
+
+# start redis and postgres service
+COPY database-init /opt/waypoint/database-init
+RUN chmod +x /opt/waypoint/database-init
+
+RUN mkdir -p /opt/waypoint/cli
+COPY . /opt/waypoint/cli
+WORKDIR /opt/waypoint/cli
+RUN pip3 install .
+
+WORKDIR /
+
+# Copy .bashrc
+COPY waypoint-bashrc /root/.bashrc
+
+# expose ports
+EXPOSE 5432
+EXPOSE 3000
+EXPOSE 8000

docker/waypoint/README.md

@@ -0,0 +1,116 @@
+# Waypoint
+
+A development environment manager for Penn Labs products.
+
+## Installation
+
+### Set-up
+
+To get started, install `waypoint-client` on your local machine by running:
+
+```bash
+curl -sSL https://raw.githubusercontent.com/pennlabs/infrastructure/refs/heads/add-waypoint/docker/waypoint/install.sh | sudo bash
+```
+
+Next, configure `waypoint-client`:
+
+```bash
+waypoint-client configure
+```
+
+This setup ensures your code, secrets, and config files persist even if the container is rebuilt or stopped.
+
+To start developing, run:
+
+```bash
+waypoint-client start
+```
+
+### Developing on a Waypoint Container
+
+On the first boot, the waypoint will build the image.
+
+1. [Install the VSCode Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension.
+2. Select `Dev containers: attach to a running container`. (<kbd>Command</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> on Mac)
+
+Then, execute the following commands:
+
+- Start background services (e.g., databases):
+
+  ```bash
+  waypoint services
+  ```
+
+- Initialize environments:
+
+  ```bash
+  waypoint init
+  ```
+
+  or
+
+  ```bash
+  waypoint init [product]
+  ```
+
+- Switch between products:
+
+  ```bash
+  waypoint switch [product]
+  ```
+
+Now, you are ready to start coding. Treat the waypoint as a VM; you can make changes, set up git, etc. However, remember that updates to the waypoint will erase any changes not made in `/labs`, which is mounted to your local machine based on your initial configuration.
+
+Mounts:
+
+- **Code mount**: Your code is mounted so you can access it locally.
+- **Secret mount**: A directory is used as a secret mount, and all files are loaded in with `source` as secrets.
+
+## Waypoint Commands
+
+### `waypoint-client` CLI
+
+The waypoint-client CLI is for your local machine.
+
+- `waypoint-client configure` to set up your waypoint-client and set the location for your secrets and code to be stored on your local machine. These will be mounted into the waypoint dev machine.
+- `waypoint-client start` to start the docker image and begin coding. After running, use VSCode dev containers to connect to the waypoint.
+
+### `waypoint` CLI
+
+The waypoint CLI is for your waypoint dev machine.
+
+- `waypoint services (start/stop/status)` to start, stop, or check the status of background services, such as PostgreSQL and Redis.
+  - Defaults to `start`
+- `waypoint init (product)` to set up initial environments. This will clone corresponding repositories to `/labs/[product]`, migrate and populate the backend, and install frontend packages with `yarn`.
+  - You may omit the product name to initialize all products (recommended)
+- `waypoint switch [product]` to switch environments. This will attempt to switch to a new VSCode window if you are using waypoint in a dev container
+
+The following commands are done only in a product environment. (You must switch to some product for these to work)
+
+- `waypoint sync [product]` refreshes backend dependencies for a particular product to be up to date to what the container currently specifies.
+- `waypoint backend` to start the backend for your current product
+- `waypoint frontend` to start the frontend for your current product
+
+- Initialize a product environment:
+
+```bash
+waypoint init (product)
+```
+
+- Switch between products:
+
+```bash
+waypoint switch [product]
+```
+
+- Start development server:
+
+```bash
+waypoint start
+```
+
+- Start background services:
+
+```bash
+waypoint services
+```

docker/waypoint/database-init

@@ -0,0 +1,32 @@
+#!/bin/bash
+set -e
+
+# Start PostgreSQL service
+sudo service postgresql start
+
+# Start Redis server in the background
+redis-server --daemonize yes
+
+# PostgreSQL user and database details
+PG_USER="postgres"
+PG_PASSWORD="postgres"
+PG_DATABASE="postgres"
+
+# Alter the PostgreSQL user password
+sudo -u postgres psql -v ON_ERROR_STOP=1 --username "$PG_USER" --dbname "$PG_DATABASE" <<-EOSQL
+    ALTER USER $PG_USER WITH PASSWORD '$PG_PASSWORD';
+EOSQL
+
+# Create a new PostgreSQL user "penn-courses" with the same password if it doesn't already exist
+sudo -u postgres psql -v ON_ERROR_STOP=1 --username "$PG_USER" --dbname "$PG_DATABASE" <<-EOSQL
+    DO \$\$
+    BEGIN
+        IF NOT EXISTS (SELECT FROM pg_catalog.pg_roles WHERE rolname = 'penn-courses') THEN
+            CREATE USER "penn-courses" WITH PASSWORD '$PG_PASSWORD';
+            ALTER USER "penn-courses" WITH SUPERUSER;
+        END IF;
+    END
+    \$\$;
+EOSQL
+
+echo "PostgreSQL user password updated successfully."

docker/waypoint/install.sh

@@ -0,0 +1,60 @@
+#!/bin/bash
+
+INSTALL_DIR="/usr/local/bin"
+WAYPOINT_VERSION="v0.0.2.20"
+GITHUB_ORG="pennlabs"
+REPO_NAME="infrastructure"
+
+OS=$(uname -s | tr '[:upper:]' '[:lower:]')
+ARCH=$(uname -m)
+BINARY_SUFFIX=""
+CWD=$(pwd)
+
+case "$OS" in
+    linux*)
+        case "$ARCH" in
+            x86_64|amd64)
+                BINARY_SUFFIX="-linux-x86_64"
+                ;;
+            *)
+                echo "Unsupported Linux architecture: $ARCH"
+                exit 1
+                ;;
+        esac
+        ;;
+    darwin*)
+        case "$ARCH" in
+            arm64|aarch64)
+                BINARY_SUFFIX="-macos-arm64"
+                ;;
+            x86_64|amd64)
+                BINARY_SUFFIX="-macos-x86_64"
+                ;;
+            *)
+                echo "Unsupported macOS architecture: $ARCH"
+                exit 1
+                ;;
+        esac
+        ;;
+    *)
+        echo "Unsupported operating system: $OS"
+        exit 1
+        ;;
+esac
+
+TMP_DIR=$(mktemp -d)
+cd $TMP_DIR
+
+echo "Downloading Waypoint for $OS $ARCH..."
+curl -L "https://github.com/${GITHUB_ORG}/${REPO_NAME}/releases/download/${WAYPOINT_VERSION}/waypoint-client${BINARY_SUFFIX}" -o waypoint-client
+
+chmod +x waypoint-client
+sudo mv waypoint-client $INSTALL_DIR/
+
+echo "Waypoint client installed successfully!"
+echo "Run 'waypoint-client configure' to get started."
+echo "Run 'waypoint-client --help' to see available commands."
+
+rm -rf $TMP_DIR
+
+cd $CWD