Skip to content

Commit e1e7bca

Browse files
committed
doc for min ver of each compose field
1 parent f21e23e commit e1e7bca

1 file changed

Lines changed: 20 additions & 19 deletions

File tree

docs/security-guide/cvm-boundaries.md

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -23,25 +23,26 @@ dstack OS requires a host shared folder to be attached to the CVM. It copies the
2323
### app-compose.json
2424
This is the main configuration file for the application in JSON format:
2525

26-
| Field | Type | Description |
27-
|-------|------|-------------|
28-
| manifest_version | integer | Schema version (currently defaults to "2") |
29-
| name | string | Name of the instance |
30-
| runner | string | Name of the runner (currently defaults to "docker-compose") |
31-
| docker_compose_file | string | YAML string representing docker-compose config |
32-
| docker_config | object | Additional docker settings (currently empty) |
33-
| kms_enabled | boolean | Enable/disable KMS |
34-
| gateway_enabled | boolean | Enable/disable gateway |
35-
| public_logs | boolean | Whether logs are publicly visible |
36-
| public_sysinfo | boolean | Whether system info is public |
37-
| public_tcbinfo | boolean | Whether TCB info is public |
38-
| local_key_provider_enabled | boolean | Use a local key provider |
39-
| allowed_envs | array of string | List of allowed environment variable names |
40-
| no_instance_id | boolean | Disable instance ID generation |
41-
| secure_time | boolean | Whether secure time is enabled |
42-
| pre_launch_script | string | Prelaunch bash script that runs before execute `docker compose up` |
43-
| init_script | string | Bash script that executed prior to dockerd startup |
44-
| storage_fs | string | Filesystem type for the data disk of the CVM. Supported values: "zfs", "ext4". default to "zfs". **ZFS:** Ensures filesystem integrity with built-in data protection features. **ext4:** Provides better performance for database applications with lower overhead and faster I/O operations, but no strong integrity protection. |
26+
| Field | Since | Type | Description |
27+
|-------|-------|------|-------------|
28+
| manifest_version | 0.3.1 | integer | Schema version (currently defaults to "2") |
29+
| name | 0.3.1 | string | Name of the instance |
30+
| runner | 0.3.1 | string | Name of the runner (currently defaults to "docker-compose") |
31+
| docker_compose_file | 0.3.1 | string | YAML string representing docker-compose config |
32+
| docker_config | 0.3.1 | object | Additional docker settings (currently empty) |
33+
| kms_enabled | 0.3.1 | boolean | Enable/disable KMS |
34+
| gateway_enabled | 0.3.1 | boolean | Enable/disable gateway |
35+
| local_key_provider_enabled | 0.3.1 | boolean | Use a local key provider |
36+
| public_logs | 0.3.3 | boolean | Whether logs are publicly visible |
37+
| public_sysinfo | 0.3.3 | boolean | Whether system info is public |
38+
| public_tcbinfo | 0.5.1 | boolean | Whether TCB info is public |
39+
| allowed_envs | 0.4.2 | array of string | List of allowed environment variable names |
40+
| no_instance_id | 0.4.2 | boolean | Disable instance ID generation |
41+
| secure_time | 0.5.0 | boolean | Whether secure time is enabled |
42+
| pre_launch_script | 0.4.0 | string | Prelaunch bash script that runs before execute `docker compose up` |
43+
| init_script | 0.5.5 | string | Bash script that executed prior to dockerd startup |
44+
| storage_fs | 0.5.5 | string | Filesystem type for the data disk of the CVM. Supported values: "zfs", "ext4". default to "zfs". **ZFS:** Ensures filesystem integrity with built-in data protection features. **ext4:** Provides better performance for database applications with lower overhead and faster I/O operations, but no strong integrity protection. |
45+
| swap_size | 0.5.5 | string/integer | The linux swap size. default to 0. Can be in byte or human-readable format (e.g., "1G", "256M"). |
4546

4647

4748
The hash of this file content is extended to RTMR3 as event name `compose-hash`. Remote verifier can extract the compose-hash during remote attestation.

0 commit comments

Comments
 (0)