feat(docs): moved to a nextra docs website

Author: grampelberg

.envrc.example

@@ -1,6 +1,6 @@
 #!/bin/bash
 
-export RUST_LOG=none,kuberift=debug
+export RUST_LOG=none,kty=debug
 export LOCAL_REGISTRY="kty:5432"
 
 # export GHCR_USER="me"

.gitignore

@@ -1,4 +1,15 @@
-# Generated by Cargo
+# =========== Project ===========
+
+tmp
+.DS_Store
+.envrc
+CHANGELOG.md
+bun.lockb
+
+helm/charts
+
+# =========== Rust ===========
+
 # will have compiled files and executables
 debug/
 target/
@@ -13,9 +24,135 @@ target/
 
 /target
 
-tmp
-.DS_Store
-.envrc
-CHANGELOG.md
+# =========== Node ===========
 
-helm/charts
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*

README.md

@@ -1,8 +1,8 @@
 # kty
 
-SSH into Kubernetes. kty is the easiest way to access resources such as pods on
-your cluster - all without `kubectl`. Once kty is installed on your cluster,
-`ssh` gives you a dashboard to interact with the cluster.
+The terminal for Kubernetes. kty is the easiest way to access resources such as
+pods on your cluster - all without `kubectl`. Once kty is installed on your
+cluster, `ssh` gives you a dashboard to interact with the cluster.
 
 You can:
 
@@ -22,148 +22,9 @@ maps Kubernetes concepts to SSH. It relies on OpenID providers such as Github or
 Google to verify your identity. Kubernetes RBAC validates access, just like
 `kubectl` does, respecting your organizational policies.
 
-![demo](./assets/demo.gif)
-
-## Documentation
-
-- [Architecture](docs/architecture.md)
-- [Auth][auth] - Deep dive on what's happening around auth and what the minimum
-  permissions are for each piece of functionality.
-- [Deployment](docs/deployment.md) - Figure out how to get running on your own
-  cluster.
-- [Development](DEVELOPMENT.md) - Some tips and tricks for doing development on
-  kty itself.
-- [Metrics](docs/metrics.md) - List of the possible metrics exported via.
-  prometheus.
-
-[auth]: docs/auth.md
-
-## Getting Started
-
-1. Download the [cli][cli-download] and add it to your `$PATH`.
-1. Get a k8s cluster. [k3d][k3d] is a convenient way to get a cluster up and
-   running fast. Follow their installation instructions and create a default
-   cluster.
-1. Grant your email address access to the cluster. Choose `cluster-admin` if
-   you'd like something simple to check out how things work. For more details on
-   the minimum possible permissions, read the [Authorization][auth] section. The
-   email address is what you'll be using to authenticate against. It can either
-   be the one associated with a google or github account. Note, the ID used for
-   login and the providers available can all be configured.
-
-   ```bash
-   kty users grant <cluster-role> <email-address>
-   ```
-
-1. Start the server.
-
-   ```bash
-   kty --serve
-   ```
-
-1. SSH into your cluster!
-
-   ```bash
-   ssh -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no -p 2222 me@localhost
-   ```
-
-From this point, here's a few suggestions for things to check out:
-
-- Start a new pod. It'll show up in the dashboard immediately!
-
-- Exec into a pod. Select the pod you want and go to the `Shell` tab. You'll be
-  able to pick the command to exec and then be shell'd into the pod directly.
-
-- Follow the logs. Logs for all containers in a pod are streamed to the `Logs`
-  tab when you've selected a pod from the main list.
-
-- `scp` some files out of a container:
-
-  ```bash
-  scp -P 2222 me@localhost:/default/my-pod/etc/hosts /tmp
-  ```
-
-- Use your own [OpenID provider](docs/deployment.md#bring-your-own-provider).
-
-Note: you'll want to install on-cluster to use the tunnelling functionality.
-Check out the [helm](docs/deployment.md#helm) docs for a quick way to do that.
-
-[cli-download]: https://github.com/grampelberg/kty/releases
-[k3d]: https://k3d.io
-
-## Interaction
-
-### SSH
-
-To get to the dashboard, you can run:
+Visit the [docs](https://kty.dev) to get started!
 
-```bash
-ssh anything@my-remote-host-or-ip -p 2222
-```
-
-The provided username is not used as your identity is authenticated via other
-mechanisms.
-
-### Ingress Tunnel (`ssh -L`)
-
-You can forward requests from a local port into a resource on the remote
-cluster. The supported resources are `nodes`, `pods` and `services`. See the
-[authorization][auth] section for details on required RBAC.
-
-To forward port 9090 on your local system to 80 on the cluster, you can run:
-
-```bash
-ssh me@my-cluster -p 2222 -L 9090:service/default/remote-service:80
-```
-
-The first time 9090 is accessed, a connection will be made. Pay attention to the
-dashboard as any errors establishing this session will be reflected there.
-
-The connection string format is `<resource>/<namespace>/<name>`. As nodes are
-not namespaced, the format is `<resource>/<name>`.
-
-Unlike the API server proxy, this works for any TCP service and is not limited
-to HTTP/HTTPS. For example, you can ssh directly to a node in the cluster with:
-
-```bash
-ssh me@my-cluster -p 2222 -L 3333:no/my-node:22
-```
-
-With that running in one terminal, you can run this in another:
-
-```bash
-ssh my-node-username@localhost -p 3333
-```
-
-### Egress Tunnel (`ssh -R`)
-
-You can forward a remote service on your cluster to a port on your local host.
-
-To forward port 8080 on service `default/kty` to port `9090` on your local
-system, you can run:
-
-```bash
-ssh me@my-cluster -p 2222 -R default/kty:8080:localhost:9090
-```
-
-The format for service definitions is `<namespace>/<service-name>`.
-
-### SFTP
-
-The cluster is represented by a file tree:
-
-```bash
-/<namespace>/<pod-name>/<container-name>/<file-path>
-```
-
-For the `nginx` pod running in `default`, you would do something like:
-
-```bash
-scp -P 2222 me@localhost:/default/nginx/nginx/etc/hosts /tmp
-```
-
-It can be a little easier to navigate all this with an sftp client as that'll
-render the file tree natively for you.
+![demo](./assets/demo.gif)
 
 ## Releases
 

docs/.mise.toml

@@ -0,0 +1,3 @@
+[tools]
+node = "22.2.0"
+bun = "1.1.27"

docs/next-env.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="next" />
+/// <reference types="next/image-types/global" />
+
+// NOTE: This file should not be edited
+// see https://nextjs.org/docs/basic-features/typescript for more information.

docs/next.config.mjs

@@ -0,0 +1,14 @@
+import nextra from 'nextra'
+
+const withNextra = nextra({
+  theme: 'nextra-theme-docs',
+  themeConfig: './theme.config.tsx',
+  latex: true,
+  search: {
+    codeblocks: false,
+  },
+})
+
+export default withNextra({
+  reactStrictMode: true,
+})

docs/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "kty",
+  "version": "0.0.1",
+  "type": "module",
+  "description": "kty",
+  "scripts": {
+    "dev": "next dev",
+    "build": "next build",
+    "start": "next start"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/grampelberg/kty.git"
+  },
+  "author": "Thomas Rampelberg <thomas@saunter.org>",
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/grampelberg/kty/issues"
+  },
+  "homepage": "https://github.com/grampelberg/kty#readme",
+  "dependencies": {
+    "next": "^13.0.6",
+    "nextra": "latest",
+    "nextra-logo": "^0.1.3-beta.1",
+    "nextra-theme-docs": "latest",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0"
+  },
+  "devDependencies": {
+    "@types/node": "18.11.10",
+    "typescript": "^4.9.3"
+  }
+}

docs/pages/_meta.js

@@ -0,0 +1,7 @@
+export default {
+  index: 'Overview',
+  legal: {
+    title: 'Legal',
+    display: 'hidden',
+  },
+}