Skip to content

Commit 4b07554

Browse files
committed
Add anchors to runtime
Signed-off-by: Mrunal Patel <[email protected]>
1 parent d01ef9a commit 4b07554

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

runtime.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
# Runtime and Lifecycle
1+
# <a name="runtimeAndLifecycle" />Runtime and Lifecycle
22

3-
## Scope of a Container
3+
## <a name="runtimeScopeContainer" />Scope of a Container
44

55
Barring access control concerns, the entity using a runtime to create a container MUST be able to use the operations defined in this specification against that same container.
66
Whether other entities using the same, or other, instance of the runtime can see that container is out of scope of this specification.
77

8-
## State
8+
## <a name="runtimeState" />State
99

1010
The state of a container includes the following properties:
1111

@@ -47,7 +47,7 @@ When serialized in JSON, the format MUST adhere to the following pattern:
4747

4848
See [Query State](#query-state) for information on retrieving the state of a container.
4949

50-
## Lifecycle
50+
## <a name="runtimeLifecycle" />Lifecycle
5151
The lifecycle describes the timeline of events that happen from when a container is created to when it ceases to exist.
5252

5353
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.
@@ -64,26 +64,26 @@ The lifecycle describes the timeline of events that happen from when a container
6464
6. Runtime's [`delete`](runtime.md#delete) command is invoked with the unique identifier of the container.
6565
The container MUST be destroyed by undoing the steps performed during create phase (step 2).
6666

67-
## Errors
67+
## <a name="runtimeErrors" />Errors
6868

6969
In cases where the specified operation generates an error, this specification does not mandate how, or even if, that error is returned or exposed to the user of an implementation.
7070
Unless otherwise stated, generating an error MUST leave the state of the environment as if the operation were never attempted - modulo any possible trivial ancillary changes such as logging.
7171

72-
## Operations
72+
## <a name="runtimeOperations" />Operations
7373

7474
OCI compliant runtimes MUST support the following operations, unless the operation is not supported by the base operating system.
7575

7676
Note: these operations are not specifying any command-line APIs, and the parameters are inputs for general operations.
7777

78-
### Query State
78+
### <a name="runtimeQueryState" />Query State
7979

8080
`state <container-id>`
8181

8282
This operation MUST generate an error if it is not provided the ID of a container.
8383
Attempting to query a container that does not exist MUST generate an error.
8484
This operation MUST return the state of a container as specified in the [State](#state) section.
8585

86-
### Create
86+
### <a name="runtimeCreate" />Create
8787

8888
`create <container-id> <path-to-bundle>`
8989

@@ -100,7 +100,7 @@ Runtime callers who are interested in pre-create validation can run [bundle-vali
100100

101101
Any changes made to the [`config.json`](config.md) file after this operation will not have an effect on the container.
102102

103-
### Start
103+
### <a name="runtimeStart" />Start
104104
`start <container-id>`
105105

106106
This operation MUST generate an error if it is not provided the container ID.
@@ -110,7 +110,7 @@ This operation MUST run the user-specified program as specified by [`process`](c
110110

111111
Upon successful completion of this operation the `status` property of this container MUST be `running`.
112112

113-
### Kill
113+
### <a name="runtimeKill" />Kill
114114
`kill <container-id> <signal>`
115115

116116
This operation MUST generate an error if it is not provided the container ID.
@@ -119,7 +119,7 @@ This operation MUST send the specified signal to the process in the container.
119119

120120
When the process in the container is stopped, irrespective of it being as a result of a `kill` operation or any other reason, the `status` property of this container MUST be `stopped`.
121121

122-
### Delete
122+
### <a name="runtimeDelete" />Delete
123123
`delete <container-id>`
124124

125125
This operation MUST generate an error if it is not provided the container ID.
@@ -130,6 +130,6 @@ Note that resources associated with the container, but not created by this conta
130130
Once a container is deleted its ID MAY be used by a subsequent container.
131131

132132

133-
## Hooks
133+
## <a name="runtimeHooks" />Hooks
134134
Many of the operations specified in this specification have "hooks" that allow for additional actions to be taken before or after each operation.
135135
See [runtime configuration for hooks](./config.md#hooks) for more information.

0 commit comments

Comments
 (0)