feat: renamed to kty

Author: grampelberg

.envrc.example

@@ -1,6 +1,12 @@
 #!/bin/bash
 
-export LOCAL_REGISTRY="kuberift:5432"
+export RUST_LOG=none,kuberift=debug
+export LOCAL_REGISTRY="kty:5432"
 
-export GHCR_USER="me"
-export GHCR_TOKEN="token"
+# export GHCR_USER="me"
+# export GHCR_TOKEN="token"
+
+# Egress Tunnel
+# export HOSTNAME="nginx-deployment-65fcddc477-7hbsr"
+# export POD_UID="bb907585-5a0e-4920-b789-7d23aa31113e"
+# export POD_IP="198.19.248.254"

.github/workflows/build.yml

@@ -55,12 +55,12 @@ jobs:
 
       - name: rename
         run: |-
-          cp target/release/kuberift kuberift-${{ matrix.os }}-${{ matrix.arch }}
+          cp target/release/kty kty-${{ matrix.os }}-${{ matrix.arch }}
 
       - uses: actions/upload-artifact@v4
         with:
-          name: kuberift-${{ matrix.os }}-${{ matrix.arch }}
-          path: kuberift*
+          name: kty-${{ matrix.os }}-${{ matrix.arch }}
+          path: kty*
           retention-days: 1
 
   # The state of include/exclude in matrices is tough because we want to add the

.github/workflows/docker.yml

@@ -28,8 +28,8 @@ env:
   RUST_BACKTRACE: 1
   CARGO_INCREMENTAL: 0
   RUSTFLAGS: -D warnings
-  IMAGE: ghcr.io/grampelberg/kuberift
-  CACHE: ghcr.io/grampelberg/cache/kuberift
+  IMAGE: ghcr.io/grampelberg/kty
+  CACHE: ghcr.io/grampelberg/cache/kty
 
 jobs:
   build:
@@ -67,7 +67,7 @@ jobs:
         uses: docker/build-push-action@v6
         with:
           context: .
-          file: docker/kuberift.dockerfile
+          file: docker/kty.dockerfile
           platforms: ${{ inputs.os }}/${{ inputs.arch }}
 
           cache-from: type=registry,ref=${{ env.CACHE }}

.github/workflows/release.yml

@@ -8,7 +8,7 @@ on:
       - v*
 
 env:
-  IMAGE: ghcr.io/grampelberg/kuberift
+  IMAGE: ghcr.io/grampelberg/kty
 
 concurrency:
   group: |-
@@ -88,7 +88,7 @@ jobs:
       - uses: actions/upload-artifact@v4
         if: ${{ github.event_name != 'pull_request' }}
         with:
-          name: kuberift-docker-binaries
+          name: kty-docker-binaries
           path: /tmp/bins/*
           retention-days: 1
 
@@ -149,7 +149,7 @@ jobs:
       - uses: actions/download-artifact@v4
         with:
           path: /tmp/binaries
-          pattern: kuberift-*
+          pattern: kty-*
           merge-multiple: true
 
       - uses: actions/download-artifact@v4

Cargo.lock

@@ -1,8 +1,9 @@
 [package]
-name = "kuberift"
+name = "kty"
 version.workspace = true
 authors.workspace = true
-description = "SSH into a Kubernetes cluster"
+description = "SSH into Kubernetes"
+homepage.workspace = true
 documentation.workspace = true
 license-file.workspace = true
 edition.workspace = true
@@ -13,12 +14,13 @@ categories.workspace = true
 [workspace.package]
 version = "0.0.0-UNSTABLE"
 authors = ["Thomas Rampelberg <thomas@saunter.org>"]
-documentation = "https://github.com/grampelberg/kubrift"
+homepage = "https://kty.dev"
+documentation = "https://kty.dev"
 edition = "2021"
 license-file = "LICENSE"
-repository = "https://github.com/grampelberg/kuberift"
+repository = "https://github.com/grampelberg/kty"
 keywords = ["cli", "kubernetes", "ssh", "tui", "terminal"]
-categories = ["command-line-interface"]
+categories = ["command-line-interface", "development-tools", "virtualization"]
 
 [dependencies]
 ansi-to-tui = "6.0.0"

Cargo.toml

@@ -38,17 +38,17 @@ want to upload directly to github.
 We recommend using [k3d][k3d] to run a local cluster. To setup:
 
 ```bash
-k3d cluster create kuberift --registry-create kuberift:5432
+k3d cluster create kty --registry-create kty:5432
 ```
 
 Next, you'll want to add the registry to your `/etc/hosts`:
 
 ```bash
-echo "127.0.0.1 kuberift" | sudo tee -a /etc/hosts
+echo "127.0.0.1 kty" | sudo tee -a /etc/hosts
 ```
 
-When you run `just dev-push`, an image at `kuberift:5432/kuberift:latest` will
-be available to run inside the cluster.
+When you run `just dev-push`, an image at `kty:5432/kty:latest` will be
+available to run inside the cluster.
 
 [k3d]: https://k3d.io/v5.6.3/#releases
 
@@ -57,7 +57,7 @@ be available to run inside the cluster.
 The global debug level can be overly noisy. Instead of doing `-vvvv`, try:
 
 ```bash
-RUST_LOG=none,kuberift=debug
+RUST_LOG=none,kty=debug
 ```
 
 ## Ingress Tunnel

DEVELOPMENT.md

@@ -1,19 +1,26 @@
-# kuberift
+# kty
 
-SSH into your Kubernetes cluster! kuberift is an SSH server that provides a
-TUI-based dashboard in your cluster. There's no need to manage SSH keys however.
-It works with OpenID providers, such as Github or Google and impersonates users
-to provide them with the same permissions they normally would have - all based
-on the standard RBAC mechanisms.
+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.
 
 You can:
 
-- Get a shell in running pods - just like you would with SSH normally.
+- Use your Github or Google account to log into the cluster. No more annoying
+  `kubectl` auth plugins.
+- Get a shell running in pods - just like you would when SSH'n into a host
+  normally.
 - Access the logs for running and exited containers in a pod.
-- Forward a local port remotely, allowing access to services and pods in the
-  cluster.
-- Forward a remote service to your local system.
-- `scp` files from pods. sftp clients work as well.
+- Forward traffic from your local machine into the cluster or from the cluster
+  to your local machine.
+- `scp` or `sftp` files from pods.
+- Access the cluster from any device that has an SSH client, from phones to
+  embedded devices.
+
+kty is an SSH server written in rust which provides a TUI-based dashboard that
+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)
 
@@ -25,7 +32,7 @@ You can:
 - [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
-  kuberift itself.
+  kty itself.
 - [Metrics](docs/metrics.md) - List of the possible metrics exported via.
   prometheus.
 
@@ -45,13 +52,13 @@ You can:
    login and the providers available can all be configured.
 
    ```bash
-   kuberift users grant <cluster-role> <email-address>
+   kty users grant <cluster-role> <email-address>
    ```
 
 1. Start the server.
 
    ```bash
-   kuberift --serve
+   kty --serve
    ```
 
 1. SSH into your cluster!
@@ -81,7 +88,7 @@ From this point, here's a few suggestions for things to check out:
 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/kuberift/releases
+[cli-download]: https://github.com/grampelberg/kty/releases
 [k3d]: https://k3d.io
 
 ## Interaction
@@ -132,11 +139,11 @@ ssh my-node-username@localhost -p 3333
 
 You can forward a remote service on your cluster to a port on your local host.
 
-To forward port 8080 on service `default/kuberift` to port `9090` on your local
+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/kuberift:8080:localhost:9090
+ssh me@my-cluster -p 2222 -R default/kty:8080:localhost:9090
 ```
 
 The format for service definitions is `<namespace>/<service-name>`.

README.md

@@ -105,7 +105,10 @@
 
 - Figure out why `git cliff` goes `0.2.0` -> `0.2.1` -> `0.3.0` instead of
   `0.2.2`.
-- Move client_id and config_url to a build-time concern.
+- Move client_id and config_url to a build-time concern. I'm not sure this will
+  be great for the development experience. Is there a way to have defaults but
+  override them? Maybe with a dev instance of auth0?
+- Publish to crates.io.
 
 ## Deployment
 

TODO.md

@@ -1,4 +1,4 @@
-//! Build script for kuberift.
+//! Build script for kty.
 
 static PH_VAR: &str = "POSTHOG_API_KEY";
 

build.rs

@@ -30,5 +30,5 @@ RUN apt-get update && apt-get install -y \
     && \
     apt-get clean
 
-COPY --from=builder /app/target/release/kuberift /usr/local/bin
-CMD ["/usr/local/bin/kuberift", "serve", "-vv"]
+COPY --from=builder /app/target/release/kty /usr/local/bin
+CMD ["/usr/local/bin/kty", "serve", "-vv"]

docker/kuberift.dockerfile docker/kty.dockerfile

@@ -1,6 +1,6 @@
 # Architecture
 
-Kuberift is a standalone SSH server which provides much of the standard SSH
+kty is a standalone SSH server which provides much of the standard SSH
 functionality as if a Kubernetes cluster was a single host. This allows for
 `ssh me@my-cluster` to provide a shell in a running pod, tunneling between
 resources without a VPN and copying files from the cluster. By leveraging OpenID