Skip to content

Commit b608c6f

Browse files
committed
doc: fix package import path in sample code
fix package import path that was changed as part of v2 in sample code snippets. Signed-off-by: Akhil Mohan <[email protected]>
1 parent 7516bb9 commit b608c6f

File tree

6 files changed

+15
-15
lines changed

6 files changed

+15
-15
lines changed

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -109,8 +109,8 @@ import (
109109
"context"
110110

111111
containerd "github.com/containerd/containerd/v2/client"
112-
"github.com/containerd/containerd/v2/cio"
113-
"github.com/containerd/containerd/v2/namespaces"
112+
"github.com/containerd/containerd/v2/pkg/cio"
113+
"github.com/containerd/containerd/v2/pkg/namespaces"
114114
)
115115

116116

core/runtime/v2/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ the runtime engine, via `fork`/`exec` to run the container. For example, the `io
6767
an OCI compliant runtime engine such as `runc`.
6868

6969
containerd passes options to the shim over the ttRPC connection, which may include the runtime engine binary
70-
to invoke. These are the `options` for the [`CreateTaskRequest`](https://github.com/containerd/containerd/blob/main/runtime/v2/README.md#container-level-shim-configuration).
70+
to invoke. These are the `options` for the [`CreateTaskRequest`](#container-level-shim-configuration).
7171

7272
For example, the `io.containerd.runc.v2` shim supports including the path to the runtime engine binary.
7373

@@ -173,7 +173,7 @@ section:
173173
[plugins."io.containerd.grpc.v1.cri".containerd.runtimes]
174174
```
175175

176-
See [config.toml man page](../../docs/man/containerd-config.toml.5.md) for more details and an example.
176+
See [config.toml man page](../../../docs/man/containerd-config.toml.5.md) for more details and an example.
177177

178178
These "named runtimes" in the configuration file are used solely when invoked via CRI, which has a
179179
[`runtime_handler` field](https://github.com/kubernetes/cri-api/blob/de5f1318aede866435308f39cb432618a15f104e/pkg/apis/runtime/v1/api.proto#L476).
@@ -481,7 +481,7 @@ import (
481481
"io"
482482
"sync"
483483

484-
"github.com/containerd/containerd/runtime/v2/logging"
484+
"github.com/containerd/containerd/v2/core/runtime/v2/logging"
485485
"github.com/coreos/go-systemd/journal"
486486
)
487487

docs/PLUGINS.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ containerd to start and manage those containers using the runtime shim api retur
4444
the binary.
4545

4646
For more details on runtimes and shims, including how to invoke and configure them,
47-
see the [runtime v2 documentation](../runtime/v2/README.md)
47+
see the [runtime v2 documentation](../core/runtime/v2/README.md)
4848

4949
### Proxy Plugins
5050

@@ -92,7 +92,7 @@ import (
9292

9393
snapshotsapi "github.com/containerd/containerd/v2/api/services/snapshots/v1"
9494
"github.com/containerd/containerd/v2/contrib/snapshotservice"
95-
"github.com/containerd/containerd/v2/snapshots/native"
95+
"github.com/containerd/containerd/v2/plugins/snapshots/native"
9696
)
9797

9898
func main() {

docs/client-opts.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ If we want to make a `SpecOpt` to setup a container to monitor the host system w
6565
package monitor
6666

6767
import (
68-
"github.com/containerd/containerd/v2/oci"
68+
"github.com/containerd/containerd/v2/pkg/oci"
6969
specs "github.com/opencontainers/runtime-spec/specs-go"
7070
)
7171

docs/getting-started.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -253,7 +253,7 @@ import (
253253
"log"
254254

255255
containerd "github.com/containerd/containerd/v2/client"
256-
"github.com/containerd/containerd/v2/namespaces"
256+
"github.com/containerd/containerd/v2/pkg/namespaces"
257257
)
258258

259259
func main() {
@@ -328,8 +328,8 @@ import (
328328
"log"
329329

330330
containerd "github.com/containerd/containerd/v2/client"
331-
"github.com/containerd/containerd/v2/namespaces"
332-
"github.com/containerd/containerd/v2/oci"
331+
"github.com/containerd/containerd/v2/pkg/namespaces"
332+
"github.com/containerd/containerd/v2/pkg/oci"
333333
)
334334

335335
func main() {
@@ -474,10 +474,10 @@ import (
474474
"syscall"
475475
"time"
476476

477-
"github.com/containerd/containerd/v2/cio"
477+
"github.com/containerd/containerd/v2/pkg/cio"
478478
containerd "github.com/containerd/containerd/v2/client"
479-
"github.com/containerd/containerd/v2/oci"
480-
"github.com/containerd/containerd/v2/namespaces"
479+
"github.com/containerd/containerd/v2/pkg/oci"
480+
"github.com/containerd/containerd/v2/pkg/namespaces"
481481
)
482482

483483
func main() {

docs/remote-snapshotter.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ These user-defined labels must be prefixed by `containerd.io/snapshot/`.
4545
```go
4646
import (
4747
containerd "github.com/containerd/containerd/v2/client"
48-
"github.com/containerd/containerd/v2/snapshots"
48+
"github.com/containerd/containerd/v2/core/snapshots"
4949
)
5050

5151
image, err := client.Pull(ctx, ref,

0 commit comments

Comments
 (0)