├── LICENSE ├── README.md ├── exporter ├── Dockerfile ├── README.md └── run_nfs ├── nfs-data ├── Dockerfile ├── README.md └── index.html ├── nfs-server-pod.yaml ├── nfs-server-service.yaml └── web-pod.yaml /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Example of NFS volume 2 | 3 | ## NFS server part 4 | 5 | Define [NFS server pod](nfs-server-pod.yaml) and 6 | [NFS service](nfs-server-service.yaml): 7 | 8 | $ kubectl create -f nfs-server-pod.yaml 9 | $ kubectl create -f nfs-server-service.yaml 10 | 11 | The server exports /mnt/data directory, which contains dummy index.html. 12 | Wait until the pod is running! 13 | 14 | TODO: export content of a Google cloud volume. 15 | 16 | ## NFS client (the real example) 17 | 18 | See [WEB server pod](web-pod.yaml), which runs a simple web server serving 19 | data from the NFS. The pod assumes your DNS is set up and the NFS service is 20 | reachable as `nfs-server.default.kube.local`. Edit the yaml file to supply 21 | another name or directly its IP address (use `kubectl get services` to get it). 22 | 23 | Finally, define the pod: 24 | 25 | $ kubectl create -f web-pod.yaml 26 | 27 | Now the pod serves index.html from the NFS server: 28 | 29 | $ curl http:/// 30 | Hello World! 31 | -------------------------------------------------------------------------------- /exporter/Dockerfile: -------------------------------------------------------------------------------- 1 | FROM fedora:21 2 | MAINTAINER Jan Safranek 3 | EXPOSE 2049/tcp 4 | 5 | RUN yum -y install nfs-utils 6 | RUN yum clean all 7 | ADD run_nfs /usr/local/bin/run_nfs 8 | 9 | ENTRYPOINT ["/usr/local/bin/run_nfs"] -------------------------------------------------------------------------------- /exporter/README.md: -------------------------------------------------------------------------------- 1 | # NFS-exporter container 2 | 3 | Inspired by https://github.com/cpuguy83/docker-nfs-server. Rewritten for 4 | Fedora, just to get some Docker skills. 5 | 6 | Available in dockerhub as 7 | [jsafrane/nfsexporter](https://registry.hub.docker.com/u/jsafrane/nfsexporter/). 8 | 9 | Usage:: 10 | 11 | docker run -d --name nfs --privileged jsafrane/nfsexporter /path/to/share /path/to/share2 ... 12 | -------------------------------------------------------------------------------- /exporter/run_nfs: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # Copyright 2015 Red Hat Inc. 4 | # 5 | # Licensed under the Apache License, Version 2.0 (the "License"); 6 | # you may not use this file except in compliance with the License. 7 | # You may obtain a copy of the License at 8 | # 9 | # http://www.apache.org/licenses/LICENSE-2.0 10 | # 11 | # Unless required by applicable law or agreed to in writing, software 12 | # distributed under the License is distributed on an "AS IS" BASIS, 13 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | # See the License for the specific language governing permissions and 15 | # limitations under the License. 16 | 17 | function start() 18 | { 19 | 20 | # prepare /etc/exports 21 | for i in "$@"; do 22 | echo "$i *(rw,sync,no_root_squash,insecure,fsid=0)" >> /etc/exports 23 | echo "Serving $i" 24 | done 25 | 26 | # from /lib/systemd/system/proc-fs-nfsd.mount 27 | mount -t nfsd nfds /proc/fs/nfsd 28 | 29 | # from /lib/systemd/system/rpcbind.service 30 | # . /etc/sysconfig/rpcbind 31 | # /sbin/rpcbind -w ${RPCBIND_ARGS} 32 | 33 | # from /lib/systemd/system/nfs-config.service 34 | /usr/lib/systemd/scripts/nfs-utils_env.sh 35 | 36 | # from /lib/systemd/system/nfs-mountd.service 37 | . /run/sysconfig/nfs-utils 38 | /usr/sbin/rpc.mountd $RPCMOUNTDARGS 39 | 40 | # from /lib/systemd/system/nfs-server.service 41 | . /run/sysconfig/nfs-utils 42 | /usr/sbin/exportfs -r 43 | /usr/sbin/rpc.nfsd -N 2 -N 3 -V 4 -V 4.1 $RPCNFSDARGS 44 | 45 | echo "NFS started" 46 | } 47 | 48 | function stop() 49 | { 50 | echo "Stopping NFS" 51 | 52 | # from /lib/systemd/system/nfs-server.service 53 | /usr/sbin/rpc.nfsd 0 54 | /usr/sbin/exportfs -au 55 | /usr/sbin/exportfs -f 56 | 57 | # from /lib/systemd/system/nfs-mountd.service 58 | kill $( pidof rpc.mountd ) 59 | # from /lib/systemd/system/proc-fs-nfsd.mount 60 | umount /proc/fs/nfsd 61 | 62 | echo > /etc/exports 63 | exit 0 64 | } 65 | 66 | 67 | trap stop TERM 68 | 69 | start "$@" 70 | 71 | # Ugly hack to do nothing and wait for SIGTERM 72 | while true; do 73 | read 74 | done 75 | -------------------------------------------------------------------------------- /nfs-data/Dockerfile: -------------------------------------------------------------------------------- 1 | FROM jsafrane/nfsexporter 2 | MAINTAINER Jan Safranek 3 | ADD index.html /mnt/data/index.html 4 | 5 | ENTRYPOINT ["/usr/local/bin/run_nfs", "/mnt/data"] 6 | -------------------------------------------------------------------------------- /nfs-data/README.md: -------------------------------------------------------------------------------- 1 | # NFS-exporter container with a file 2 | 3 | This container exports /mnt/data with index.html in it via NFS. Based on ../exporter. 4 | 5 | Available in dockerhub as 6 | [jsafrane/nfs-data](https://registry.hub.docker.com/u/jsafrane/nfs-data/). -------------------------------------------------------------------------------- /nfs-data/index.html: -------------------------------------------------------------------------------- 1 | Hello world! 2 | -------------------------------------------------------------------------------- /nfs-server-pod.yaml: -------------------------------------------------------------------------------- 1 | apiVersion: v1beta1 2 | kind: Pod 3 | id: nfs-server 4 | desiredState: 5 | manifest: 6 | version: v1beta1 7 | id: nfs-server 8 | containers: 9 | - name: nfs-server 10 | image: jsafrane/nfs-data 11 | privileged: true 12 | ports: 13 | - name: nfs 14 | containerPort: 2049 15 | protocol: tcp 16 | labels: 17 | name: nfs-server 18 | -------------------------------------------------------------------------------- /nfs-server-service.yaml: -------------------------------------------------------------------------------- 1 | id: nfs-server 2 | kind: Service 3 | apiVersion: v1beta1 4 | port: 2049 5 | protocol: tcp 6 | selector: 7 | name: nfs-server 8 | -------------------------------------------------------------------------------- /web-pod.yaml: -------------------------------------------------------------------------------- 1 | apiVersion: v1beta1 2 | desiredState: 3 | manifest: 4 | containers: 5 | - name: web 6 | image: dockerfile/nginx 7 | volumeMounts: 8 | # name must match the volume name below 9 | - name: nfs 10 | mountPath: "/var/www/html" 11 | ports: 12 | - name: web 13 | containerPort: 80 14 | protocol: tcp 15 | id: web 16 | version: v1beta1 17 | volumes: 18 | - name: nfs 19 | source: 20 | nfs: 21 | # FIXME: use the right name 22 | server: nfs-server.default.kube.local 23 | path: "/" 24 | readOnly: false 25 | id: web 26 | kind: Pod 27 | --------------------------------------------------------------------------------