subpath详解

一、subpaths

subpaths是kubernetes中一个比较常用的资源，用来指定一个容器内的文件或目录挂载到一个pvc上，是容器和pvc之间的一个桥梁。可以通过yaml文件或者kubectl命令行方式来定义subpath。

在yaml文件中一个subpaths的定义示例如下：

spec:
  containers:
  - image: nginx
    name: nginx
    volumeMounts:
    - name: datavolume
      mountPath: /usr/share/nginx/html
      subPath: share/nginx/html
  volumes:
  - name: datavolume
    persistentVolumeClaim:
      claimName: datavolume-claim

以上yaml文件中定义了一个container nginx，其中使用了一个subpaths并将其挂载到名为datavolume-claim的pvc上。

二、subpath.nodes(i).delete

subpath.nodes(i).delete是指定一个文件或目录路径及其下的所有内容删除（注意：不是删除整个subpath资源或pvc上的内容），需要注意的是，只有当整个subpath当中文件或目录的个数不大于2000个时，才能使用该方法进行删除。示例代码如下：

import os

dir_path = '/path/to/subpath/nodes(i)'
for filename in os.listdir(dir_path):
    file_path = os.path.join(dir_path, filename)
    try:
        if os.path.isfile(file_path) or os.path.islink(file_path):
            os.unlink(file_path)
        elif os.path.isdir(file_path):
            shutil.rmtree(file_path)
    except Exception as e:
        print('Failed to delete %s. Reason: %s' % (file_path, e))

三、subpath原理

subpath是通过Kubernetes自带的volume插件实现的，可以通过volumeMounts属性将一个volume挂载到一个container的某个指定路径下。subpath主要由以下三个部分组成：

• 数据卷（volume）：提供原始数据资源，可以是emptyDir（创建空目录）或者persistentVolumeClaim（使用现有的pvc）。
• 容器卷挂载（volumeMounts）：将volume挂载到一个容器内已有的路径指定上。
• subpath：通过指定挂载路径下的子路径指定哪些文件或者目录需要被挂载到volume中。

四、subpathway

subpathway实现了在Pod之间共享同样的subpath和数据的方法。通过在Pod A中共享一个subpath和volume，Pod B可以分别读写与Pod A相同的subpath。这样就可以使各个Pod之间共享同样的数据。示例代码如下：

apiVersion: v1
kind: Pod
metadata:
  name: nginx-pod-b
  labels:
    app: nginx
spec:
  containers:
  - name: nginx
    image: nginx
    volumeMounts:
    - name: data
      mountPath: /var/www/html
  volumes:
  - name: data
    persistentVolumeClaim:
      claimName: nginx-subpath
      readOnly: true

五、subpath k8s

subpath k8s，可以通过kubectl命令行方式对subpath进行创建，修改等操作。具体可以参考Kubernetes官方文档。创建一个subpath的示例命令如下：

kubectl apply -f subpath.yaml

六、subpath挂载卸载

subpath可以通过kubectl命令行或者yaml文件的方式挂载到container内。具体操作可以参考Kubernetes官方文档。挂载示例yaml文件如下：

spec:
  containers:
  - image: nginx
    name: nginx
    volumeMounts:
    - name: datavolume
      mountPath: /usr/share/nginx/html
      subPath: share/nginx/html
  volumes:
  - name: datavolume
    persistentVolumeClaim:
      claimName: datavolume-claim

subpath的卸载可通过删除Pod实例来实现。