Skip to content

Latest commit

 

History

History
97 lines (66 loc) · 6.08 KB

filesystem_v1.md

File metadata and controls

97 lines (66 loc) · 6.08 KB
Raw

CSI Proxy FileSystem v1 API

Table of Contents

v1 FileSystem RPCs

Method Name Request Type Response Type Description
PathExists PathExistsRequest PathExistsResponse PathExists checks if the requested path exists in the host filesystem.
Mkdir MkdirRequest MkdirResponse Mkdir creates a directory at the requested path in the host filesystem.
Rmdir RmdirRequest RmdirResponse Rmdir removes the directory at the requested path in the host filesystem. This may be used for unlinking a symlink created through CreateSymlink.
CreateSymlink CreateSymlinkRequest CreateSymlinkResponse CreateSymlink creates a symbolic link called target_path that points to source_path in the host filesystem (target_path is the name of the symbolic link created, source_path is the existing path).
IsSymlink IsSymlinkRequest IsSymlinkResponse IsSymlink checks if a given path is a symlink.

Top

## v1 FileSystem Messages

CreateSymlinkRequest

Field Type Label Description
source_path string The path of the existing directory to be linked. All special characters allowed by Windows in path names will be allowed except for restrictions noted below. For details, please check: https://docs.microsoft.com/en-us/windows/win32/fileio/naming-a-file
target_path string Target path is the location of the new directory entry to be created in the host's filesystem. All special characters allowed by Windows in path names will be allowed except for restrictions noted below. For details, please check: https://docs.microsoft.com/en-us/windows/win32/fileio/naming-a-file

Restrictions: Only absolute path (indicated by a drive letter prefix: e.g. "C:") is accepted. The path prefix needs needs to match the paths specified as kubelet-path parameter of csi-proxy. UNC paths of the form "\server\share\path\file" are not allowed. All directory separators need to be backslash character: "". Characters: .. / : | ? * in the path are not allowed. source_path cannot already exist in the host filesystem. Maximum path length will be capped to 260 characters.

CreateSymlinkResponse

Intentionally empty.

IsSymlinkRequest

Field Type Label Description
path string The path whose existence as a symlink we want to check in the host's filesystem.

IsSymlinkResponse

Field Type Label Description
is_symlink bool Indicates whether the path in IsSymlinkRequest is a symlink.

MkdirRequest

Field Type Label Description
path string The path to create in the host's filesystem. All special characters allowed by Windows in path names will be allowed except for restrictions noted below. For details, please check: https://docs.microsoft.com/en-us/windows/win32/fileio/naming-a-file Non-existent parent directories in the path will be automatically created. Directories will be created with Read and Write privileges of the Windows User account under which csi-proxy is started (typically LocalSystem).

Restrictions: Only absolute path (indicated by a drive letter prefix: e.g. "C:") is accepted. Depending on the context parameter of this function, the path prefix needs to match the paths specified either as kubelet-csi-plugins-path or as kubelet-pod-path parameters of csi-proxy. The path parameter cannot already exist in the host's filesystem. UNC paths of the form "\server\share\path\file" are not allowed. All directory separators need to be backslash character: "". Characters: .. / : | ? * in the path are not allowed. Maximum path length will be capped to 260 characters.

MkdirResponse

Intentionally empty.

PathExistsRequest

Field Type Label Description
path string The path whose existence we want to check in the host's filesystem

PathExistsResponse

Field Type Label Description
exists bool Indicates whether the path in PathExistsRequest exists in the host's filesystem

RmdirRequest

Field Type Label Description
path string The path to remove in the host's filesystem. All special characters allowed by Windows in path names will be allowed except for restrictions noted below. For details, please check: https://docs.microsoft.com/en-us/windows/win32/fileio/naming-a-file
force bool Force remove all contents under path (if any).

Restrictions: Only absolute path (indicated by a drive letter prefix: e.g. "C:") is accepted. Depending on the context parameter of this function, the path prefix needs to match the paths specified either as kubelet-csi-plugins-path or as kubelet-pod-path parameters of csi-proxy. UNC paths of the form "\server\share\path\file" are not allowed. All directory separators need to be backslash character: "". Characters: .. / : | ? * in the path are not allowed. Path cannot be a file of type symlink. Maximum path length will be capped to 260 characters.

RmdirResponse

Intentionally empty.