Skip to content

Commit 1e7faf0

Browse files
author
Michael Crosby
authored
Merge pull request opencontainers#596 from WeiZhang555/add-related-links
Add some related docs links
2 parents 63467b2 + 98f0bdf commit 1e7faf0

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

runtime.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -46,18 +46,18 @@ See [Query State](#query-state) for information on retrieving the state of a con
4646
## Lifecycle
4747
The lifecycle describes the timeline of events that happen from when a container is created to when it ceases to exist.
4848

49-
1. OCI compliant runtime's `create` command is invoked with a reference to the location of the bundle and a unique identifier.
49+
1. OCI compliant runtime's [`create`](runtime.md#create) command is invoked with a reference to the location of the bundle and a unique identifier.
5050
2. The container's runtime environment MUST be created according to the configuration in [`config.json`](config.md).
5151
If the runtime is unable to create the environment specified in the [`config.json`](config.md), it MUST generate an error.
5252
While the resources requested in the [`config.json`](config.md) MUST be created, the user-specified code (from [`process`](config.md#process-configuration) MUST NOT be run at this time.
53-
Any updates to `config.json` after this step MUST NOT affect the container.
53+
Any updates to [`config.json`](config.md) after this step MUST NOT affect the container.
5454
3. Once the container is created additional actions MAY be performed based on the features the runtime chooses to support.
5555
However, some actions might only be available based on the current state of the container (e.g. only available while it is started).
56-
4. Runtime's `start` command is invoked with the unique identifier of the container.
56+
4. Runtime's [`start`](runtime.md#start) command is invoked with the unique identifier of the container.
5757
The runtime MUST run the user-specified code, as specified by [`process`](config.md#process-configuration).
5858
5. The container's process is stopped.
59-
This MAY happen due to them erroring out, exiting, crashing or the runtime's `kill` operation being invoked.
60-
6. Runtime's `delete` command is invoked with the unique identifier of the container.
59+
This MAY happen due to them erroring out, exiting, crashing or the runtime's [`kill`](runtime.md#kill) operation being invoked.
60+
6. Runtime's [`delete`](runtime.md#delete) command is invoked with the unique identifier of the container.
6161
The container MUST be destroyed by undoing the steps performed during create phase (step 2).
6262

6363
## Errors
@@ -87,7 +87,7 @@ This operation MUST generate an error if it is not provided a path to the bundle
8787
If the ID provided is not unique across all containers within the scope of the runtime, or is not valid in any other way, the implementation MUST generate an error and a new container MUST NOT be created.
8888
Using the data in [`config.json`](config.md), this operation MUST create a new container.
8989
This means that all of the resources associated with the container MUST be created, however, the user-specified code MUST NOT be run at this time.
90-
If the runtime cannot create the container as specified in `config.md`, it MUST generate an error and a new container MUST NOT be created.
90+
If the runtime cannot create the container as specified in [`config.md`](config.md), it MUST generate an error and a new container MUST NOT be created.
9191

9292
Upon successful completion of this operation the `status` property of this container MUST be `created`.
9393

0 commit comments

Comments
 (0)