ssherpa 0.2.0__tar.gz

ssherpa-0.2.0/.gitattributes

@@ -0,0 +1,13 @@
+# Git stores text as LF in the repository. The working tree gets the platform's
+# native line endings unless overridden below.
+* text=auto
+
+# Must stay LF: Linux tooling reads these directly, and a shell script checked
+# out with CRLF fails at its shebang.
+*.sh          text eol=lf
+Dockerfile*   text eol=lf
+*.yml         text eol=lf
+*.py          text eol=lf
+
+# Windows-only script.
+*.ps1         text eol=crlf

ssherpa-0.2.0/.github/workflows/publish.yml

@@ -0,0 +1,58 @@
+# Publish to PyPI via trusted publishing (no API tokens).
+#
+# Runs when a version tag (v*) is pushed. `workflow_dispatch` allows a manual
+# first run for a tag that predates this file.
+#
+# PyPI side: pypi.org > account > Publishing, registered against this
+# repository with workflow name `publish.yml` and environment `pypi`.
+
+name: publish
+
+on:
+  push:
+    tags: ["v*"]
+  workflow_dispatch:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: python -m pip install -e ".[dev]"
+      - run: ruff check .
+      # Unit tests only. The container suite needs Docker compose and the
+      # cluster layer needs a real host; neither belongs in a publish gate.
+      - run: pytest
+
+  build:
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: python -m pip install build
+      - run: python -m build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    # Must match the environment name registered on PyPI.
+    environment: pypi
+    permissions:
+      # This is what lets PyPI verify the upload comes from this workflow.
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1

ssherpa-0.2.0/.gitignore

@@ -0,0 +1,14 @@
+__pycache__/
+*.py[cod]
+*.egg-info/
+build/
+dist/
+.venv/
+venv/
+.pytest_cache/
+.idea/
+.vscode/
+
+# 테스트 전용 SSH 키 (verify.ps1 이 자동 생성)
+tests/docker/id_test
+tests/docker/id_test.pub

ssherpa-0.2.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 kwnoyng
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

ssherpa-0.2.0/PKG-INFO

@@ -0,0 +1,260 @@
+Metadata-Version: 2.4
+Name: ssherpa
+Version: 0.2.0
+Summary: Build lab environments on on-premises servers
+Project-URL: Homepage, https://github.com/kwnoyng/SSHerpa
+Project-URL: Issues, https://github.com/kwnoyng/SSHerpa/issues
+License-Expression: Apache-2.0
+License-File: LICENSE
+Requires-Python: >=3.9
+Requires-Dist: pyyaml>=6
+Requires-Dist: questionary>=2
+Requires-Dist: rich>=13
+Requires-Dist: typer>=0.12
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# SSHerpa
+
+Build Kubernetes labs on a single on-premises server, over nothing but SSH.
+
+> **v0.2** — register a host, check that it is ready, and stand up a
+> single-node Kubernetes cluster (k3s or RKE2) directly on it. VM-based
+> multi-node labs with snapshot/rewind come later.
+
+## Requirements
+
+| | |
+|---|---|
+| Your machine | Python 3.9+, an OpenSSH client |
+| Target host | Ubuntu 22.04 / 24.04, Rocky 9, or AlmaLinux 9 |
+| Access | SSH key-based login and passwordless `sudo` |
+| Memory | ~1 GB for k3s, ~4 GB for RKE2 |
+
+Windows 10/11, macOS, and most Linux distributions ship an OpenSSH client
+already.
+
+**Password authentication is not supported by design.** SSHerpa runs
+non-interactively, so it uses public-key authentication only.
+
+## Install
+
+```bash
+pip install git+https://github.com/kwnoyng/SSHerpa.git
+```
+
+Or, for an isolated install:
+
+```bash
+pipx install git+https://github.com/kwnoyng/SSHerpa.git
+```
+
+## Usage
+
+### 1. Register a host and check it
+
+Replace the address and username below with your own host.
+
+```bash
+ssherpa target add lab-01 --host 10.0.0.10 --user admin --key ~/.ssh/id_ed25519
+ssherpa check lab-01
+```
+
+```
+  SSH connection  ✓  admin@10.0.0.10:22
+  sudo access     ✓  NOPASSWD
+  OS detection    ✓  Ubuntu 24.04.4 LTS  (family: Debian)
+  support status  ✓  supported
+
+  lab-01 is ready
+```
+
+`check` opens a short-lived SSH connection, runs a few probes, and
+disconnects. It exits `0` when every check passes and `1` otherwise, so it
+composes with scripts. When something is wrong, it says what to do about it:
+
+```
+  sudo access     ✗  password required
+
+  Passwordless sudo is required
+
+    SSHerpa needs passwordless sudo for 'admin'.
+    Run this on the target host:
+
+        echo 'admin ALL=(ALL) NOPASSWD:ALL' | sudo tee /etc/sudoers.d/ssherpa
+```
+
+`--key` and `--port` are optional: the port defaults to `22`, and without a
+key `ssh` looks for its usual defaults (`~/.ssh/id_ed25519`, `id_ecdsa`,
+`id_rsa`).
+
+### 2. Bring up a cluster
+
+```bash
+ssherpa up lab-01
+```
+
+On an empty host you pick a distribution with the arrow keys:
+
+```
+? Which Kubernetes distribution?
+❯ k3s    lightweight, installs in about 20s, runs in 1 GB
+  rke2   security-hardened, closer to production, needs 4 GB
+```
+
+then each step reports as it completes:
+
+```
+  Installing k3s on lab-01
+
+    ✓ preflight                1.6s
+    ✓ install k3s             18.8s
+    ✓ wait for node            1.1s
+    ✓ fetch kubeconfig         0.8s
+    ✓ verify api access        5.0s
+
+  Cluster ready
+  kubeconfig: ~/.ssherpa/kubeconfig/lab-01.yaml
+```
+
+Details worth knowing:
+
+- **One distribution per host.** They all bind port 6443 and share
+  `/etc/rancher`, so they cannot coexist — SSHerpa refuses to install a second
+  one until the first is removed.
+- **Re-running is safe.** If the host already has a cluster, `up` asks for
+  confirmation, then skips the install and just refreshes the kubeconfig.
+  Useful when a previous run was interrupted.
+- **Preflight catches real blockers early.** For example, installing RKE2 on a
+  2 GB host fails in seconds with the actual reason (not enough memory) and a
+  suggestion, instead of timing out after five minutes with the control plane
+  half-up.
+- The install passes `--tls-san <your-address>` so the API server certificate
+  is valid for the address you connect to, not just the host's internal IP.
+
+### 3. Use the cluster
+
+The fetched kubeconfig already points at your host's address:
+
+```bash
+export KUBECONFIG=~/.ssherpa/kubeconfig/lab-01.yaml    # PowerShell: $env:KUBECONFIG="..."
+kubectl get nodes
+```
+
+If port 6443 is not reachable (a cloud firewall, for instance), `up` says so
+and shows the safe alternative — an SSH tunnel:
+
+```bash
+ssh -L 6443:127.0.0.1:6443 admin@10.0.0.10
+kubectl --server https://127.0.0.1:6443 get nodes
+```
+
+Opening 6443 to the internet would expose the cluster API; if you do open it,
+restrict it to your own address.
+
+### 4. Inspect and tear down
+
+```bash
+ssherpa status lab-01
+```
+
+```
+  Status of lab-01
+
+  k3s   ✓  installed  active
+  rke2  —  not installed
+
+  node:  lab-01   Ready   control-plane   5m   v1.36.2+k3s1
+```
+
+```bash
+ssherpa down lab-01
+```
+
+`down` detects whatever is installed — there is nothing to choose, since a
+host can only run one distribution. It asks for confirmation (destroying a
+cluster is not undoable), stops everything, runs the uninstaller, verifies
+nothing was left behind, and deletes the local kubeconfig. `--yes` skips the
+prompt for scripts.
+
+### 5. Jump onto the host
+
+```bash
+ssherpa ssh lab-01
+```
+
+Opens a plain interactive SSH session using the target's saved connection
+details. Extra arguments are passed straight to `ssh`.
+
+### Commands
+
+| Command | Connects over SSH |
+|---|---|
+| `ssherpa target add <NAME> --host <IP> --user <USER> [--key <PATH>] [--port <N>]` | no |
+| `ssherpa target list` | no |
+| `ssherpa target remove <NAME>` | no |
+| `ssherpa check <NAME>` (or `--host/--user` for one-off) | yes |
+| `ssherpa up <NAME> [--yes]` | yes |
+| `ssherpa status <NAME>` | yes |
+| `ssherpa down <NAME> [--yes]` | yes |
+| `ssherpa ssh <NAME> [ssh args...]` | yes |
+
+## The inventory
+
+Targets live in `~/.ssherpa/inventory.yml`, written as a plain Ansible
+inventory:
+
+```yaml
+all:
+  hosts:
+    lab-01:
+      ansible_host: 10.0.0.10
+      ansible_user: admin
+      ansible_port: 22
+      ansible_ssh_private_key_file: ~/.ssh/id_ed25519
+```
+
+Two decisions worth knowing:
+
+- **The format is Ansible's on purpose.** Later stages drive Ansible roles, and
+  this file will be reused as-is rather than converted.
+- **Only connection details are stored.** What is installed and running is
+  never written here — it is read from the host every time (`status` does
+  exactly this), so the file cannot drift out of sync with reality.
+
+Set `SSHERPA_INVENTORY` to use a different path.
+
+## Development
+
+```bash
+git clone https://github.com/kwnoyng/SSHerpa.git
+cd SSHerpa
+python -m venv .venv
+.venv/bin/pip install -e ".[dev]"     # Windows: .venv\Scripts\pip
+```
+
+Unit tests need nothing but Python, and cover failure modes that are
+impractical to reproduce against a live host — changed host keys, unroutable
+networks, over-permissive key files, out-of-memory preflights:
+
+```bash
+pytest
+```
+
+Integration tests need Docker. Six containers stand in for real hosts — one per
+supported release, plus one without `sudo` and one running an unsupported
+release. Every version listed as supported is actually connected to here. Both
+scripts generate their own throwaway SSH key, so they never depend on your
+personal keys.
+
+```bash
+./tests/verify.sh            # macOS / Linux
+.\tests\verify.ps1           # Windows
+./tests/verify.sh down       # tear down
+```
+
+The cluster layer (`up`/`down`) is exercised against a real cloud host rather
+than containers — k3s and RKE2 need systemd and their own kernel namespaces,
+which containers do not provide faithfully.