@fractal_cloud/sdk 1.2.0 → 1.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +29 -4
- package/dist/index.cjs +1760 -458
- package/dist/index.d.cts +530 -5
- package/dist/index.d.mts +530 -5
- package/dist/index.mjs +1615 -361
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -42,7 +42,7 @@ A Live System is a running instance of a Fractal. It maps each abstract blueprin
|
|
|
42
42
|
- Deployment of Live Systems to any Fractal Cloud Environment
|
|
43
43
|
- Personal and organisation-owned accounts
|
|
44
44
|
- **IaaS helpers** for AWS, Azure, GCP, OCI, and Hetzner
|
|
45
|
-
- **PaaS helpers** for AWS ECS (
|
|
45
|
+
- **PaaS helpers** for AWS (ECS, EKS), Azure (AKS, Container Apps Environment, Container Instance, Container App), GCP (GKE, Cloud Run), and OCI (Container Instance)
|
|
46
46
|
|
|
47
47
|
## Installation
|
|
48
48
|
|
|
@@ -222,7 +222,12 @@ The same blueprint can be deployed on any supported provider. Live system files
|
|
|
222
222
|
| `SecurityGroup` | `AwsSecurityGroup` | `AzureNsg` | `GcpFirewall` | `OciSecurityList` | `HetznerFirewall` |
|
|
223
223
|
| `VirtualMachine` | `Ec2Instance` | `AzureVm` | `GcpVm` | `OciInstance` | `HetznerServer` |
|
|
224
224
|
|
|
225
|
-
PaaS and CaaS helpers are also available for
|
|
225
|
+
PaaS and CaaS helpers are also available for the agnostic `ContainerPlatform` / `Workload` blueprint types, with provider-specific satisfiers across AWS, Azure, GCP, and OCI:
|
|
226
|
+
|
|
227
|
+
| Blueprint component | AWS | Azure | GCP | OCI |
|
|
228
|
+
|---------------------|-----|-------|-----|-----|
|
|
229
|
+
| `ContainerPlatform` | `AwsEcsCluster` · `AwsEksCluster` | `AzureAksCluster` · `AzureContainerAppsEnvironment` | `GcpGkeCluster` | — |
|
|
230
|
+
| `Workload` | `AwsEcsTaskDefinition` + `AwsEcsService` | `AzureContainerInstance` · `AzureContainerApp` | `GcpCloudRunService` | `OciContainerInstance` |
|
|
226
231
|
|
|
227
232
|
## Samples
|
|
228
233
|
|
|
@@ -231,7 +236,7 @@ The [sample repository](https://github.com/Fractal-Cloud/fractal-ts-sdk-samples)
|
|
|
231
236
|
| Sample | Description |
|
|
232
237
|
|--------|-------------|
|
|
233
238
|
| `basic_iaas` | VPC + Subnet + Security Group + two VMs — deploys on AWS, Azure, GCP, OCI, or Hetzner via `CLOUD_PROVIDER` env var |
|
|
234
|
-
| `basic_container_platform` |
|
|
239
|
+
| `basic_container_platform` | VPC + Subnet + Security Group + container platform + two workloads — deploys on AWS (ECS Fargate), Azure (Container Apps), or GCP (Cloud Run) via `CLOUD_PROVIDER` env var |
|
|
235
240
|
|
|
236
241
|
## Architecture
|
|
237
242
|
|
|
@@ -245,7 +250,27 @@ src/
|
|
|
245
250
|
live_system/ # Provider-specific helpers
|
|
246
251
|
component/
|
|
247
252
|
network_and_compute/iaas/ # AWS, Azure, GCP, OCI, Hetzner components
|
|
248
|
-
network_and_compute/paas/ #
|
|
253
|
+
network_and_compute/paas/ # AWS (ECS, EKS), Azure (AKS, Container Apps, Container Instance), GCP (GKE, Cloud Run), OCI (Container Instance)
|
|
254
|
+
```
|
|
255
|
+
|
|
256
|
+
## Debug logging
|
|
257
|
+
|
|
258
|
+
Set `FRACTAL_DEBUG=true` to log every outbound HTTP request and every inbound response to stdout. This covers all API calls made by `fractal.deploy()`, `liveSystem.deploy()`, `fractal.destroy()`, and `liveSystem.destroy()`.
|
|
259
|
+
|
|
260
|
+
```
|
|
261
|
+
[2026-03-11T14:23:00Z] DEBUG → GET https://api.fractal.cloud/livesystems/my-ls
|
|
262
|
+
[2026-03-11T14:23:00Z] DEBUG ← 404 GET https://api.fractal.cloud/livesystems/my-ls body=null
|
|
263
|
+
[2026-03-11T14:23:00Z] DEBUG → POST https://api.fractal.cloud/livesystems body={"liveSystemId":"..."}
|
|
264
|
+
[2026-03-11T14:23:00Z] DEBUG ← 201 POST https://api.fractal.cloud/livesystems body=null
|
|
265
|
+
```
|
|
266
|
+
|
|
267
|
+
- Authentication headers (`X-ClientID`, `X-ClientSecret`) are never logged.
|
|
268
|
+
- Request and response bodies are truncated to 2 000 characters.
|
|
269
|
+
- Both success and error responses are logged.
|
|
270
|
+
- Works in all deploy modes (`fire-and-forget` and `wait`).
|
|
271
|
+
|
|
272
|
+
```bash
|
|
273
|
+
FRACTAL_DEBUG=true node build/src/index.js
|
|
249
274
|
```
|
|
250
275
|
|
|
251
276
|
## Contributing and feedback
|