forked from virtuozzo/external-storage
-
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.
- Loading branch information
Showing
21 changed files
with
1,508 additions
and
0 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 |
---|---|---|
@@ -0,0 +1,2 @@ | ||
/.go | ||
/efs-provisioner |
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 |
---|---|---|
@@ -0,0 +1,4 @@ | ||
FROM alpine:3.5 | ||
RUN apk update --no-cache && apk add ca-certificates | ||
COPY efs-provisioner / | ||
ENTRYPOINT ["/efs-provisioner"] |
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 |
---|---|---|
@@ -0,0 +1,68 @@ | ||
# Copyright 2017 The Kubernetes Authors. | ||
# | ||
# 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. | ||
|
||
IMAGE = quay.io/external_storage/efs-provisioner | ||
# TODO | ||
VERSION = latest | ||
|
||
all build: | ||
@mkdir -p .go/src/github.com/kubernetes-incubator/external-storage/efs/vendor | ||
@mkdir -p .go/bin | ||
@mkdir -p .go/stdlib | ||
@docker run \ | ||
--rm \ | ||
-e "CGO_ENABLED=0" \ | ||
-u $$(id -u):$$(id -g) \ | ||
-v $$(pwd)/.go:/go \ | ||
-v $$(pwd):/go/src/github.com/kubernetes-incubator/external-storage/efs \ | ||
-v "$$(dirname $$(pwd))/vendor":/go/src/github.com/kubernetes-incubator/external-storage/vendor \ | ||
-v "$$(dirname $$(pwd))/lib":/go/src/github.com/kubernetes-incubator/external-storage/lib \ | ||
-v $$(pwd):/go/bin \ | ||
-v $$(pwd)/.go/stdlib:/usr/local/go/pkg/linux_amd64_asdf \ | ||
-w /go/src/github.com/kubernetes-incubator/external-storage/efs \ | ||
golang:1.7.4-alpine \ | ||
go install -installsuffix "asdf" ./cmd/efs-provisioner | ||
.PHONY: all build | ||
|
||
container: build quick-container | ||
.PHONY: container | ||
|
||
quick-container: | ||
docker build -t $(IMAGE):$(VERSION) . | ||
.PHONY: quick-container | ||
|
||
push: container | ||
docker push $(IMAGE):$(VERSION) | ||
.PHONY: push | ||
|
||
test: verify | ||
go test `go list ./... | grep -v 'vendor'` | ||
.PHONY: test | ||
|
||
verify: | ||
@tput bold; echo Running gofmt:; tput sgr0 | ||
(gofmt -s -w -l `find . -type f -name "*.go" | grep -v vendor`) || exit 1 | ||
@tput bold; echo Running golint and go vet:; tput sgr0 | ||
for i in $$(find . -type f -name "*.go" | grep -v 'vendor\|framework'); do \ | ||
golint --set_exit_status $$i; \ | ||
go vet $$i; \ | ||
done | ||
@tput bold; echo Running verify-boilerplate; tput sgr0 | ||
../repo-infra/verify/verify-boilerplate.sh | ||
.PHONY: verify | ||
|
||
clean: | ||
rm -rf .go | ||
rm -f efs-provisioner | ||
.PHONY: clean |
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 |
---|---|---|
@@ -0,0 +1,104 @@ | ||
# efs-provisioner | ||
|
||
## Deployment | ||
|
||
Create a configmap containing the [**File system ID**](http://docs.aws.amazon.com/efs/latest/ug/gs-step-two-create-efs-resources.html) and Amazon EC2 region of the EFS file system you wish to provision NFS PVs from, plus the name of the provisioner, which administrators will specify in the `provisioner` field of their `StorageClass(es)`, e.g. `provisioner: example.com/aws-efs`. | ||
|
||
```console | ||
$ kubectl create configmap efs-provisioner \ | ||
--from-literal=file.system.id=fs-47a2c22e \ | ||
--from-literal=aws.region=us-west-2 \ | ||
--from-literal=provisioner.name=example.com/aws-efs | ||
``` | ||
|
||
Create a secret containing AWS credentials for the provisioner to use. The credentials will be used only once at startup to check that the EFS file system you specified in the configmap actually exists. | ||
|
||
```console | ||
$ kubectl create secret generic aws-credentials \ | ||
--from-literal=aws-access-key-id=AKIAIOSFODNN7EXAMPLE \ | ||
--from-literal=aws-secret-access-key=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY | ||
``` | ||
|
||
Decide on & set aside a directory within the EFS file system for the provisioner to use. The provisioner will create child directories to back each PV it provisions. Then edit the `volumes` section at the bottom of "deploy/deployment.yaml" so that the `path` refers to the directory you set aside and the `server` is the same EFS file system you specified. Create the deployment, and you're done. | ||
|
||
```yaml | ||
volumes: | ||
- name: pv-volume | ||
nfs: | ||
server: fs-47a2c22e.efs.us-west-2.amazonaws.com | ||
path: /persistentvolumes | ||
``` | ||
```console | ||
$ kubectl create -f deploy/deployment.yaml | ||
deployment "efs-provisioner" created | ||
``` | ||
|
||
### Authorization | ||
|
||
If your cluster has RBAC enabled or you are running OpenShift you must authorize the provisioner. If you are in a namespace/project other than "default" either edit `deploy/auth/clusterrolebinding.yaml` or edit the `oadm policy` command accordingly. | ||
|
||
#### RBAC | ||
```console | ||
$ kubectl create -f deploy/auth/serviceaccount.yaml | ||
serviceaccount "efs-provisioner" created | ||
$ kubectl create -f deploy/auth/clusterrole.yaml | ||
clusterrole "efs-provisioner-runner" created | ||
$ kubectl create -f deploy/auth/clusterrolebinding.yaml | ||
clusterrolebinding "run-efs-provisioner" created | ||
$ kubectl patch deployment efs-provisioner -p '{"spec":{"template":{"spec":{"serviceAccount":"efs-provisioner"}}}}' | ||
``` | ||
|
||
#### OpenShift | ||
```console | ||
$ oc create -f deploy/auth/serviceaccount.yaml | ||
serviceaccount "efs-provisioner" created | ||
$ oc create -f deploy/auth/openshift-clusterrole.yaml | ||
clusterrole "efs-provisioner-runner" created | ||
$ oadm policy add-cluster-role-to-user efs-provisioner-runner system:serviceaccount:default:efs-provisioner created | ||
$ oc patch deployment efs-provisioner -p '{"spec":{"template":{"spec":{"serviceAccount":"efs-provisioner"}}}}' | ||
``` | ||
### SELinux | ||
If SELinux is enforcing on the node where the provisioner runs, you must enable writing from a pod to a remote NFS server (EFS in this case) on the node by running: | ||
```console | ||
$ setsebool -P virt_use_nfs 1 | ||
$ setsebool -P virt_sandbox_use_nfs 1 | ||
``` | ||
https://docs.openshift.org/latest/install_config/persistent_storage/persistent_storage_nfs.html#nfs-selinux | ||
|
||
## Usage | ||
|
||
First a [`StorageClass`](https://kubernetes.io/docs/user-guide/persistent-volumes/#storageclasses) for claims to ask for needs to be created. | ||
|
||
```yaml | ||
apiVersion: storage.k8s.io/v1beta1 | ||
kind: StorageClass | ||
metadata: | ||
name: slow | ||
provisioner: example.com/aws-efs | ||
parameters: | ||
gidMin: "40000" | ||
gidMax: "50000" | ||
``` | ||
### Parameters | ||
* `gidMin` + `gidMax` : The minimum and maximum value of GID range for the storage class. A unique value (GID) in this range ( gidMin-gidMax ) will be used for dynamically provisioned volumes. These are optional values. If not specified, the volume will be provisioned with a value between 2000-2147483647 which are defaults for gidMin and gidMax respectively. | ||
|
||
Once you have finished configuring the class to have the name you chose when deploying the provisioner and the parameters you want, create it. | ||
|
||
```console | ||
$ kubectl create -f deploy/class.yaml | ||
storageclass "aws-efs" created | ||
``` | ||
|
||
When you create a claim that asks for the class, a volume will be automatically created. | ||
|
||
```console | ||
$ kubectl create -f deploy/claim.yaml | ||
persistentvolumeclaim "efs" created | ||
$ kubectl get pv | ||
NAME CAPACITY ACCESSMODES RECLAIMPOLICY STATUS CLAIM REASON AGE | ||
pvc-557b4436-ed73-11e6-84b3-06a700dda5f5 1Mi RWX Delete Bound default/efs 2s | ||
``` | ||
Note: any pod that consumes the claim will be able to read/write to the volume. This is because the volumes are provisioned with a GID (from the default range or according to `gidMin` + `gidMax`) and any pod that mounts the volume via the claim automatically gets the GID as a supplemental group. |
Oops, something went wrong.