From 65cf530f641ef199d0ff85d5a14889557a2a5deb Mon Sep 17 00:00:00 2001 From: lihuahua123 <771725652@qq.com> Date: Tue, 20 Jun 2023 16:45:47 +0800 Subject: [PATCH] nydusify: update the doc of nydusify about the subcommand mount Signed-off-by: lihuahua123 <771725652@qq.com> --- docs/nydusify.md | 26 ++++++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/docs/nydusify.md b/docs/nydusify.md index 0941c8f2cc4..53a6425fdbb 100644 --- a/docs/nydusify.md +++ b/docs/nydusify.md @@ -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` ```