Skip to content

Nerdctl as a library (documentation and API work) #4339

Open
@apostasie

Description

@apostasie

What is the problem you're trying to solve

See #4337 for context.

Building a simple cli that just runs a container is not trivial for newcomers, and certainly requires significant familiarity with nerdctl internals to get it to work.

Furthermore, the "API" is largely undocumented, and there are a number of extra things to implement on-top of using pkg (hooking of logging and oci-hooks).

Describe the solution you'd like

Suggesting:

  1. documentation
  2. express a better / simpler API hiding away some of the complexity

Additional context

No response

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions