Skip to main content

Access kubernetes clusters over ssh

Project description

sshkube

Configure access to a 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.2.3.tar.gz (8.9 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.2.3-py3-none-any.whl (10.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sshkube-0.2.3.tar.gz
  • Upload date:
  • Size: 8.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.12.0 Linux/6.15.4-arch2-1

File hashes

Hashes for sshkube-0.2.3.tar.gz
Algorithm Hash digest
SHA256 bb8d22ba05138bb379ff912fd600ad497a34e41c84ba0a19458da5b0f44f5c28
MD5 4bea1bfea942e41cba04616b9f00f057
BLAKE2b-256 6cadd7d9a3ec76c08f10314793b75b08870a3e4337f6404a30cc674358d1e48b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sshkube-0.2.3-py3-none-any.whl
  • Upload date:
  • Size: 10.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.12.0 Linux/6.15.4-arch2-1

File hashes

Hashes for sshkube-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 d591abef4836a3aba4c9f4238bcb8b5e9c6965702b0f79378477b0c6c29b7c54
MD5 f66d5fa7662fe351cb875c74da009190
BLAKE2b-256 1be0a54063325905a8453f06725af7dbd0cdf5ed77739cdd33118e1825b38505

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