From e1c553fee929542f812ba4596f33333fc2038846 Mon Sep 17 00:00:00 2001 From: "W. Trevor King" Date: Sun, 31 May 2015 15:15:44 -0700 Subject: [PATCH] docs/storagedrivers.md: Update filesystem.go -> driver.go reference Catch up after 88795e0a (Lots of various golint fixes, 2014-11-17, #1) and 65b0d73c (Move storagedriver package to registry/storage/driver, 2015-02-10, #167). Signed-off-by: W. Trevor King --- docs/storagedrivers.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/storagedrivers.md b/docs/storagedrivers.md index d18ea73bc..f0bba664c 100644 --- a/docs/storagedrivers.md +++ b/docs/storagedrivers.md @@ -41,7 +41,7 @@ To create a valid storage driver, one must implement the `storagedriver.StorageD Storage drivers should call `factory.Register` with their driver name in an `init` method, allowing callers of `factory.New` to construct instances of this driver without requiring modification of imports throughout the codebase. #### Out-of-process drivers -As many users will run the registry as a pre-constructed docker container, storage drivers should also be distributable as IPC server executables. Drivers written in go should model the main method provided in `storagedriver/filesystem/registry-storage-filesystem/filesystem.go`. Parameters to IPC drivers will be provided as a JSON-serialized map in the first argument to the process. These parameters should be validated and then a blocking call to `ipc.StorageDriverServer` should be made with a new storage driver. +As many users will run the registry as a pre-constructed docker container, storage drivers should also be distributable as IPC server executables. Drivers written in go should model the main method provided in `registry/storage/driverfilesystem/driver.go`. Parameters to IPC drivers will be provided as a JSON-serialized map in the first argument to the process. These parameters should be validated and then a blocking call to `ipc.StorageDriverServer` should be made with a new storage driver. Out-of-process drivers must also implement the `ipc.IPCStorageDriver` interface, which exposes a `Version` check for the storage driver. This is used to validate storage driver api compatibility at driver load-time.