-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: stoneshi-yunify <[email protected]>
- Loading branch information
1 parent
0ea5e64
commit 815ac4b
Showing
2 changed files
with
38 additions
and
97 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,114 +1,55 @@ | ||
| # nfs-pv-static-provisioner | ||
| // TODO(user): Add simple overview of use/purpose | ||
| # nfs-PV-static-provisioner | ||
| A NFS persistent volume static provisioner, which allows you to quickly bind an existing NFS volume to PVC. | ||
|
|
||
| ## Description | ||
| // TODO(user): An in-depth paragraph about your project and overview of use | ||
|
|
||
| ## Getting Started | ||
|
|
||
| ### Prerequisites | ||
| - go version v1.22.0+ | ||
| - docker version 17.03+. | ||
| - kubectl version v1.11.3+. | ||
| - Access to a Kubernetes v1.11.3+ cluster. | ||
|
|
||
| ### To Deploy on the cluster | ||
| **Build and push your image to the location specified by `IMG`:** | ||
|
|
||
| ```sh | ||
| make docker-build docker-push IMG=<some-registry>/nfs-pv-static-provisioner:tag | ||
| ``` | ||
|
|
||
| **NOTE:** This image ought to be published in the personal registry you specified. | ||
| And it is required to have access to pull the image from the working environment. | ||
| Make sure you have the proper permission to the registry if the above commands don’t work. | ||
|
|
||
| **Install the CRDs into the cluster:** | ||
|
|
||
| ```sh | ||
| make install | ||
| ``` | ||
|
|
||
| **Deploy the Manager to the cluster with the image specified by `IMG`:** | ||
|
|
||
| ```sh | ||
| make deploy IMG=<some-registry>/nfs-pv-static-provisioner:tag | ||
| ``` | ||
|
|
||
| > **NOTE**: If you encounter RBAC errors, you may need to grant yourself cluster-admin | ||
| privileges or be logged in as admin. | ||
|
|
||
| **Create instances of your solution** | ||
| You can apply the samples (examples) from the config/sample: | ||
|
|
||
| ```sh | ||
| kubectl apply -k config/samples/ | ||
| ``` | ||
| **This provisioner will NOT provision volumes on NFS server when you create a PVC.** If you are looking for a dynamic provisioner of NFS, please consider other projects, like [this](https://github.com/kubernetes-sigs/nfs-subdir-external-provisioner). | ||
|
|
||
| >**NOTE**: Ensure that the samples has default values to test it out. | ||
| ## Description | ||
| The provisioner listens PVC CREATE and UPDATE events, when the PVC has demanded annotations, the provisioner will create/update a NFS PV and bind it with the PVC automatically. | ||
|
|
||
| ### To Uninstall | ||
| **Delete the instances (CRs) from the cluster:** | ||
| | Annotation | Required | Default Value | Explanation | Example Values | | ||
| |--------------------------------------------|----------|---------------|--------------------------------------------------------------|-----------------------------------------| | ||
| | storage.kubesphere.io/nfs-static-provision | Y | "false" | must set to "true" in order to use this provisioner | "true" | | ||
| | storage.kubesphere.io/nfs-server | Y | "" | nfs server hostname or IP address (PV.spec.nfs.server) | "example.nfs.server.com", "192.168.0.5" | | ||
| | storage.kubesphere.io/nfs-path | Y | "" | nfs volume absolute path (PV.spec.nfs.path) | "/exports/volume1" | | ||
| | storage.kubesphere.io/nfs-readonly | N | "false" | whether the volume is read-only (PV.spec.nfs.readOnly) | "false", "true" | | ||
| | storage.kubesphere.io/reclaim-policy* | N | "Delete" | reclaim policy of PV (PV.spec.persistentVolumeReclaimPolicy) | "Delete", "Retain" | | ||
| | storage.kubesphere.io/mount-options | N | "" | mount options of PV (PV.spec.mountOptions) | `"[\"nfsvers=3\",\"nolock\",\"hard\"]"` | | ||
|
|
||
| ```sh | ||
| kubectl delete -k config/samples/ | ||
| ``` | ||
| - *When reclaim policy is "Delete", the PV will be deleted when the PVC is deleted. However, this only affects the PV resource in k8s cluster, the real backend volume on NFS server still exists. | ||
|
|
||
| **Delete the APIs(CRDs) from the cluster:** | ||
| ## Usecase | ||
| - As a tenant(e.g. admin of a namespace) on kubernetes cluster, you don't have permissions to create PV resources (as PV is cluster-level resource), but you own an external NFS server and want to use the existing volumes via PVC. | ||
|
|
||
| ## Deploy | ||
| ### Deploy | ||
| To deploy the controller: | ||
| ```sh | ||
| make uninstall | ||
| make deploy | ||
| ``` | ||
|
|
||
| **UnDeploy the controller from the cluster:** | ||
| ### Test | ||
| Create a PVC and check if it can be automatically bound. Take [this](./config/samples/PVC.yaml) for example. | ||
|
|
||
| ### Undeploy | ||
| To uninstall the controller: | ||
| ```sh | ||
| make undeploy | ||
| ``` | ||
|
|
||
| ## Project Distribution | ||
|
|
||
| Following are the steps to build the installer and distribute this project to users. | ||
|
|
||
| 1. Build the installer for the image built and published in the registry: | ||
|
|
||
| ```sh | ||
| make build-installer IMG=<some-registry>/nfs-pv-static-provisioner:tag | ||
| ``` | ||
|
|
||
| NOTE: The makefile target mentioned above generates an 'install.yaml' | ||
| file in the dist directory. This file contains all the resources built | ||
| with Kustomize, which are necessary to install this project without | ||
| its dependencies. | ||
|
|
||
| 2. Using the installer | ||
|
|
||
| Users can just run kubectl apply -f <URL for YAML BUNDLE> to install the project, i.e.: | ||
| ## Events | ||
| PV creation events will be issued targeting the PVC object. | ||
|
|
||
| e.g. | ||
| ```sh | ||
| kubectl apply -f https://raw.githubusercontent.com/<org>/nfs-pv-static-provisioner/<tag or branch>/dist/install.yaml | ||
| $ kubectl describe pvc pvc-nfs | ||
| Name: pvc-nfs | ||
| Namespace: default | ||
| ... | ||
| Events: | ||
| Type Reason Age From Message | ||
| ---- ------ ---- ---- ------- | ||
| Warning ParsePVFailed 30s (x14 over 71s) nfs-pv-static-provisioner failed to parse pv from pvc, error: annotation storage.kubesphere.io/nfs-path not found or has invalid value | ||
| Normal FailedBinding 6s (x6 over 71s) persistentvolume-controller no persistent volumes available for this claim and no storage class is set | ||
| Normal VolumeNameUpdated 6s nfs-pv-static-provisioner volumeName updated successfully | ||
| Warning CreatePVFailed 3s (x10 over 6s) nfs-pv-static-provisioner failed to create pv pvc-091ecc93-698e-4421-b758-d4883a786aea, error: PersistentVolume "pvc-091ecc93-698e-4421-b758-d4883a786aea" is invalid: spec.nfs.path: Invalid value: "aaa": must be an absolute path | ||
| ``` | ||
|
|
||
| ## Contributing | ||
| // TODO(user): Add detailed information on how you would like others to contribute to this project | ||
|
|
||
| **NOTE:** Run `make help` for more information on all potential `make` targets | ||
|
|
||
| More information can be found via the [Kubebuilder Documentation](https://book.kubebuilder.io/introduction.html) | ||
|
|
||
| ## License | ||
|
|
||
| Copyright 2024. | ||
|
|
||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
|
|
File renamed without changes.