containers
/
storage
mirror of https://github.com/containers/storage.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Finish renaming oci-storage to containers-storage 

Update the rest of the documentation, scripts, and output.

Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
This commit is contained in:
Nalin Dahyabhai 2017-06-02 13:45:06 -04:00
parent 8352d1aab6
commit 2036680a3a
43 changed files with 279 additions and 278 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -1,6 +1,6 @@
`storage` is a Go library which aims to provide methods for storing filesystem `storage` is a Go library which aims to provide methods for storing filesystem
layers, container images, and containers. An `oci-storage` CLI wrapper is also layers, container images, and containers. A `containers-storage` CLI wrapper
included for manual and scripting use. is also included for manual and scripting use.
To build the CLI wrapper, use 'make build-binary'. To build the CLI wrapper, use 'make build-binary'.

6
cmd/containers-storage/main.go
View File

@ -44,9 +44,9 @@ func main() {
return flags return flags
} }
flags := makeFlags("oci-storage", mflag.ContinueOnError) flags := makeFlags("containers-storage", mflag.ContinueOnError)
flags.Usage = func() { flags.Usage = func() {
fmt.Printf("Usage: oci-storage command [options [...]]\n\n") fmt.Printf("Usage: containers-storage command [options [...]]\n\n")
fmt.Printf("Commands:\n\n") fmt.Printf("Commands:\n\n")
for _, command := range commands { for _, command := range commands {
fmt.Printf(" %-22s%s\n", command.names[0], command.usage) fmt.Printf(" %-22s%s\n", command.names[0], command.usage)
@ -81,7 +81,7 @@ func main() {
command.addFlags(flags, &command) command.addFlags(flags, &command)
} }
flags.Usage = func() { flags.Usage = func() {
fmt.Printf("Usage: oci-storage %s %s\n\n", cmd, command.optionsHelp) fmt.Printf("Usage: containers-storage %s %s\n\n", cmd, command.optionsHelp)
fmt.Printf("%s\n", command.usage) fmt.Printf("%s\n", command.usage)
fmt.Printf("\nOptions:\n") fmt.Printf("\nOptions:\n")
flags.PrintDefaults() flags.PrintDefaults()

2
cmd/containers-storage/version.go
View File

@ -28,7 +28,7 @@ func version(flags *mflag.FlagSet, action string, m storage.Store, args []string
func init() { func init() {
commands = append(commands, command{ commands = append(commands, command{
names: []string{"version"}, names: []string{"version"},
usage: "Return oci-storage version information", usage: "Return containers-storage version information",
minArgs: 0, minArgs: 0,
action: version, action: version,
addFlags: func(flags *mflag.FlagSet, cmd *command) { addFlags: func(flags *mflag.FlagSet, cmd *command) {

12
docs/containers-storage-add-names.md
View File

@ -1,14 +1,14 @@
## oci-storage-add-names "August 2016" ## containers-storage-add-names "August 2016"
## NAME ## NAME
oci-storage add-names - Add names to a layer/image/container containers-storage add-names - Add names to a layer/image/container
## SYNOPSIS ## SYNOPSIS
**oci-storage** **add-names** [*options* [...]] *layerOrImageOrContainerNameOrID* **containers-storage** **add-names** [*options* [...]] *layerOrImageOrContainerNameOrID*
## DESCRIPTION ## DESCRIPTION
In addition to IDs, *layers*, *images*, and *containers* can have In addition to IDs, *layers*, *images*, and *containers* can have
human-readable names assigned to them in *oci-storage*. The *add-names* human-readable names assigned to them in *containers-storage*. The *add-names*
command can be used to add one or more names to them. command can be used to add one or more names to them.
## OPTIONS ## OPTIONS
@ -19,7 +19,7 @@ is already used by another layer, image, or container, it is removed from that
other layer, image, or container. other layer, image, or container.
## EXAMPLE ## EXAMPLE
**oci-storage add-names -n my-awesome-container -n my-for-realsies-awesome-container f3be6c6134d0d980936b4c894f1613b69a62b79588fdeda744d0be3693bde8ec** **containers-storage add-names -n my-awesome-container -n my-for-realsies-awesome-container f3be6c6134d0d980936b4c894f1613b69a62b79588fdeda744d0be3693bde8ec**
## SEE ALSO ## SEE ALSO
oci-storage-set-names(1) containers-storage-set-names(1)

16
docs/containers-storage-applydiff.md
View File

@ -1,10 +1,10 @@
## oci-storage-apply-diff 1 "August 2016" ## containers-storage-apply-diff 1 "August 2016"
## NAME ## NAME
oci-storage apply-diff - Apply a layer diff to a layer containers-storage apply-diff - Apply a layer diff to a layer
## SYNOPSIS ## SYNOPSIS
**oci-storage** **apply-diff** [*options* [...]] *layerNameOrID* [*referenceLayerNameOrID*] **containers-storage** **apply-diff** [*options* [...]] *layerNameOrID* [*referenceLayerNameOrID*]
## DESCRIPTION ## DESCRIPTION
When a layer is first created, it contains no changes relative to its parent When a layer is first created, it contains no changes relative to its parent
@ -12,7 +12,7 @@ layer. The layer can either be mounted read-write and its contents modified
directly, or contents can be added (or removed) by applying a layer diff. A directly, or contents can be added (or removed) by applying a layer diff. A
layer diff takes the form of a (possibly compressed) tar archive with layer diff takes the form of a (possibly compressed) tar archive with
additional information present in its headers, and can be produced by running additional information present in its headers, and can be produced by running
*oci-storage diff* or an equivalent. *containers-storage diff* or an equivalent.
Layer diffs are not typically applied manually. More often they are applied by Layer diffs are not typically applied manually. More often they are applied by
a tool which is being used to import an entire image, such as **skopeo**. a tool which is being used to import an entire image, such as **skopeo**.
@ -24,9 +24,9 @@ Specifies the name of a file from which the diff should be read. If this
option is not used, the diff is read from standard input. option is not used, the diff is read from standard input.
## EXAMPLE ## EXAMPLE
**oci-storage apply-diff -f 71841c97e320d6cde.tar.gz layer1** **containers-storage apply-diff -f 71841c97e320d6cde.tar.gz layer1**
## SEE ALSO ## SEE ALSO
oci-storage-changes(1) containers-storage-changes(1)
oci-storage-diff(1) containers-storage-diff(1)
oci-storage-diffsize(1) containers-storage-diffsize(1)

16
docs/containers-storage-changes.md
View File

@ -1,21 +1,21 @@
## oci-storage-changes 1 "August 2016" ## containers-storage-changes 1 "August 2016"
## NAME ## NAME
oci-storage changes - Produce a list of changes in a layer containers-storage changes - Produce a list of changes in a layer
## SYNOPSIS ## SYNOPSIS
**oci-storage** **changes** *layerNameOrID* [*referenceLayerNameOrID*] **containers-storage** **changes** *layerNameOrID* [*referenceLayerNameOrID*]
## DESCRIPTION ## DESCRIPTION
When a layer is first created, it contains no changes relative to its parent When a layer is first created, it contains no changes relative to its parent
layer. After that is changed, the *oci-storage changes* command can be used to layer. After that is changed, the *containers-storage changes* command can be used to
obtain a summary of which files have been added, deleted, or modified in the obtain a summary of which files have been added, deleted, or modified in the
layer. layer.
## EXAMPLE ## EXAMPLE
**oci-storage changes f3be6c6134d0d980936b4c894f1613b69a62b79588fdeda744d0be3693bde8ec** **containers-storage changes f3be6c6134d0d980936b4c894f1613b69a62b79588fdeda744d0be3693bde8ec**
## SEE ALSO ## SEE ALSO
oci-storage-applydiff(1) containers-storage-applydiff(1)
oci-storage-diff(1) containers-storage-diff(1)
oci-storage-diffsize(1) containers-storage-diffsize(1)

12
docs/containers-storage-container.md
View File

@ -1,18 +1,18 @@
## oci-storage-container 1 "August 2016" ## containers-storage-container 1 "August 2016"
## NAME ## NAME
oci-storage container - Examine a single container containers-storage container - Examine a single container
## SYNOPSIS ## SYNOPSIS
**oci-storage** **container** *containerNameOrID* **containers-storage** **container** *containerNameOrID*
## DESCRIPTION ## DESCRIPTION
Retrieve information about a container: any names it has, which image was used Retrieve information about a container: any names it has, which image was used
to create it, any names that image has, and the ID of the container's layer. to create it, any names that image has, and the ID of the container's layer.
## EXAMPLE ## EXAMPLE
**oci-storage container f3be6c6134d0d980936b4c894f1613b69a62b79588fdeda744d0be3693bde8ec** **containers-storage container f3be6c6134d0d980936b4c894f1613b69a62b79588fdeda744d0be3693bde8ec**
**oci-storage container my-awesome-container** **containers-storage container my-awesome-container**
## SEE ALSO ## SEE ALSO
oci-storage-containers(1) containers-storage-containers(1)

10
docs/containers-storage-containers.md
View File

@ -1,16 +1,16 @@
## oci-storage-containers 1 "August 2016" ## containers-storage-containers 1 "August 2016"
## NAME ## NAME
oci-storage containers - List known containers containers-storage containers - List known containers
## SYNOPSIS ## SYNOPSIS
**oci-storage** **containers** **containers-storage** **containers**
## DESCRIPTION ## DESCRIPTION
Retrieves information about all known containers and lists their IDs and names. Retrieves information about all known containers and lists their IDs and names.
## EXAMPLE ## EXAMPLE
**oci-storage containers** **containers-storage containers**
## SEE ALSO ## SEE ALSO
oci-storage-container(1) containers-storage-container(1)

14
docs/containers-storage-create-container.md
View File

@ -1,10 +1,10 @@
## oci-storage-create-container 1 "August 2016" ## containers-storage-create-container 1 "August 2016"
## NAME ## NAME
oci-storage create-container - Create a container containers-storage create-container - Create a container
## SYNOPSIS ## SYNOPSIS
**oci-storage** **create-container** [*options*...] *imageNameOrID* **containers-storage** **create-container** [*options*...] *imageNameOrID*
## DESCRIPTION ## DESCRIPTION
Creates a container, using the specified image as the starting point for its Creates a container, using the specified image as the starting point for its
@ -29,9 +29,9 @@ Sets the metadata for the container to the specified value.
Sets the metadata for the container to the contents of the specified file. Sets the metadata for the container to the contents of the specified file.
## EXAMPLE ## EXAMPLE
**oci-storage create-container -f manifest.json -n new-container goodimage** **containers-storage create-container -f manifest.json -n new-container goodimage**
## SEE ALSO ## SEE ALSO
oci-storage-create-image(1) containers-storage-create-image(1)
oci-storage-create-layer(1) containers-storage-create-layer(1)
oci-storage-delete-container(1) containers-storage-delete-container(1)

14
docs/containers-storage-create-image.md
View File

@ -1,10 +1,10 @@
## oci-storage-create-image 1 "August 2016" ## containers-storage-create-image 1 "August 2016"
## NAME ## NAME
oci-storage create-image - Create an image containers-storage create-image - Create an image
## SYNOPSIS ## SYNOPSIS
**oci-storage** **create-image** [*options*...] *topLayerNameOrID* **containers-storage** **create-image** [*options*...] *topLayerNameOrID*
## DESCRIPTION ## DESCRIPTION
Creates an image, referring to the specified layer as the one which should be Creates an image, referring to the specified layer as the one which should be
@ -29,9 +29,9 @@ Sets the metadata for the image to the specified value.
Sets the metadata for the image to the contents of the specified file. Sets the metadata for the image to the contents of the specified file.
## EXAMPLE ## EXAMPLE
**oci-storage create-image -f manifest.json -n new-image somelayer** **containers-storage create-image -f manifest.json -n new-image somelayer**
## SEE ALSO ## SEE ALSO
oci-storage-create-container(1) containers-storage-create-container(1)
oci-storage-create-layer(1) containers-storage-create-layer(1)
oci-storage-delete-image(1) containers-storage-delete-image(1)

14
docs/containers-storage-create-layer.md
View File

@ -1,10 +1,10 @@
## oci-storage-create-layer 1 "August 2016" ## containers-storage-create-layer 1 "August 2016"
## NAME ## NAME
oci-storage create-layer - Create a layer containers-storage create-layer - Create a layer
## SYNOPSIS ## SYNOPSIS
**oci-storage** **create-layer** [*options* [...]] [*parentLayerNameOrID*] **containers-storage** **create-layer** [*options* [...]] [*parentLayerNameOrID*]
## DESCRIPTION ## DESCRIPTION
Creates a new layer which either has a specified layer as its parent, or if no Creates a new layer which either has a specified layer as its parent, or if no
@ -34,9 +34,9 @@ Sets the label which should be assigned as an SELinux context when mounting the
layer. layer.
## EXAMPLE ## EXAMPLE
**oci-storage create-layer -f manifest.json -n new-layer somelayer** **containers-storage create-layer -f manifest.json -n new-layer somelayer**
## SEE ALSO ## SEE ALSO
oci-storage-create-container(1) containers-storage-create-container(1)
oci-storage-create-image(1) containers-storage-create-image(1)
oci-storage-delete-layer(1) containers-storage-delete-layer(1)

14
docs/containers-storage-delete-container.md
View File

@ -1,18 +1,18 @@
## oci-storage-delete-container 1 "August 2016" ## containers-storage-delete-container 1 "August 2016"
## NAME ## NAME
oci-storage delete-container - Delete a container containers-storage delete-container - Delete a container
## SYNOPSIS ## SYNOPSIS
**oci-storage** **delete-container** *containerNameOrID* **containers-storage** **delete-container** *containerNameOrID*
## DESCRIPTION ## DESCRIPTION
Deletes a container and its layer. Deletes a container and its layer.
## EXAMPLE ## EXAMPLE
**oci-storage delete-container my-awesome-container** **containers-storage delete-container my-awesome-container**
## SEE ALSO ## SEE ALSO
oci-storage-create-container(1) containers-storage-create-container(1)
oci-storage-delete-image(1) containers-storage-delete-image(1)
oci-storage-delete-layer(1) containers-storage-delete-layer(1)

14
docs/containers-storage-delete-image.md
View File

@ -1,10 +1,10 @@
## oci-storage-delete-image 1 "August 2016" ## containers-storage-delete-image 1 "August 2016"
## NAME ## NAME
oci-storage delete-image - Delete an image containers-storage delete-image - Delete an image
## SYNOPSIS ## SYNOPSIS
**oci-storage** **delete-image** *imageNameOrID* **containers-storage** **delete-image** *imageNameOrID*
## DESCRIPTION ## DESCRIPTION
Deletes an image if it is not currently being used by any containers. If the Deletes an image if it is not currently being used by any containers. If the
@ -13,9 +13,9 @@ If that image's parent is then not being used by other images, it, too, will be
removed, and the this will be repeated for each parent's parent. removed, and the this will be repeated for each parent's parent.
## EXAMPLE ## EXAMPLE
**oci-storage delete-image my-base-image** **containers-storage delete-image my-base-image**
## SEE ALSO ## SEE ALSO
oci-storage-create-image(1) containers-storage-create-image(1)
oci-storage-delete-container(1) containers-storage-delete-container(1)
oci-storage-delete-layer(1) containers-storage-delete-layer(1)

14
docs/containers-storage-delete-layer.md
View File

@ -1,19 +1,19 @@
## oci-storage-delete-layer 1 "August 2016" ## containers-storage-delete-layer 1 "August 2016"
## NAME ## NAME
oci-storage delete-layer - Delete a layer containers-storage delete-layer - Delete a layer
## SYNOPSIS ## SYNOPSIS
**oci-storage** **delete-layer** *layerNameOrID* **containers-storage** **delete-layer** *layerNameOrID*
## DESCRIPTION ## DESCRIPTION
Deletes a layer if it is not currently being used by any images or containers, Deletes a layer if it is not currently being used by any images or containers,
and is not the parent of any other layers. and is not the parent of any other layers.
## EXAMPLE ## EXAMPLE
**oci-storage delete-layer my-base-layer** **containers-storage delete-layer my-base-layer**
## SEE ALSO ## SEE ALSO
oci-storage-create-layer(1) containers-storage-create-layer(1)
oci-storage-delete-image(1) containers-storage-delete-image(1)
oci-storage-delete-layer(1) containers-storage-delete-layer(1)

14
docs/containers-storage-delete.md
View File

@ -1,19 +1,19 @@
## oci-storage-delete 1 "August 2016" ## containers-storage-delete 1 "August 2016"
## NAME ## NAME
oci-storage delete - Force deletion of a layer, image, or container containers-storage delete - Force deletion of a layer, image, or container
## SYNOPSIS ## SYNOPSIS
**oci-storage** **delete** *layerOrImageOrContainerNameOrID* **containers-storage** **delete** *layerOrImageOrContainerNameOrID*
## DESCRIPTION ## DESCRIPTION
Deletes a specified layer, image, or container, with no safety checking. This Deletes a specified layer, image, or container, with no safety checking. This
can corrupt data, and may be removed. can corrupt data, and may be removed.
## EXAMPLE ## EXAMPLE
**oci-storage delete my-base-layer** **containers-storage delete my-base-layer**
## SEE ALSO ## SEE ALSO
oci-storage-delete-container(1) containers-storage-delete-container(1)
oci-storage-delete-image(1) containers-storage-delete-image(1)
oci-storage-delete-layer(1) containers-storage-delete-layer(1)

14
docs/containers-storage-diff.md
View File

@ -1,10 +1,10 @@
## oci-storage-diff 1 "August 2016" ## containers-storage-diff 1 "August 2016"
## NAME ## NAME
oci-storage diff - Generate a layer diff containers-storage diff - Generate a layer diff
## SYNOPSIS ## SYNOPSIS
**oci-storage** **diff** [*options* [...]] *layerNameOrID* **containers-storage** **diff** [*options* [...]] *layerNameOrID*
## DESCRIPTION ## DESCRIPTION
Generates a layer diff representing the changes made in the specified layer. Generates a layer diff representing the changes made in the specified layer.
@ -29,9 +29,9 @@ Force the diff to be uncompressed. If the layer was populated by a layer diff,
and that layer diff was compressed, it will be decompressed for output. and that layer diff was compressed, it will be decompressed for output.
## EXAMPLE ## EXAMPLE
**oci-storage diff my-base-layer** **containers-storage diff my-base-layer**
## SEE ALSO ## SEE ALSO
oci-storage-applydiff(1) containers-storage-applydiff(1)
oci-storage-changes(1) containers-storage-changes(1)
oci-storage-diffsize(1) containers-storage-diffsize(1)

14
docs/containers-storage-diffsize.md
View File

@ -1,19 +1,19 @@
## oci-storage-diffsize 1 "August 2016" ## containers-storage-diffsize 1 "August 2016"
## NAME ## NAME
oci-storage diffsize - Compute the size of a layer diff containers-storage diffsize - Compute the size of a layer diff
## SYNOPSIS ## SYNOPSIS
**oci-storage** **diffsize** *layerNameOrID* **containers-storage** **diffsize** *layerNameOrID*
## DESCRIPTION ## DESCRIPTION
Computes the expected size of the layer diff which would be generated for the Computes the expected size of the layer diff which would be generated for the
specified layer. specified layer.
## EXAMPLE ## EXAMPLE
**oci-storage diffsize my-base-layer** **containers-storage diffsize my-base-layer**
## SEE ALSO ## SEE ALSO
oci-storage-applydiff(1) containers-storage-applydiff(1)
oci-storage-changes(1) containers-storage-changes(1)
oci-storage-diff(1) containers-storage-diff(1)

8
docs/containers-storage-exists.md
View File

@ -1,10 +1,10 @@
## oci-storage-exists 1 "August 2016" ## containers-storage-exists 1 "August 2016"
## NAME ## NAME
oci-storage exists - Check if a layer, image, or container exists containers-storage exists - Check if a layer, image, or container exists
## SYNOPSIS ## SYNOPSIS
**oci-storage** **exists** [*options* [...]] *layerOrImageOrContainerNameOrID* [...] **containers-storage** **exists** [*options* [...]] *layerOrImageOrContainerNameOrID* [...]
## DESCRIPTION ## DESCRIPTION
Checks if there are layers, images, or containers which have the specified Checks if there are layers, images, or containers which have the specified
@ -28,4 +28,4 @@ Only succeed if the names or IDs are that of layers.
Suppress output. Suppress output.
## EXAMPLE ## EXAMPLE
**oci-storage exists my-base-layer** **containers-storage exists my-base-layer**

12
docs/containers-storage-get-container-data.md
View File

@ -1,10 +1,10 @@
## oci-storage-get-container-data 1 "August 2016" ## containers-storage-get-container-data 1 "August 2016"
## NAME ## NAME
oci-storage get-container-data - Retrieve lookaside data for a container containers-storage get-container-data - Retrieve lookaside data for a container
## SYNOPSIS ## SYNOPSIS
**oci-storage** **get-container-data** [*options* [...]] *containerNameOrID* *dataName* **containers-storage** **get-container-data** [*options* [...]] *containerNameOrID* *dataName*
## DESCRIPTION ## DESCRIPTION
Retrieves a piece of named data which is associated with a container. Retrieves a piece of named data which is associated with a container.
@ -15,8 +15,8 @@ Retrieves a piece of named data which is associated with a container.
Write the data to a file instead of stdout. Write the data to a file instead of stdout.
## EXAMPLE ## EXAMPLE
**oci-storage get-container-data -f config.json my-container configuration** **containers-storage get-container-data -f config.json my-container configuration**
## SEE ALSO ## SEE ALSO
oci-storage-list-container-data(1) containers-storage-list-container-data(1)
oci-storage-set-container-data(1) containers-storage-set-container-data(1)

10
docs/containers-storage-get-container-dir.md
View File

@ -1,17 +1,17 @@
## oci-storage-get-container-dir 1 "Sepember 2016" ## containers-storage-get-container-dir 1 "Sepember 2016"
## NAME ## NAME
oci-storage get-container-dir - Find lookaside directory for a container containers-storage get-container-dir - Find lookaside directory for a container
## SYNOPSIS ## SYNOPSIS
**oci-storage** **get-container-dir** [*options* [...]] *containerNameOrID* **containers-storage** **get-container-dir** [*options* [...]] *containerNameOrID*
## DESCRIPTION ## DESCRIPTION
Prints the location of a directory which the caller can use to store lookaside Prints the location of a directory which the caller can use to store lookaside
information which should be cleaned up when the container is deleted. information which should be cleaned up when the container is deleted.
## EXAMPLE ## EXAMPLE
**oci-storage get-container-dir my-container** **containers-storage get-container-dir my-container**
## SEE ALSO ## SEE ALSO
oci-storage-get-container-run-dir(1) containers-storage-get-container-run-dir(1)

10
docs/containers-storage-get-container-run-dir.md
View File

@ -1,17 +1,17 @@
## oci-storage-get-container-run-dir 1 "Sepember 2016" ## containers-storage-get-container-run-dir 1 "Sepember 2016"
## NAME ## NAME
oci-storage get-container-run-dir - Find runtime lookaside directory for a container containers-storage get-container-run-dir - Find runtime lookaside directory for a container
## SYNOPSIS ## SYNOPSIS
**oci-storage** **get-container-run-dir** [*options* [...]] *containerNameOrID* **containers-storage** **get-container-run-dir** [*options* [...]] *containerNameOrID*
## DESCRIPTION ## DESCRIPTION
Prints the location of a directory which the caller can use to store lookaside Prints the location of a directory which the caller can use to store lookaside
information which should be cleaned up when the host is rebooted. information which should be cleaned up when the host is rebooted.
## EXAMPLE ## EXAMPLE
**oci-storage get-container-run-dir my-container** **containers-storage get-container-run-dir my-container**
## SEE ALSO ## SEE ALSO
oci-storage-get-container-dir(1) containers-storage-get-container-dir(1)

12
docs/containers-storage-get-image-data.md
View File

@ -1,10 +1,10 @@
## oci-storage-get-image-data 1 "August 2016" ## containers-storage-get-image-data 1 "August 2016"
## NAME ## NAME
oci-storage get-image-data - Retrieve lookaside data for an image containers-storage get-image-data - Retrieve lookaside data for an image
## SYNOPSIS ## SYNOPSIS
**oci-storage** **get-image-data** [*options* [...]] *imageNameOrID* *dataName* **containers-storage** **get-image-data** [*options* [...]] *imageNameOrID* *dataName*
## DESCRIPTION ## DESCRIPTION
Retrieves a piece of named data which is associated with an image. Retrieves a piece of named data which is associated with an image.
@ -15,8 +15,8 @@ Retrieves a piece of named data which is associated with an image.
Write the data to a file instead of stdout. Write the data to a file instead of stdout.
## EXAMPLE ## EXAMPLE
**oci-storage get-image-data -f manifest.json my-image manifest** **containers-storage get-image-data -f manifest.json my-image manifest**
## SEE ALSO ## SEE ALSO
oci-storage-list-image-data(1) containers-storage-list-image-data(1)
oci-storage-set-image-data(1) containers-storage-set-image-data(1)

12
docs/containers-storage-image.md
View File

@ -1,18 +1,18 @@
## oci-storage-image 1 "August 2016" ## containers-storage-image 1 "August 2016"
## NAME ## NAME
oci-storage image - Examine a single image containers-storage image - Examine a single image
## SYNOPSIS ## SYNOPSIS
**oci-storage** **image** *imageNameOrID* **containers-storage** **image** *imageNameOrID*
## DESCRIPTION ## DESCRIPTION
Retrieve information about an image: its ID, any names it has, and the ID of Retrieve information about an image: its ID, any names it has, and the ID of
its top layer. its top layer.
## EXAMPLE ## EXAMPLE
**oci-storage image 49bff34e4baf9378c01733d02276a731a4c4771ebeab305020c5303679f88bb8** **containers-storage image 49bff34e4baf9378c01733d02276a731a4c4771ebeab305020c5303679f88bb8**
**oci-storage image my-favorite-image** **containers-storage image my-favorite-image**
## SEE ALSO ## SEE ALSO
oci-storage-images(1) containers-storage-images(1)

10
docs/containers-storage-images.md
View File

@ -1,16 +1,16 @@
## oci-storage-images 1 "August 2016" ## containers-storage-images 1 "August 2016"
## NAME ## NAME
oci-storage images - List known images containers-storage images - List known images
## SYNOPSIS ## SYNOPSIS
**oci-storage** **images** **containers-storage** **images**
## DESCRIPTION ## DESCRIPTION
Retrieves information about all known images and lists their IDs and names. Retrieves information about all known images and lists their IDs and names.
## EXAMPLE ## EXAMPLE
**oci-storage images** **containers-storage images**
## SEE ALSO ## SEE ALSO
oci-storage-image(1) containers-storage-image(1)

10
docs/containers-storage-layers.md
View File

@ -1,10 +1,10 @@
## oci-storage-layers 1 "August 2016" ## containers-storage-layers 1 "August 2016"
## NAME ## NAME
oci-storage layers - List known layers containers-storage layers - List known layers
## SYNOPSIS ## SYNOPSIS
**oci-storage** [*options* [...]] **layers** **containers-storage** [*options* [...]] **layers**
## DESCRIPTION ## DESCRIPTION
Retrieves information about all known layers and lists their IDs and names, the Retrieves information about all known layers and lists their IDs and names, the
@ -19,5 +19,5 @@ Display results using a tree to show the hierarchy of parent-child
relationships between layers. relationships between layers.
## EXAMPLE ## EXAMPLE
**oci-storage layers** **containers-storage layers**
**oci-storage layers -t** **containers-storage layers -t**

12
docs/containers-storage-list-container-data.md
View File

@ -1,17 +1,17 @@
## oci-storage-list-container-data 1 "August 2016" ## containers-storage-list-container-data 1 "August 2016"
## NAME ## NAME
oci-storage list-container-data - List lookaside data for a container containers-storage list-container-data - List lookaside data for a container
## SYNOPSIS ## SYNOPSIS
**oci-storage** **list-container-data** *containerNameOrID* **containers-storage** **list-container-data** *containerNameOrID*
## DESCRIPTION ## DESCRIPTION
List the pieces of named data which are associated with a container. List the pieces of named data which are associated with a container.
## EXAMPLE ## EXAMPLE
**oci-storage list-container-data my-container** **containers-storage list-container-data my-container**
## SEE ALSO ## SEE ALSO
oci-storage-get-container-data(1) containers-storage-get-container-data(1)
oci-storage-set-container-data(1) containers-storage-set-container-data(1)

12
docs/containers-storage-list-image-data.md
View File

@ -1,17 +1,17 @@
## oci-storage-list-image-data 1 "August 2016" ## containers-storage-list-image-data 1 "August 2016"
## NAME ## NAME
oci-storage list-image-data - List lookaside data for an image containers-storage list-image-data - List lookaside data for an image
## SYNOPSIS ## SYNOPSIS
**oci-storage** **list-image-data** *imageNameOrID* **containers-storage** **list-image-data** *imageNameOrID*
## DESCRIPTION ## DESCRIPTION
List the pieces of named data which are associated with an image. List the pieces of named data which are associated with an image.
## EXAMPLE ## EXAMPLE
**oci-storage list-image-data my-image** **containers-storage list-image-data my-image**
## SEE ALSO ## SEE ALSO
oci-storage-get-image-data(1) containers-storage-get-image-data(1)
oci-storage-list-image-data(1) containers-storage-list-image-data(1)

10
docs/containers-storage-metadata.md
View File

@ -1,10 +1,10 @@
## oci-storage-metadata 1 "August 2016" ## containers-storage-metadata 1 "August 2016"
## NAME ## NAME
oci-storage metadata - Retrieve metadata for a layer, image, or container containers-storage metadata - Retrieve metadata for a layer, image, or container
## SYNOPSIS ## SYNOPSIS
**oci-storage** **metadata** [*options* [...]] *layerOrImageOrContainerNameOrID* **containers-storage** **metadata** [*options* [...]] *layerOrImageOrContainerNameOrID*
## DESCRIPTION ## DESCRIPTION
Outputs metadata associated with a layer, image, or container. Metadata is Outputs metadata associated with a layer, image, or container. Metadata is
@ -16,7 +16,7 @@ intended to be small, and is expected to be cached in memory.
Don't print the ID or name of the item with which the metadata is associated. Don't print the ID or name of the item with which the metadata is associated.
## EXAMPLE ## EXAMPLE
**oci-storage metadata -q my-image > my-image.txt** **containers-storage metadata -q my-image > my-image.txt**
## SEE ALSO ## SEE ALSO
oci-storage-set-metadata(1) containers-storage-set-metadata(1)

10
docs/containers-storage-mount.md
View File

@ -1,10 +1,10 @@
## oci-storage-mount 1 "August 2016" ## containers-storage-mount 1 "August 2016"
## NAME ## NAME
oci-storage mount - Mount a layer or a container's layer for manipulation containers-storage mount - Mount a layer or a container's layer for manipulation
## SYNOPSIS ## SYNOPSIS
**oci-storage** **mount** [*options* [...]] *layerOrContainerNameOrID* **containers-storage** **mount** [*options* [...]] *layerOrContainerNameOrID*
## DESCRIPTION ## DESCRIPTION
Mounts a layer or a container's layer on the host's filesystem and prints the Mounts a layer or a container's layer on the host's filesystem and prints the
@ -16,7 +16,7 @@ mountpoint.
Specify an SELinux context for the mounted layer. Specify an SELinux context for the mounted layer.
## EXAMPLE ## EXAMPLE
**oci-storage mount my-container** **containers-storage mount my-container**
## SEE ALSO ## SEE ALSO
oci-storage-unmount(1) containers-storage-unmount(1)

12
docs/containers-storage-set-container-data.md
View File

@ -1,10 +1,10 @@
## oci-storage-set-container-data 1 "August 2016" ## containers-storage-set-container-data 1 "August 2016"
## NAME ## NAME
oci-storage set-container-data - Set lookaside data for a container containers-storage set-container-data - Set lookaside data for a container
## SYNOPSIS ## SYNOPSIS
**oci-storage** **set-container-data** [*options* [...]] *containerNameOrID* *dataName* **containers-storage** **set-container-data** [*options* [...]] *containerNameOrID* *dataName*
## DESCRIPTION ## DESCRIPTION
Sets a piece of named data which is associated with a container. Sets a piece of named data which is associated with a container.
@ -15,8 +15,8 @@ Sets a piece of named data which is associated with a container.
Read the data contents from a file instead of stdin. Read the data contents from a file instead of stdin.
## EXAMPLE ## EXAMPLE
**oci-storage set-container-data -f ./config.json my-container configuration** **containers-storage set-container-data -f ./config.json my-container configuration**
## SEE ALSO ## SEE ALSO
oci-storage-get-container-data(1) containers-storage-get-container-data(1)
oci-storage-list-container-data(1) containers-storage-list-container-data(1)

12
docs/containers-storage-set-image-data.md
View File

@ -1,10 +1,10 @@
## oci-storage-set-image-data 1 "August 2016" ## containers-storage-set-image-data 1 "August 2016"
## NAME ## NAME
oci-storage set-image-data - Set lookaside data for an image containers-storage set-image-data - Set lookaside data for an image
## SYNOPSIS ## SYNOPSIS
**oci-storage** **set-image-data** [*options* [...]] *imageNameOrID* *dataName* **containers-storage** **set-image-data** [*options* [...]] *imageNameOrID* *dataName*
## DESCRIPTION ## DESCRIPTION
Sets a piece of named data which is associated with an image. Sets a piece of named data which is associated with an image.
@ -15,8 +15,8 @@ Sets a piece of named data which is associated with an image.
Read the data contents from a file instead of stdin. Read the data contents from a file instead of stdin.
## EXAMPLE ## EXAMPLE
**oci-storage set-image-data -f ./manifest.json my-image manifest** **containers-storage set-image-data -f ./manifest.json my-image manifest**
## SEE ALSO ## SEE ALSO
oci-storage-get-image-data(1) containers-storage-get-image-data(1)
oci-storage-list-image-data(1) containers-storage-list-image-data(1)

10
docs/containers-storage-set-metadata.md
View File

@ -1,10 +1,10 @@
## oci-storage-set-metadata 1 "August 2016" ## containers-storage-set-metadata 1 "August 2016"
## NAME ## NAME
oci-storage set-metadata - Set metadata for a layer, image, or container containers-storage set-metadata - Set metadata for a layer, image, or container
## SYNOPSIS ## SYNOPSIS
**oci-storage** **set-metadata** [*options* [...]] *layerOrImageOrContainerNameOrID* **containers-storage** **set-metadata** [*options* [...]] *layerOrImageOrContainerNameOrID*
## DESCRIPTION ## DESCRIPTION
Updates the metadata associated with a layer, image, or container. Metadata is Updates the metadata associated with a layer, image, or container. Metadata is
@ -20,7 +20,7 @@ Use the contents of the specified file as the metadata.
Use the specified value as the metadata. Use the specified value as the metadata.
## EXAMPLE ## EXAMPLE
**oci-storage set-metadata -m "compression: gzip" my-layer** **containers-storage set-metadata -m "compression: gzip" my-layer**
## SEE ALSO ## SEE ALSO
oci-storage-metadata(1) containers-storage-metadata(1)

12
docs/containers-storage-set-names.md
View File

@ -1,14 +1,14 @@
## oci-storage-set-names 1 "August 2016" ## containers-storage-set-names 1 "August 2016"
## NAME ## NAME
oci-storage set-names - Set names for a layer/image/container containers-storage set-names - Set names for a layer/image/container
## SYNOPSIS ## SYNOPSIS
**oci-storage** **set-names** [**-n** *name* [...]] *layerOrImageOrContainerNameOrID* **containers-storage** **set-names** [**-n** *name* [...]] *layerOrImageOrContainerNameOrID*
## DESCRIPTION ## DESCRIPTION
In addition to IDs, *layers*, *images*, and *containers* can have In addition to IDs, *layers*, *images*, and *containers* can have
human-readable names assigned to them in *oci-storage*. The *set-names* human-readable names assigned to them in *containers-storage*. The *set-names*
command can be used to reset the list of names for any of them. command can be used to reset the list of names for any of them.
## OPTIONS ## OPTIONS
@ -21,7 +21,7 @@ this layer, image, or container, and which are not specified using this option,
will be removed from the layer, image, or container. will be removed from the layer, image, or container.
## EXAMPLE ## EXAMPLE
**oci-storage set-names -n my-one-and-only-name f3be6c6134d0d980936b4c894f1613b69a62b79588fdeda744d0be3693bde8ec** **containers-storage set-names -n my-one-and-only-name f3be6c6134d0d980936b4c894f1613b69a62b79588fdeda744d0be3693bde8ec**
## SEE ALSO ## SEE ALSO
oci-storage-add-names(1) containers-storage-add-names(1)

8
docs/containers-storage-shutdown.md
View File

@ -1,10 +1,10 @@
## oci-storage-shutdown 1 "October 2016" ## containers-storage-shutdown 1 "October 2016"
## NAME ## NAME
oci-storage shutdown - Shut down layer storage containers-storage shutdown - Shut down layer storage
## SYNOPSIS ## SYNOPSIS
**oci-storage** **shutdown** [*options* [...]] **containers-storage** **shutdown** [*options* [...]]
## DESCRIPTION ## DESCRIPTION
Shuts down the layer storage driver, which may be using kernel resources. Shuts down the layer storage driver, which may be using kernel resources.
@ -17,4 +17,4 @@ driver. If this option is not specified, if any layers are mounted, shutdown
will not be attempted. will not be attempted.
## EXAMPLE ## EXAMPLE
**oci-storage shutdown** **containers-storage shutdown**

10
docs/containers-storage-status.md
View File

@ -1,16 +1,16 @@
## oci-storage-status 1 "August 2016" ## containers-storage-status 1 "August 2016"
## NAME ## NAME
oci-storage status - Output status information from the storage library's driver containers-storage status - Output status information from the storage library's driver
## SYNOPSIS ## SYNOPSIS
**oci-storage** **status** **containers-storage** **status**
## DESCRIPTION ## DESCRIPTION
Queries the storage library's driver for status information. Queries the storage library's driver for status information.
## EXAMPLE ## EXAMPLE
**oci-storage status** **containers-storage status**
## SEE ALSO ## SEE ALSO
oci-storage-version(1) containers-storage-version(1)

12
docs/containers-storage-unmount.md
View File

@ -1,17 +1,17 @@
## oci-storage-unmount 1 "August 2016" ## containers-storage-unmount 1 "August 2016"
## NAME ## NAME
oci-storage unmount - Unmount a layer or a container's layer containers-storage unmount - Unmount a layer or a container's layer
## SYNOPSIS ## SYNOPSIS
**oci-storage** **unmount** *layerOrContainerMountpointOrNameOrID* **containers-storage** **unmount** *layerOrContainerMountpointOrNameOrID*
## DESCRIPTION ## DESCRIPTION
Unmounts a layer or a container's layer from the host's filesystem. Unmounts a layer or a container's layer from the host's filesystem.
## EXAMPLE ## EXAMPLE
**oci-storage unmount my-container** **containers-storage unmount my-container**
**oci-storage unmount /var/lib/oci-storage/mounts/my-container** **containers-storage unmount /var/lib/containers/storage/mounts/my-container**
## SEE ALSO ## SEE ALSO
oci-storage-mount(1) containers-storage-mount(1)

12
docs/containers-storage-version.md
View File

@ -1,16 +1,16 @@
## oci-storage-version 1 "August 2016" ## containers-storage-version 1 "August 2016"
## NAME ## NAME
oci-storage version - Output version information about the storage library containers-storage version - Output version information about the storage library
## SYNOPSIS ## SYNOPSIS
**oci-storage** **version** **containers-storage** **version**
## DESCRIPTION ## DESCRIPTION
Outputs version information about the storage library and *oci-storage*. Outputs version information about the storage library and *containers-storage*.
## EXAMPLE ## EXAMPLE
**oci-storage version** **containers-storage version**
## SEE ALSO ## SEE ALSO
oci-storage-status(1) containers-storage-status(1)

8
docs/containers-storage-wipe.md
View File

@ -1,14 +1,14 @@
## oci-storage-wipe 1 "August 2016" ## containers-storage-wipe 1 "August 2016"
## NAME ## NAME
oci-storage wipe - Delete all containers, images, and layers containers-storage wipe - Delete all containers, images, and layers
## SYNOPSIS ## SYNOPSIS
**oci-storage** **wipe** **containers-storage** **wipe**
## DESCRIPTION ## DESCRIPTION
Deletes all known containers, images, and layers. Depending on your use case, Deletes all known containers, images, and layers. Depending on your use case,
use with caution or abandon. use with caution or abandon.
## EXAMPLE ## EXAMPLE
**oci-storage wipe** **containers-storage wipe**

86
docs/containers-storage.md
View File

@ -1,13 +1,13 @@
## oci-storage 1 "August 2016" ## containers-storage 1 "August 2016"
## NAME ## NAME
oci-storage - Manage layer/image/container storage containers-storage - Manage layer/image/container storage
## SYNOPSIS ## SYNOPSIS
**oci-storage** [**subcommand**] [**--help**] **containers-storage** [**subcommand**] [**--help**]
## DESCRIPTION ## DESCRIPTION
The *oci-storage* command is a front-end for the *containers/storage* library. The *containers-storage* command is a front-end for the *containers/storage* library.
While it can be used to manage storage for filesystem layers, images, and While it can be used to manage storage for filesystem layers, images, and
containers directly, its main use cases are centered around troubleshooting and containers directly, its main use cases are centered around troubleshooting and
querying the state of storage which is being managed by other processes. querying the state of storage which is being managed by other processes.
@ -37,7 +37,7 @@ This ensures that changes to the contents of a *container*'s layer do not
affect other *images* or *layers*, so they are considered writeable. affect other *images* or *layers*, so they are considered writeable.
All of *layers*, *images*, and *containers* can have metadata which All of *layers*, *images*, and *containers* can have metadata which
*oci-storage* manages attached to them. Generally this metadata is not *containers-storage* manages attached to them. Generally this metadata is not
expected to be large, as it is cached in memory. expected to be large, as it is cached in memory.
*Images* and *containers* can also have arbitrarily-named data items attached *Images* and *containers* can also have arbitrarily-named data items attached
@ -51,40 +51,40 @@ from the *image*. It is also expected that a *container*'s run-time
configuration will be stored as data items. configuration will be stored as data items.
## SUB-COMMANDS ## SUB-COMMANDS
The *oci-storage* command's features are broken down into several subcommands: The *containers-storage* command's features are broken down into several subcommands:
**oci-storage add-names(1)** Add layer, image, or container name or names **containers-storage add-names(1)** Add layer, image, or container name or names
**oci-storage applydiff(1)** Apply a diff to a layer **containers-storage applydiff(1)** Apply a diff to a layer
**oci-storage changes(1)** Compare two layers **containers-storage changes(1)** Compare two layers
**oci-storage container(1)** Examine a container **containers-storage container(1)** Examine a container
**oci-storage containers(1)** List containers **containers-storage containers(1)** List containers
**oci-storage create-container(1)** Create a new container from an image **containers-storage create-container(1)** Create a new container from an image
**oci-storage create-image(1)** Create a new image using layers **containers-storage create-image(1)** Create a new image using layers
**oci-storage create-layer(1)** Create a new layer **containers-storage create-layer(1)** Create a new layer
**oci-storage delete(1)** Delete a layer or image or container, with no safety checks **containers-storage delete(1)** Delete a layer or image or container, with no safety checks
**oci-storage delete-container(1)** Delete a container, with safety checks **containers-storage delete-container(1)** Delete a container, with safety checks
**oci-storage delete-image(1)** Delete an image, with safety checks **containers-storage delete-image(1)** Delete an image, with safety checks
**oci-storage delete-layer(1)** Delete a layer, with safety checks **containers-storage delete-layer(1)** Delete a layer, with safety checks
**oci-storage diff(1)** Compare two layers **containers-storage diff(1)** Compare two layers
**oci-storage diffsize(1)** Compare two layers **containers-storage diffsize(1)** Compare two layers
**oci-storage exists(1)** Check if a layer or image or container exists **containers-storage exists(1)** Check if a layer or image or container exists
**oci-storage get-container-data(1)** Get data that is attached to a container **containers-storage get-container-data(1)** Get data that is attached to a container
**oci-storage get-image-data(1)** Get data that is attached to an image **containers-storage get-image-data(1)** Get data that is attached to an image
**oci-storage image(1)** Examine an image **containers-storage image(1)** Examine an image
**oci-storage images(1)** List images **containers-storage images(1)** List images
**oci-storage layers(1)** List layers **containers-storage layers(1)** List layers
**oci-storage list-container-data(1)** List data items that are attached to a container **containers-storage list-container-data(1)** List data items that are attached to a container
**oci-storage list-image-data(1)** List data items that are attached to an image **containers-storage list-image-data(1)** List data items that are attached to an image
**oci-storage metadata(1)** Retrieve layer, image, or container metadata **containers-storage metadata(1)** Retrieve layer, image, or container metadata
**oci-storage mount(1)** Mount a layer or container **containers-storage mount(1)** Mount a layer or container
**oci-storage set-container-data(1)** Set data that is attached to a container **containers-storage set-container-data(1)** Set data that is attached to a container
**oci-storage set-image-data(1)** Set data that is attached to an image **containers-storage set-image-data(1)** Set data that is attached to an image
**oci-storage set-metadata(1)** Set layer, image, or container metadata **containers-storage set-metadata(1)** Set layer, image, or container metadata
**oci-storage set-names(1)** Set layer, image, or container name or names **containers-storage set-names(1)** Set layer, image, or container name or names
**oci-storage shutdown(1)** Shut down graph driver **containers-storage shutdown(1)** Shut down graph driver
**oci-storage status(1)** Check on graph driver status **containers-storage status(1)** Check on graph driver status
**oci-storage unmount(1)** Unmount a layer or container **containers-storage unmount(1)** Unmount a layer or container
**oci-storage version(1)** Return oci-storage version information **containers-storage version(1)** Return containers-storage version information
**oci-storage wipe(1)** Wipe all layers, images, and containers **containers-storage wipe(1)** Wipe all layers, images, and containers
## OPTIONS ## OPTIONS
**--help** **--help**
@ -96,15 +96,15 @@ provide information about that command.
Increases the amount of debugging information which is printed. Increases the amount of debugging information which is printed.
**--graph, -g=/var/lib/oci-storage** **--graph, -g=/var/lib/containers/storage**
Overrides the root of the storage tree, used for storing layer contents and Overrides the root of the storage tree, used for storing layer contents and
information about layers, images, and containers. information about layers, images, and containers.
**--run, -R=/var/run/oci-storage** **--run, -R=/var/run/containers/storage**
Overrides the root of the runtime state tree, currently used mainly for noting Overrides the root of the runtime state tree, currently used mainly for noting
the location where a given layer is mounted (see **oci-storage mount**) so that the location where a given layer is mounted (see **containers-storage mount**) so that
it can be unmounted by path name as an alternative to unmounting by ID or name. it can be unmounted by path name as an alternative to unmounting by ID or name.
**--storage-driver, -s** **--storage-driver, -s**
@ -122,7 +122,7 @@ comma-separated list and used instead. If the storage tree has previously been
initialized, these need not be provided. initialized, these need not be provided.
## EXAMPLES ## EXAMPLES
**oci-storage layers -t** **containers-storage layers -t**
## BUGS ## BUGS
This is still a work in progress, so some functionality may not yet be This is still a work in progress, so some functionality may not yet be

4
pkg/plugins/discovery.go
View File

@ -15,8 +15,8 @@ import (
var ( var (
// ErrNotFound plugin not found // ErrNotFound plugin not found
ErrNotFound = errors.New("plugin not found") ErrNotFound = errors.New("plugin not found")
socketsPath = "/run/oci-storage/plugins" socketsPath = "/run/containers/storage/plugins"
specsPaths = []string{"/etc/oci-storage/plugins", "/usr/lib/oci-storage/plugins"} specsPaths = []string{"/etc/containers/storage/plugins", "/usr/lib/containers/storage/plugins"}
) )
// localRegistry defines a registry that is local (using unix socket). // localRegistry defines a registry that is local (using unix socket).

28
pkg/plugins/discovery_test.go
View File

@ -33,8 +33,8 @@ func TestFileSpecPlugin(t *testing.T) {
fail bool fail bool
}{ }{
// TODO Windows: Factor out the unix:// variants. // TODO Windows: Factor out the unix:// variants.
{filepath.Join(tmpdir, "echo.spec"), "echo", "unix://var/lib/oci-storage/plugins/echo.sock", false}, {filepath.Join(tmpdir, "echo.spec"), "echo", "unix://var/lib/containers/storage/plugins/echo.sock", false},
{filepath.Join(tmpdir, "echo", "echo.spec"), "echo", "unix://var/lib/oci-storage/plugins/echo.sock", false}, {filepath.Join(tmpdir, "echo", "echo.spec"), "echo", "unix://var/lib/containers/storage/plugins/echo.sock", false},
{filepath.Join(tmpdir, "foo.spec"), "foo", "tcp://localhost:8080", false}, {filepath.Join(tmpdir, "foo.spec"), "foo", "tcp://localhost:8080", false},
{filepath.Join(tmpdir, "foo", "foo.spec"), "foo", "tcp://localhost:8080", false}, {filepath.Join(tmpdir, "foo", "foo.spec"), "foo", "tcp://localhost:8080", false},
{filepath.Join(tmpdir, "bar.spec"), "bar", "localhost:8080", true}, // unknown transport {filepath.Join(tmpdir, "bar.spec"), "bar", "localhost:8080", true}, // unknown transport
@ -79,11 +79,11 @@ func TestFileJSONSpecPlugin(t *testing.T) {
p := filepath.Join(tmpdir, "example.json") p := filepath.Join(tmpdir, "example.json")
spec := `{ spec := `{
"Name": "plugin-example", "Name": "plugin-example",
"Addr": "https://example.com/oci-storage/plugin", "Addr": "https://example.com/containers-storage/plugin",
"TLSConfig": { "TLSConfig": {
"CAFile": "/usr/shared/oci-storage/certs/example-ca.pem", "CAFile": "/usr/shared/containers-storage/certs/example-ca.pem",
"CertFile": "/usr/shared/oci-storage/certs/example-cert.pem", "CertFile": "/usr/shared/containers-storage/certs/example-cert.pem",
"KeyFile": "/usr/shared/oci-storage/certs/example-key.pem" "KeyFile": "/usr/shared/containers-storage/certs/example-key.pem"
} }
}` }`
@ -101,19 +101,19 @@ func TestFileJSONSpecPlugin(t *testing.T) {
t.Fatalf("Expected plugin `plugin-example`, got %s\n", plugin.Name) t.Fatalf("Expected plugin `plugin-example`, got %s\n", plugin.Name)
} }
if plugin.Addr != "https://example.com/oci-storage/plugin" { if plugin.Addr != "https://example.com/containers-storage/plugin" {
t.Fatalf("Expected plugin addr `https://example.com/oci-storage/plugin`, got %s\n", plugin.Addr) t.Fatalf("Expected plugin addr `https://example.com/containers-storage/plugin`, got %s\n", plugin.Addr)
} }
if plugin.TLSConfig.CAFile != "/usr/shared/oci-storage/certs/example-ca.pem" { if plugin.TLSConfig.CAFile != "/usr/shared/containers-storage/certs/example-ca.pem" {
t.Fatalf("Expected plugin CA `/usr/shared/oci-storage/certs/example-ca.pem`, got %s\n", plugin.TLSConfig.CAFile) t.Fatalf("Expected plugin CA `/usr/shared/containers-storage/certs/example-ca.pem`, got %s\n", plugin.TLSConfig.CAFile)
} }
if plugin.TLSConfig.CertFile != "/usr/shared/oci-storage/certs/example-cert.pem" { if plugin.TLSConfig.CertFile != "/usr/shared/containers-storage/certs/example-cert.pem" {
t.Fatalf("Expected plugin Certificate `/usr/shared/oci-storage/certs/example-cert.pem`, got %s\n", plugin.TLSConfig.CertFile) t.Fatalf("Expected plugin Certificate `/usr/shared/containers-storage/certs/example-cert.pem`, got %s\n", plugin.TLSConfig.CertFile)
} }
if plugin.TLSConfig.KeyFile != "/usr/shared/oci-storage/certs/example-key.pem" { if plugin.TLSConfig.KeyFile != "/usr/shared/containers-storage/certs/example-key.pem" {
t.Fatalf("Expected plugin Key `/usr/shared/oci-storage/certs/example-key.pem`, got %s\n", plugin.TLSConfig.KeyFile) t.Fatalf("Expected plugin Key `/usr/shared/containers-storage/certs/example-key.pem`, got %s\n", plugin.TLSConfig.KeyFile)
} }
} }

9
pkg/plugins/plugins.go
View File

@ -3,10 +3,11 @@
// //
// Storage discovers plugins by looking for them in the plugin directory whenever // Storage discovers plugins by looking for them in the plugin directory whenever
// a user or container tries to use one by name. UNIX domain socket files must // a user or container tries to use one by name. UNIX domain socket files must
// be located under /run/oci-storage/plugins, whereas spec files can be located // be located under /run/containers/storage/plugins, whereas spec files can be
// either under /etc/oci-storage/plugins or /usr/lib/oci-storage/plugins. This // located either under /etc/containers/storage/plugins or
// is handled by the Registry interface, which lets you list all plugins or get // /usr/lib/containers/storage/plugins. This is handled by the Registry
// a plugin by its name if it exists. // interface, which lets you list all plugins or get a plugin by its name if it
// exists.
// //
// The plugins need to implement an HTTP server and bind this to the UNIX socket // The plugins need to implement an HTTP server and bind this to the UNIX socket
// or the address specified in the spec files. // or the address specified in the spec files.

2
tests/helpers.bash
View File

@ -1,6 +1,6 @@
#!/bin/bash #!/bin/bash
STORAGE_BINARY=${STORAGE_BINARY:-$(dirname ${BASH_SOURCE})/../oci-storage} STORAGE_BINARY=${STORAGE_BINARY:-$(dirname ${BASH_SOURCE})/../containers-storage}
TESTSDIR=${TESTSDIR:-$(dirname ${BASH_SOURCE})} TESTSDIR=${TESTSDIR:-$(dirname ${BASH_SOURCE})}
function setup() { function setup() {