GShare documentation

GShare lets several organizations, groups, and users share a Kubernetes GPU cluster — in fractional or exclusive mode — and accounts for what they use in credits.

Where to start

If you are…	Read in this order
New to the project	Architecture and concepts → Getting started
A user who wants to run sessions	User manual
An administrator managing organizations and resources	Administrator manual
An operator deploying to a GPU cluster	Getting started → Cluster setup → Connecting a cluster
An operator adding a SECOND GPU cluster	Multi-cluster
A developer contributing code	Contributing guide → the component READMEs
A developer adding or changing a console screen	Console UX standards → the persona audit

All documents

Understanding the system

• Architecture and concepts — components, data flow, and the vocabulary the rest of the documentation assumes: offering, preset, session, occupancy, credit, policy, pause. Read this first.
• Overview deck — single-file HTML introduction, also available as PDF and PowerPoint. Korean.

Using the console

• User manual — login, dashboard, sessions, wallet, volumes, and account settings, screen by screen.
• Administrator manual — organizations, groups, users, resource catalog and policy, credit allocation, clusters and nodes, session monitoring, audit.

Deploying and operating

• Getting started — from a fresh clone to a running platform, both the local walkthrough and the real deployment.
• Cluster setup — building the prerequisite GPU Kubernetes cluster from scratch with kubeadm and HAMi.
• Connecting a cluster — registering a cluster with the control
• Multi-cluster — attaching further GPU clusters to one control plane: prerequisites, hack/attach-cluster.sh, verification and token rotation plane and attaching its operator.

Developing and design

• Contributing guide — environment, tests, pull request workflow.
• Components: backend/ (control plane) · operator/ (execution plane) · frontend/ (console).
• Console UX standards — what every screen owes the user, and the shared components that provide it. Checked by the persona audit, which needs only the control plane.

The root README.md and the code are the authority on current behavior. These documents sit on top of that to help you learn, use, and operate the platform.