Skip to content

Commit 5091fef

Browse files
committed
Added notes regarding symlinked directories; updated atomic driver installation.
1 parent 2fbb4a8 commit 5091fef

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

contributors/design-proposals/flexvolume-deployment.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,9 @@ Iterating through the list of plugins inside `InitPlugins()` from `volume/plugin
3232

3333
Because Flexvolume has two separate plugin instantiations (attachable and non-attachable), it's worth considering the case when a driver that implements attach/detach is replaced with a driver that does not, or vice versa. This does not cause an issue because plugins are recreated every time the driver directory is changed.
3434

35-
There is a possibility that a Flexvolume command execution occurs at the same time as the DaemonSet updates the driver, which leads to a bad execution. This cannot be solved within the Kubernetes system without an overhaul. Instead, this is discussed in [Atomic Driver Installation](#atomic-driver-installation) as part of the deployment mechanism. As part of the solution, the Prober will ignore all files that begins with "." in the driver directory.
35+
There is a possibility that a Flexvolume command execution occurs at the same time as the driver is updated, which leads to a bad execution. This cannot be solved within the Kubernetes system without an overhaul. Instead, this is discussed in [Atomic Driver Installation](#atomic-driver-installation) as part of the deployment mechanism. As part of the solution, the Prober will **ignore all files that begins with "."** in the driver directory.
36+
37+
Word of caution about symlinks in the Flexvolume plugin directory: as a result of the recursive filesystem watch implementation, if a symlink links to a directory, unless the directory is visible to the prober (i.e. it's inside the Flexvolume plugin directory and does not start with '.'), the directory's files and subdirectories are not added to filesystem watch, thus their change will not trigger a probe.
3638

3739

3840
## **Alternative Designs**
@@ -102,6 +104,8 @@ set -o pipefail
102104
VENDOR=k8s.io
103105
DRIVER=nfs
104106

107+
# Assuming the single driver file is located at /$DRIVER inside the DaemonSet image.
108+
105109
driver_dir=$VENDOR${VENDOR:+"~"}${DRIVER}
106110
if [ ! -d "/flexmnt/$driver_dir" ]; then
107111
mkdir "/flexmnt/$driver_dir"
@@ -145,7 +149,7 @@ spec:
145149
### Atomic Driver Installation
146150
Regular file copy is not an atomic file operation, so if it were used to install the driver, it's possible that kubelet or controller manager executes the driver when it's partially installed, or the driver gets modified while it's being executed. Care must be taken to ensure the installation operation is atomic.
147151
148-
The deployment script provided above uses renaming, which is atomic, to ensure that from the perspective of kubelet or controller manager, the driver file is completely written to disk in a single operation.
152+
The deployment script provided above uses renaming, which is atomic, to ensure that from the perspective of kubelet or controller manager, the driver file is completely written to disk in a single operation. The file is first installed with a name prefixed with '.', which the prober ignores.
149153
150154
### Alternatives
151155

0 commit comments

Comments
 (0)