Compute Cluster Username{}
@@ -255,13 +147,30 @@ export function SSHCommandGenerator() {
autoComplete='off'
/>
- Generated SSH Command
-
-
- {sshCommand}
-
-
+
+
Results
+
+ Below are options for connecting to {machineName}.
+ Please choose the option that best fits your use case.
+
+
+ {
+ sshInfo[machineName].paths.map(({hops, instructions}) => (
+
")} className="mt-8">
+
{hops.length === 1 ? "Direct Connection" : hops.join(" -> ")}
+
+ {instructions.map((instruction, i) => (
+ -
+ {STRING_TO_MDX[instruction]}
+
+ ))}
+
+
+ ))
+ }
+
-The above is your personalized SSH command. Copy and paste it into your terminal to connect to the cluster.
+
-The generated command does *not* require setting up ssh agent[^ssh-agent] or ssh config[^ssh-config].
+The generated commands do *not* require setting up ssh agent[^ssh-agent] or ssh config[^ssh-config].
However, you may soon find that setting them up will make your life easier. If you are interested in learning more about these
tools, please check out [Tips and Tricks](#tips-and-tricks) and the official documentation linked in the footnotes.
@@ -143,6 +146,4 @@ ssh -v trpro-ubuntu2
{
// Separate footnotes from the main content
}
-import { Separator } from "@/components/ui/separator"
-
diff --git a/pages/machines.mdx b/pages/machines.mdx
index 04e984a..e21c5e1 100644
--- a/pages/machines.mdx
+++ b/pages/machines.mdx
@@ -23,7 +23,7 @@ The following machines are used to run SLURM jobs. To use them, please follow th
### General-Use Machines
-The following machines are available for general use. To access them, please follow the instructions in the [Getting Access](/docs/compute-cluster/getting-access) guide.
+The following machines are available for general use. To access them, please follow the instructions in the [SSH](/docs/compute-cluster/ssh) guide.
{
diff --git a/requirements.txt b/requirements.txt
index 76c6dfe..9fa091d 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -1,4 +1,6 @@
PyYAML>=5.3.1
jsonschema>=4.17.0
python-slugify>=6.1.1
-dnspython>=2.2.1
\ No newline at end of file
+dnspython>=2.2.1
+networkx>=3.2.1
+typer>=0.12.0
\ No newline at end of file
diff --git a/scripts/generate-fixtures.sh b/scripts/generate-fixtures.sh
index 51d94ce..c2be9f0 100755
--- a/scripts/generate-fixtures.sh
+++ b/scripts/generate-fixtures.sh
@@ -58,6 +58,7 @@ mkdir -p "$PROJECT_DIR/build/fixtures"
if [ -n "$__fetch_from" ]; then
echo "Fetching fixtures from $__fetch_from..."
wget --quiet -O "$PROJECT_DIR/build/fixtures/machine-info.json" "$__fetch_from/machine-info.json"
+ wget --quiet -O "$PROJECT_DIR/build/fixtures/ssh-info.json" "$__fetch_from/ssh-info.json"
wget --quiet -O "$PROJECT_DIR/build/fixtures/website-config.json" "$__fetch_from/website-config.json"
wget --quiet -O "$PROJECT_DIR/build/fixtures/affiliation.schema.json" "$__fetch_from/affiliation.schema.json"
wget --quiet -O "$PROJECT_DIR/build/fixtures/user.schema.json" "$__fetch_from/user.schema.json"
@@ -67,6 +68,7 @@ else
git worktree add "$PROJECT_DIR/build/data" origin/data
# Generate fixtures
python3 "$SCRIPT_DIR/generate-machine-info.py" "$PROJECT_DIR/build/data" "$PROJECT_DIR/build/fixtures"
+ python3 "$SCRIPT_DIR/generate-ssh-info.py" "$PROJECT_DIR/build/fixtures"
python3 "$SCRIPT_DIR/generate-website-config.py" "$PROJECT_DIR/../outputs" "$PROJECT_DIR/build/fixtures"
cp "$PROJECT_DIR/../directory/affiliations/affiliation.schema.json" "$PROJECT_DIR/build/fixtures"
cp "$PROJECT_DIR/../outputs/directory/users/user.schema.json" "$PROJECT_DIR/build/fixtures"
@@ -75,8 +77,12 @@ fi
# Add typescript types
echo "Generating fixture types..."
./node_modules/.bin/quicktype -o "$PROJECT_DIR"/build/fixtures/machine-info.{ts,json}
+./node_modules/.bin/quicktype -o "$PROJECT_DIR"/build/fixtures/ssh-info.{ts,json}
./node_modules/.bin/quicktype -o "$PROJECT_DIR"/build/fixtures/website-config.{ts,json}
+echo "Generating mdx files from data..."
+python3 "$SCRIPT_DIR/generate-mdx-strings.py" json-to-mdx "$PROJECT_DIR/build/fixtures/ssh-info.json" "$PROJECT_DIR/build/fixtures/strings"
+
echo "Compiling JSON schema validators..."
node "$PROJECT_DIR/scripts/compile-json-schema-validators.js" "$PROJECT_DIR/build/fixtures"
diff --git a/scripts/generate-mdx-strings.py b/scripts/generate-mdx-strings.py
new file mode 100644
index 0000000..c141408
--- /dev/null
+++ b/scripts/generate-mdx-strings.py
@@ -0,0 +1,72 @@
+import json
+import typer
+import hashlib
+from pathlib import Path
+
+app = typer.Typer()
+
+def hash_code(s):
+ """Returns a hash code from a string.
+
+ Args:
+ s (str): The string to hash.
+
+ Returns:
+ int: A 32-bit integer hash of the string.
+
+ References:
+ - http://werxltd.com/wp/2010/05/13/javascript-implementation-of-javas-string-hashcode-method/
+ - https://stackoverflow.com/a/8831937
+ """
+ hash = 0
+ for char in s:
+ hash = (hash << 5) - hash + ord(char)
+ hash &= 0xFFFFFFFF # Convert to 32bit integer
+ return hash
+
+
+# Derived from:
+# https://chat.openai.com/share/41d568ff-b124-4144-a19e-b51938adf7ce
+@app.command()
+def get_all_strings(json_file_path):
+ # Load the JSON data from the file
+ with open(json_file_path, "r") as file:
+ data = json.load(file)
+
+ def extract_strings(element, result):
+ if isinstance(element, dict): # If element is a dictionary
+ for value in element.values():
+ extract_strings(value, result)
+ elif isinstance(element, list): # If element is a list
+ for item in element:
+ extract_strings(item, result)
+ elif isinstance(element, str): # If element is a string
+ result.append(element)
+
+ # Initialize an empty list to hold the strings
+ strings = []
+ # Extract strings from the loaded JSON data
+ extract_strings(data, strings)
+
+ return strings
+
+@app.command()
+def dump_mdx(strings: list[str], output_dir: str):
+ output_dir = Path(output_dir)
+ Path.mkdir(output_dir, exist_ok=True)
+
+ for s in strings:
+ basename = f"{hash_code(s)}.mdx"
+
+ with open(output_dir / basename, "w") as file:
+ file.write(s)
+
+ print(f"Dumped {len(strings)} strings to {output_dir}")
+
+@app.command()
+def json_to_mdx(json_file_path: str, output_dir: str):
+ strings = get_all_strings(json_file_path)
+ dump_mdx(strings, output_dir)
+
+if __name__ == '__main__':
+ app()
\ No newline at end of file
diff --git a/scripts/generate-ssh-info.py b/scripts/generate-ssh-info.py
new file mode 100644
index 0000000..0fce636
--- /dev/null
+++ b/scripts/generate-ssh-info.py
@@ -0,0 +1,190 @@
+import argparse
+import csv
+import json
+import re
+import sys
+import textwrap
+from itertools import chain
+from pathlib import Path
+
+import networkx as nx
+
+sys.path.append(str(Path(__file__).parent.parent.parent))
+
+from directory.scripts.host_utils import get_host_config, get_hosts_in_group
+
+
+def print_graph_ascii(G):
+ print("Nodes:")
+ for node in G.nodes:
+ print(f"{node}: {G.nodes[node]}")
+ print("\nEdges:")
+ for edge in G.edges:
+ print(f"{edge[0]} -- {edge[1]}: {G.edges[edge]}")
+
+
+def get_network_from_hostname(hostname, networks):
+ for network in networks:
+ for regex in network["hostname_regexes"]:
+ if re.match(regex, hostname):
+ return network
+
+ return None
+
+
+def generate_network_graph():
+ host_config = get_host_config()
+
+ networks = host_config["networks"]
+ login_nodes = get_hosts_in_group(host_config, "login_nodes")
+ bastion_nodes = get_hosts_in_group(host_config, "bastion_nodes")
+
+ G = nx.Graph()
+
+ G.add_node("_entrypoint", type="entrypoint")
+
+ for network in networks:
+ G.add_node(network["name"], type="network", display_name=f"{network['name'].capitalize()} Network")
+
+ for node in chain(login_nodes, bastion_nodes):
+ G.add_node(node["name"], type="host")
+
+ for nn in node["networks"]:
+ is_entrypoint = nn["is_accessible_from_internet"]
+
+ for record in nn.get("dns_records", []):
+ hostname = record["name"]
+ if is_entrypoint:
+ G.add_edge(node["name"], "_entrypoint", hostname=hostname)
+
+ network = get_network_from_hostname(hostname, networks)
+ if network is None:
+ if not is_entrypoint:
+ print(
+ f"WARNING: No network found for hostname {hostname}, skipping",
+ file=sys.stderr,
+ )
+ continue
+
+ G.add_edge(
+ node["name"],
+ network["name"],
+ hostname=hostname,
+ )
+
+ G.add_node("UWaterloo VPN", type="service")
+ G.add_edge(
+ "UWaterloo VPN",
+ "_entrypoint",
+ instructions=[
+ "Connect to the [UWaterloo VPN](https://uwaterloo.ca/web-resources/resources/virtual-private-network-vpn)",
+ ],
+ )
+ G.add_edge("UWaterloo VPN", "university")
+
+ G.add_node("UWaterloo Campus", type="service")
+ G.add_edge(
+ "UWaterloo Campus",
+ "_entrypoint",
+ instructions=[
+ "Connect to the UWaterloo network (e.g. on-campus Ethernet or Eduroam Wi-Fi)",
+ ],
+ )
+ G.add_edge("UWaterloo Campus", "university")
+
+ return G
+
+
+def generate_ssh_command(hostnames):
+ assert len(hostnames) > 0, "Expected at least one hostname, got 0"
+ assert (
+ len(hostnames) <= 2
+ ), f"Expected at most 2 hostnames, got {len(hostnames)}: {hostnames}"
+
+ if len(hostnames) == 1:
+ return f"ssh -v -i '__SSH_KEY_PATH__' __SSH_USER__@{hostnames[0]}"
+
+ return (
+ r"""
+ ssh -v -o ProxyCommand="ssh -W %h:%p -i '__SSH_KEY_PATH__' __SSH_USER__@__JUMP_HOST__" -i '__SSH_KEY_PATH__' __SSH_USER__@__HOST__
+ """.replace("__JUMP_HOST__", hostnames[0]).replace("__HOST__", hostnames[1]).strip()
+ )
+
+
+def generate_ssh_markdown(hostnames):
+ return textwrap.dedent(f"""
+ Run the following command:
+
+ ```bash copy
+ {generate_ssh_command(hostnames)}
+ ```
+ """).strip()
+
+
+def generate_ssh_info():
+ G = generate_network_graph()
+
+ print(
+ f"Generated SSH network graph with {G.number_of_nodes()} graph nodes and {G.number_of_edges()} graph edges"
+ )
+ print_graph_ascii(G)
+
+ shortest_paths = {
+ n: list(nx.all_shortest_paths(G, source="_entrypoint", target=n))
+ for n in G.nodes
+ if G.nodes[n]["type"] == "host"
+ }
+
+ ssh_info = {}
+ for n, paths in shortest_paths.items():
+ ssh_info[n] = {"paths": []}
+ for path in paths:
+ assert (
+ len(path) <= 4
+ ), f"Expected at most 4 path nodes (2 hops), got {len(path)}: {path}"
+
+ instructions = []
+ ssh_host_chain = []
+
+ for edge in zip(path, path[1:]):
+ _source, target = edge
+
+ edge_props = G.edges[edge]
+
+ if G.nodes[target]["type"] == "host":
+ ssh_host_chain.append(edge_props["hostname"])
+ elif G.nodes[target]["type"] == "service":
+ if len(ssh_host_chain) > 0:
+ instructions.append(generate_ssh_markdown(ssh_host_chain))
+ ssh_host_chain = []
+ instructions.extend(edge_props["instructions"])
+ elif G.nodes[target]["type"] == "network":
+ pass # noop
+ else:
+ raise ValueError(
+ f"Unexpected node type: {G.nodes[target]} in edge {edge}. Path: {path}"
+ )
+
+ if len(ssh_host_chain) > 0:
+ instructions.append(generate_ssh_markdown(ssh_host_chain))
+
+ ssh_info[n]["paths"].append(
+ {
+ "hops": [
+ G.nodes[n].get("display_name", n) for n in path if G.nodes[n]["type"] in ["host", "service", "network"]
+ ],
+ "instructions": instructions,
+ }
+ )
+
+ return ssh_info
+
+if __name__ == "__main__":
+ parser = argparse.ArgumentParser(
+ description="Generate information required for SSH instructions"
+ )
+ parser.add_argument("fixtures_path", type=str, help="Path to fixtures")
+ args = parser.parse_args()
+ fixtures = generate_ssh_info()
+ with open(Path(args.fixtures_path, "ssh-info.json"), "w") as file:
+ json.dump(fixtures, file, indent=2)
diff --git a/tsconfig.json b/tsconfig.json
index 9b62a16..de2d94d 100644
--- a/tsconfig.json
+++ b/tsconfig.json
@@ -9,7 +9,7 @@
// "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
// "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */
/* Language and Environment */
- "target": "es2016", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+ "target": "es2017", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
// "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
// "jsx": "preserve", /* Specify what JSX code is generated. */
// "experimentalDecorators": true, /* Enable experimental support for legacy experimental decorators. */
@@ -22,14 +22,16 @@
// "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
// "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */
/* Modules */
- "module": "commonjs", /* Specify what module code is generated. */
+ "module": "esnext", /* Specify what module code is generated. */
// "rootDir": "./", /* Specify the root folder within your source files. */
// "moduleResolution": "node10", /* Specify how TypeScript looks up a file from a given module specifier. */
// "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
/* Specify a set of entries that re-map imports to additional lookup locations. */
"paths": {
// Add support for importing modules from the root directory using the @ symbol
- "@/*": [ "./*" ]
+ "@/*": [
+ "./*"
+ ]
},
// "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
// "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */
@@ -77,7 +79,8 @@
// "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
"esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
// "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
- "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. *//* Type Checking */
+ "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
+ /* Type Checking */
"strict": true, /* Enable all strict type-checking options. */
// "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */
// "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */