Skip to content

Commit 3f512b4

Browse files
committed
Reworked container image manifest page as well as the samples page.
1 parent 10609f5 commit 3f512b4

2 files changed

Lines changed: 15 additions & 5 deletions

File tree

docs/architecture/containers/container_image_manifest/index.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,9 @@ parent: Containers
55
nav_order: 1
66
---
77

8+
# Container Image Manifest
89

9-
The Container Image Manifest is a crucial component of Ocre containers, providing a comprehensive description of the container's structure and contents. It serves as the blueprint that defines and references the three main elements of an Ocre container described in the [Components](../components/index.md) section. The manifest ensures that all components can be correctly deployed and executed by the [Ocre Runtime](../../runtime).
10-
11-
Ocre container images follow the [Open Container Initiative (OCI)](https://opencontainers.org/) format where possible, with some modifications to support the needs of constrained, embedded devices. The manifest format is modeled after the [OCI Image Manifest](https://github.com/opencontainers/image-spec/blob/main/manifest.md) format and conforms to the [Wasm OCI Artifact](https://tag-runtime.cncf.io/wgs/wasm/deliverables/wasm-oci-artifact/) layout specifications. This structure ensures that all components of the container are properly defined, versioned, and can be efficiently managed in resource-constrained environments.
10+
The Container Image Manifest is a crucial component of Ocre containers, providing a comprehensive description of the container's structure and contents. It serves as the blueprint that defines and references the *three* main elements of an Ocre container: [*Container Configuration*](../components/container_configuration), a [*WebAssembly Module*](../components/webassembly_module), and (optional) [*Binary Objects*](../components/binary_objects). The manifest ensures that all components can be correctly deployed and executed by the [Ocre Runtime](../../runtime/overview/index.md).
1211

1312
---
1413

@@ -39,6 +38,7 @@ Here's an example of an Ocre Container Image Manifest:
3938
]
4039
}
4140
```
41+
---
4242

4343
### Configuration Parameters
4444

@@ -52,4 +52,10 @@ MUST be **2**.
5252
- `config` (*object*): References the configuration object for this container image. Schema follows the [OCI Content Descriptor schema](https://github.com/opencontainers/image-spec/blob/main/descriptor.md). It has the
5353
following restrictions:
5454
- `mediaType` must be set to **application/vnd.ocre.image.config.v1+json**.
55-
- `layers` (*array*): List of elements that comprise this container image. Each layer is a descriptor. One and only one layer MUST be of type **application/vnd.ocre.image.layer.v1.wasm** or **application/vnd.ocre.image.layer.v1.wasm+aot**.
55+
- `layers` (*array*): List of elements that comprise this container image. Each layer is a descriptor. One and only one layer MUST be of type **application/vnd.ocre.image.layer.v1.wasm** or **application/vnd.ocre.image.layer.v1.wasm+aot**.
56+
57+
---
58+
59+
### OCI Compliance
60+
61+
Ocre container images follow the [Open Container Initiative (OCI)](https://opencontainers.org/) format where possible, with some modifications to support the needs of constrained, embedded devices. The manifest format is modeled after the [OCI Image Manifest](https://github.com/opencontainers/image-spec/blob/main/manifest.md) format and conforms to the [Wasm OCI Artifact](https://tag-runtime.cncf.io/wgs/wasm/deliverables/wasm-oci-artifact/) layout specifications. This structure ensures that all components of the container are properly defined, versioned, and can be efficiently managed in resource-constrained environments.

docs/samples/index.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,5 +34,9 @@ To access and work with the samples:
3434
```bash
3535
cd ./samples/
3636
```
37-
From here, you can explore each sample's directory to view the source code and follow the individual build and deployment instructions on the following pages.
37+
From here, you can explore each of the samples to get a feel for how Ocre containers are created.
3838

39+
---
40+
41+
## Building and Deploying the Samples
42+
Once you're framiliar with the sample code, simply click the appropriate sample in the left sidebar to learn how to build and deploy it.

0 commit comments

Comments
 (0)