boxd 0.2.5.dev47__tar.gz → 0.2.6.dev355__tar.gz

{boxd-0.2.5.dev47/src/boxd.egg-info → boxd-0.2.6.dev355}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: boxd
-Version: 0.2.5.dev47
+Version: 0.2.6.dev355
 Summary: Python SDK for the boxd cloud VM platform
 Author: Azin
 License-Expression: MIT
@@ -188,7 +188,7 @@ boxd.machines.create(
     cmd=["/usr/local/bin/start"],
     restart_policy="always",      # "always" | "never"
     vcpu=2,
-    memory="8G",                  # "8G", "512M", or a byte count
+    memory="8G",                  # sizes: 1 vCPU/4G, 2/8G, 4/16G
     disk="100G",
     auto_suspend_timeout=300,     # seconds; 0 disables
     auto_destroy_timeout=0,
@@ -219,7 +219,7 @@ Everything else:
 
 ```python
 boxd.machines.fork("my-machine", "my-copy")     # live clone
-boxd.machines.fork(id, shared=True, vcpu=8)     # same sizing options as `create`
+boxd.machines.fork(id, shared=True)             # forks keep the source machine's size
 boxd.machines.rename(id, "new-name")            # returns the new name; reboots the machine
 boxd.machines.share(id)                         # visible to your whole org
 boxd.machines.unshare(id)
@@ -237,6 +237,30 @@ private to you unless you pass `shared=True`.
 usable. Call `wait_until_ready` before doing anything that depends on it
 running — especially before forking it again.
 
+### Sizing
+
+There are three sizes: 1 vCPU/4G, 2/8G, 4/16G. Name either dimension and the
+other follows, so `vcpu=2` and `memory="8G"` are the same request. Anything
+above your org's quota is refused, never quietly clamped.
+
+A machine keeps the size it was created with, through stop/start, wake, and
+migration alike. Changing it is an explicit call:
+
+```python
+result = boxd.machines.resize(id, memory="8G")   # or vcpu=2
+result.vcpu, result.memory_bytes                 # the size now persisted
+result.rebooted                                  # it was running, so it was rebooted
+```
+
+A **running** machine is rebooted to apply the new size: a cold boot, so the
+disk survives and anything in RAM does not. A **stopped** machine takes it at
+its next start. A suspended or hibernated machine is refused, because its
+saved memory image is the old size — resume or wake it first.
+
+A create that names no size uses the org default (see
+[Organizations](#organizations-credentials-account)), and a fork always
+inherits its source's size.
+
 ### The `Machine` record
 
 ```python
@@ -588,6 +612,23 @@ delegation is actually live, for the same reason as per-machine domains
 above. A background check then verifies delegation and issues certs
 automatically, then flips `status` to `"active"`.
 
+An org also has a default machine size: what a `create` that names no size
+gets. It is a preference *below* the quota, not the quota itself — the quota
+stays the operator-owned ceiling and the per-request maximum. Setting or
+clearing it requires org admin; reading it doesn't.
+
+```python
+boxd.orgs.set_machine_defaults("acme", vcpu=2)     # or memory="8G"
+d = boxd.orgs.get_machine_defaults("acme")
+d.is_set                                           # False = no default; the values
+d.vcpu, d.memory_bytes                             # below are just the quota
+d.ceiling_vcpu, d.ceiling_memory_bytes             # the org quota
+boxd.orgs.clear_machine_defaults("acme")           # back to the quota
+```
+
+Only machines created afterwards are affected — every existing machine keeps
+the size it was created with. Omit the org to target your home org.
+
 ```python
 key = boxd.api_keys.create(
     "ci",

{boxd-0.2.5.dev47 → boxd-0.2.6.dev355}/README.md

@@ -156,7 +156,7 @@ boxd.machines.create(
     cmd=["/usr/local/bin/start"],
     restart_policy="always",      # "always" | "never"
     vcpu=2,
-    memory="8G",                  # "8G", "512M", or a byte count
+    memory="8G",                  # sizes: 1 vCPU/4G, 2/8G, 4/16G
     disk="100G",
     auto_suspend_timeout=300,     # seconds; 0 disables
     auto_destroy_timeout=0,
@@ -187,7 +187,7 @@ Everything else:
 
 ```python
 boxd.machines.fork("my-machine", "my-copy")     # live clone
-boxd.machines.fork(id, shared=True, vcpu=8)     # same sizing options as `create`
+boxd.machines.fork(id, shared=True)             # forks keep the source machine's size
 boxd.machines.rename(id, "new-name")            # returns the new name; reboots the machine
 boxd.machines.share(id)                         # visible to your whole org
 boxd.machines.unshare(id)
@@ -205,6 +205,30 @@ private to you unless you pass `shared=True`.
 usable. Call `wait_until_ready` before doing anything that depends on it
 running — especially before forking it again.
 
+### Sizing
+
+There are three sizes: 1 vCPU/4G, 2/8G, 4/16G. Name either dimension and the
+other follows, so `vcpu=2` and `memory="8G"` are the same request. Anything
+above your org's quota is refused, never quietly clamped.
+
+A machine keeps the size it was created with, through stop/start, wake, and
+migration alike. Changing it is an explicit call:
+
+```python
+result = boxd.machines.resize(id, memory="8G")   # or vcpu=2
+result.vcpu, result.memory_bytes                 # the size now persisted
+result.rebooted                                  # it was running, so it was rebooted
+```
+
+A **running** machine is rebooted to apply the new size: a cold boot, so the
+disk survives and anything in RAM does not. A **stopped** machine takes it at
+its next start. A suspended or hibernated machine is refused, because its
+saved memory image is the old size — resume or wake it first.
+
+A create that names no size uses the org default (see
+[Organizations](#organizations-credentials-account)), and a fork always
+inherits its source's size.
+
 ### The `Machine` record
 
 ```python
@@ -556,6 +580,23 @@ delegation is actually live, for the same reason as per-machine domains
 above. A background check then verifies delegation and issues certs
 automatically, then flips `status` to `"active"`.
 
+An org also has a default machine size: what a `create` that names no size
+gets. It is a preference *below* the quota, not the quota itself — the quota
+stays the operator-owned ceiling and the per-request maximum. Setting or
+clearing it requires org admin; reading it doesn't.
+
+```python
+boxd.orgs.set_machine_defaults("acme", vcpu=2)     # or memory="8G"
+d = boxd.orgs.get_machine_defaults("acme")
+d.is_set                                           # False = no default; the values
+d.vcpu, d.memory_bytes                             # below are just the quota
+d.ceiling_vcpu, d.ceiling_memory_bytes             # the org quota
+boxd.orgs.clear_machine_defaults("acme")           # back to the quota
+```
+
+Only machines created afterwards are affected — every existing machine keeps
+the size it was created with. Omit the org to target your home org.
+
 ```python
 key = boxd.api_keys.create(
     "ci",

{boxd-0.2.5.dev47 → boxd-0.2.6.dev355}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "boxd"
-version = "0.2.5.dev47"
+version = "0.2.6.dev355"
 description = "Python SDK for the boxd cloud VM platform"
 readme = "README.md"
 license = "MIT"

{boxd-0.2.5.dev47 → boxd-0.2.6.dev355}/src/boxd/__init__.py

@@ -60,11 +60,13 @@ from .models import (
     MachineStatus,
     Org,
     OrgDomain,
+    OrgMachineDefaults,
     OrgRef,
     PauseResult,
     Proxy,
     ProxyEntry,
     ProxyPortMode,
+    ResizeResult,
     ResumeResult,
     Secret,
     Snapshot,
@@ -118,11 +120,13 @@ __all__ = [
     "MachineStatus",
     "Org",
     "OrgDomain",
+    "OrgMachineDefaults",
     "OrgRef",
     "PauseResult",
     "Proxy",
     "ProxyEntry",
     "ProxyPortMode",
+    "ResizeResult",
     "ResumeResult",
     "Secret",
     "Snapshot",