Skip to main content

Access kubernetes clusters over ssh

Project description

sshkube

Enable access to your kubernetes cluster over ssh:

  • ssh public key used to authenticate users to the ssh server
  • kubeconfig is available on the ssh server
  • all kubectl commands run on the host but routed through an SSH facilitated SOCKS5 HTTPS proxy

SSH Server

  • An ssh server enables login by users with public keys fetched from github
  • The server contains a .kube/config file usable for accessing the kubernetes cluster
  • The server has tcp forwarding enabled

SSHKube Client Library

  • A python CLI
  • SSHs to the ssh server and obtains the .kube/config file
  • Runs a SOCKS5 proxy server as a daemon
  • prepares environment variables for kubectl to route requests through the SOCKS5 proxy server

Install on Cluster

# create demo cluster
k3d cluster create -a1 -p "80:80@loadbalancer" -p "443:443@loadbalancer"

DOMAIN=sshkube.localhost.u8sand.net

# install the sshkube chart
#   users specified line-by-line in githubUsers will be able to authenticate against the cluster
#   storage is used for ssh host keys persistence
#   ingress is used to forward ssl connections to the given domain to the ssh server
helm install --create-namespace -n sshkube sshkube ./charts/sshkube/ -f - << EOF
ingress:
  type: traefik
  domain: ${DOMAIN}
  certResolver: null
storage:
  class: local-path
githubUsers: |
  u8sand
EOF
# by default, users you configure will be given a namespace and exclusive access to that namespace
# cluster admins can give the user broader access if necessary, e.g.
kubectl create clusterrolebinding u8sand --clusterrole=cluster-admin --serviceaccount=u8sand:u8sand

# any user that has been granted access can use sshkube like so:

# the client library can be configured to use the public server we've deployed
# specify your github username and github identity file
sshkube install -s ${DOMAIN} -u u8sand -i ~/.ssh/id_ed25519

# we can run commands through ssh
sshkube run kubectl get secret

# or, preferred we "activate" our environment and use local kubectl
#  this will allow us to also use port-forward
eval "$(sshkube init)"
kubectl get secret

# clean up
k3d cluster delete

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sshkube-0.1.1.tar.gz (4.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sshkube-0.1.1-py3-none-any.whl (5.3 kB view details)

Uploaded Python 3

File details

Details for the file sshkube-0.1.1.tar.gz.

File metadata

  • Download URL: sshkube-0.1.1.tar.gz
  • Upload date:
  • Size: 4.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.9.6 Darwin/25.5.0

File hashes

Hashes for sshkube-0.1.1.tar.gz
Algorithm Hash digest
SHA256 1cd6a27b7438e911995a3f78009e20105c4ee391d7b6f27b84f2e159a0f44266
MD5 7f064f3003367765ca0410ee52baaeb2
BLAKE2b-256 3846b3c49f41ba8a16dc0060a7d27c9932c49095b20d0d570b3b0e25a2c67f29

See more details on using hashes here.

File details

Details for the file sshkube-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: sshkube-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 5.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.9.6 Darwin/25.5.0

File hashes

Hashes for sshkube-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 76fd2b550dd07f1af996e49e0e0fa75d3a67c6135fb424292b597fdaf309775a
MD5 51761bb81be9d0b08e96516dc780f2e9
BLAKE2b-256 96b03aa793783b43eb12a6ccc92b51bf1d7c1ec43ab8b9566950cb058b5500fc

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page