Skip to content

Commit

Permalink
nydusify: update the doc of nydusify about the subcommand mount
Browse files Browse the repository at this point in the history
Signed-off-by: lihuahua123 <771725652@qq.com>
  • Loading branch information
lihuahua123 authored and imeoer committed Jun 25, 2023
1 parent ee433ab commit 65cf530
Showing 1 changed file with 24 additions and 2 deletions.
26 changes: 24 additions & 2 deletions docs/nydusify.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,13 +170,35 @@ nydusify check \
--backend-config-file /path/to/backend-config.json
```


## Mount the nydus image as a filesystem

The nydusify mount command can mount a nydus image stored in the backend as a filesystem. Now the supported backend types include Registry (default backend), s3 and oss.

When using Registy as the backend, you don't need specify the `--backend-type` .

``` shell
nydusify mount \
--target myregistry/repo:tag-nydus
```

Specify `--backend-type` and `--backend-config` options to mount for other backends::

``` shell
nydusify mount \
--target mybackend/repo:tag-nydus \
--backend-type oss \
--backend-config-file /path/to/backend-config.json
```


## More Nydusify Options

See `nydusify convert/check --help`
See `nydusify convert/check/mount --help`

## Use Nydusify as a package

``` golang
```
See `contrib/nydusify/examples/converter/main.go`
```

Expand Down

0 comments on commit 65cf530

Please sign in to comment.