Unverified Commit b59a7f21 authored by Cyrill Troxler's avatar Cyrill Troxler Committed by GitHub
Browse files

Merge pull request #18 from ctrox/secrets 

Supply credentials using volume secrets instead of cli config
parents ea4022e9 2d3c8be6

Makefile

+5 −2
Original line number Diff line number Diff line
@@ -16,8 +16,9 @@ 
PROJECT_DIR=/app

REGISTRY_NAME=ctrox

IMAGE_NAME=csi-s3

IMAGE_VERSION=1.0.1-alpha

IMAGE_TAG=$(REGISTRY_NAME)/$(IMAGE_NAME):$(IMAGE_VERSION)

VERSION ?= dev

IMAGE_TAG=$(REGISTRY_NAME)/$(IMAGE_NAME):$(VERSION)

FULL_IMAGE_TAG=$(IMAGE_TAG)-full

TEST_IMAGE_TAG=$(REGISTRY_NAME)/$(IMAGE_NAME):test



build:
@@ -27,8 +28,10 @@ test: 
	docker run --rm --privileged -v $(PWD):$(PROJECT_DIR) --device /dev/fuse $(TEST_IMAGE_TAG)

container: build

	docker build -t $(IMAGE_TAG) -f cmd/s3driver/Dockerfile .

	docker build -t $(FULL_IMAGE_TAG) --build-arg VERSION=$(VERSION) -f cmd/s3driver/Dockerfile.full .

push: container

	docker push $(IMAGE_TAG)

	docker push $(FULL_IMAGE_TAG)

clean:

	go clean -r -x

	-rm -rf _output

README.md

+80 −54
Original line number Diff line number Diff line 
# CSI for S3



This is a Container Storage Interface ([CSI](https://github.com/container-storage-interface/spec/blob/master/spec.md)) for S3 (or S3 compatible) storage. This can dynamically allocate buckets and mount them via a fuse mount into any container.



# Status

## Status



This is still very experimental and should not be used in any production environment. Unexpected data loss could occur depending on what mounter and S3 storage backend is being used.



# Kubernetes installation

## Requirements

* Kubernetes 1.10+

## Kubernetes installation



### Requirements



* Kubernetes 1.13+ (CSI v1.0.0 compatibility)

* Kubernetes has to allow privileged containers

* Docker daemon must allow shared mounts (systemd flag `MountFlags=shared`)



## 1. Create a secret with your S3 credentials

The endpoint is optional if you are using something else than AWS S3. Also the region can be empty if you are using some other S3 compatible storage.

### 1. Create a secret with your S3 credentials



```yaml

apiVersion: v1

kind: Secret
@@ -20,56 +24,68 @@ metadata: 
stringData:

  accessKeyID: <YOUR_ACCESS_KEY_ID>

  secretAccessKey: <YOUR_SECRET_ACCES_KEY>

  # For AWS set it to "https://s3.amazonaws.com"

  # For AWS set it to "https://s3.<region>.amazonaws.com"

  endpoint: <S3_ENDPOINT_URL>

  # If not on S3, set it to ""

  region: <S3_REGION>

  # Currently only for s3ql

  # If not using s3ql, set it to ""

  encryptionKey: <FS_ENCRYPTION_KEY>

```



## 2. Deploy the driver

The region can be empty if you are using some other S3 compatible storage.



### 2. Deploy the driver



```bash

cd deploy/kubernetes

$ kubectl create -f provisioner.yaml

$ kubectl create -f attacher.yaml

$ kubectl create -f csi-s3.yaml

kubectl create -f provisioner.yaml

kubectl create -f attacher.yaml

kubectl create -f csi-s3.yaml

```



## 3. Create the storage class

### 3. Create the storage class



```bash

$ kubectl create -f storageclass.yaml

kubectl create -f storageclass.yaml

```



## 4. Test the S3 driver

* Create a pvc using the new storage class:

### 4. Test the S3 driver



1. Create a pvc using the new storage class:



```bash

$ kubectl create -f pvc.yaml

kubectl create -f pvc.yaml

```

* Check if the PVC has been bound:



2. Check if the PVC has been bound:



```bash

$ kubectl get pvc csi-s3-pvc

NAME         STATUS    VOLUME                                     CAPACITY   ACCESS MODES   STORAGECLASS   AGE

csi-s3-pvc   Bound     pvc-c5d4634f-8507-11e8-9f33-0e243832354b   5Gi        RWX            csi-s3         9s

csi-s3-pvc   Bound     pvc-c5d4634f-8507-11e8-9f33-0e243832354b   5Gi        RWO            csi-s3         9s

```

* Create a test pod which mounts your volume:



3. Create a test pod which mounts your volume:



```bash

$ kubectl create -f poc.yaml

kubectl create -f poc.yaml

```



If the pod can start, everything should be working.



* Test the mount

4. Test the mount



```bash

$ kubectl exec -ti csi-s3-test-nginx bash

$ mount | grep fuse

s3fs on /var/lib/www/html type fuse.s3fs (rw,nosuid,nodev,relatime,user_id=0,group_id=0,allow_other)

$ touch /var/lib/www/html/hello_world

```



If something does not work as expected, check the troubleshooting section below.



# Additional configuration

## Mounter

## Additional configuration



### Mounter



As S3 is not a real file system there are some limitations to consider here. Depending on what mounter you are using, you will have different levels of POSIX compability. Also depending on what S3 storage backend you are using there are not always [consistency guarantees](https://github.com/gaul/are-we-consistent-yet#observed-consistency).



The driver can be configured to use one of these mounters to mount buckets:
@@ -77,37 +93,32 @@ The driver can be configured to use one of these mounters to mount buckets: 
* [rclone](https://rclone.org/commands/rclone_mount)

* [s3fs](https://github.com/s3fs-fuse/s3fs-fuse)

* [goofys](https://github.com/kahing/goofys)

* [s3ql](https://github.com/s3ql/s3ql)

* [s3backer](https://github.com/archiecobbs/s3backer)



The mounter can be set as a parameter in the storage class. You can also create multiple storage classes for each mounter if you like.



All mounters have different strengths and weaknesses depending on your use case. Here are some characteristics which should help you choose a mounter:



### rclone

#### rclone



* Almost full POSIX compatibility (depends on caching mode)

* Files can be viewed normally with any S3 client



### s3fs

#### s3fs



* Large subset of POSIX

* Files can be viewed normally with any S3 client

* Does not support appends or random writes



### goofys

#### goofys



* Weak POSIX compatibility

* Performance first

* Files can be viewed normally with any S3 client

* Does not support appends or random writes



### s3ql

* (Almost) full POSIX compatibility

* Uses its own object format

* Files are not readable with other S3 clients

* Support appends

* Supports compression before upload

* Supports encryption before upload

#### s3backer (experimental*)



### s3backer

* Represents a block device stored on S3

* Allows to use a real filesystem

* Files are not readable with other S3 clients
@@ -115,33 +126,48 @@ All mounters have different strengths and weaknesses depending on your use case. 
* Supports compression before upload (Not yet implemented in this driver)

* Supports encryption before upload (Not yet implemented in this driver)



*s3backer is experimental at this point because volume corruption can occur pretty quickly in case of an unexpected shutdown of a Kubernetes node or CSI pod.

The s3backer binary is not bundled with the normal docker image to keep that as small as possible. Use the `<version>-full` image tag for testing s3backer.



Fore more detailed limitations consult the documentation of the different projects.



# Troubleshooting

## Issues while creating PVC

* Check the logs of the provisioner:

```

$ kubectl logs -l app=csi-provisioner-s3 -c csi-s3

```

## Troubleshooting



### Issues while creating PVC



Check the logs of the provisioner:



## Issues creating containers

* Ensure feature gate `MountPropagation` is not set to `false`

* Check the logs of the s3-driver:

```bash

kubectl logs -l app=csi-provisioner-s3 -c csi-s3

```

$ kubectl logs -l app=csi-s3 -c csi-s3



### Issues creating containers



1. Ensure feature gate `MountPropagation` is not set to `false`

2. Check the logs of the s3-driver:



```bash

kubectl logs -l app=csi-s3 -c csi-s3

```



# Development

## Development



This project can be built like any other go application.



```bash

$ go get -u github.com/ctrox/csi-s3

go get -u github.com/ctrox/csi-s3

```

## Build



### Build executable



```bash

$ make build

make build

```

## Tests



### Tests



Currently the driver is tested by the [CSI Sanity Tester](https://github.com/kubernetes-csi/csi-test/tree/master/pkg/sanity). As end-to-end tests require S3 storage and a mounter like s3fs, this is best done in a docker container. A Dockerfile and the test script are in the `test` directory. The easiest way to run the tests is to just use the make command:



```bash

$ make test

make test

```

cmd/s3driver/Dockerfile

+10 −58
Original line number Diff line number Diff line 
FROM python:3.6 as s3ql-deps

FROM debian:stretch

LABEL maintainers="Cyrill Troxler <cyrilltroxler@gmail.com>"

LABEL description="s3ql dependencies"

LABEL description="csi-s3 slim image"



# s3fs and some other dependencies

RUN apt-get update && \

  apt-get install -y \

       python3 python3-setuptools \

      python3-dev python3-pip pkg-config cython \

      libfuse-dev libattr1-dev && \

  s3fs curl unzip && \

  rm -rf /var/lib/apt/lists/*



RUN pip3 install llfuse apsw defusedxml dugong requests pycrypto



FROM debian:stretch as s3backer

ARG S3BACKER_VERSION=1.5.0



RUN apt-get update && apt-get install -y \

  build-essential \

  autoconf \

  libcurl4-openssl-dev \

  libfuse-dev \

  libexpat1-dev \

  libssl-dev \

  zlib1g-dev \

  psmisc \

  pkg-config \

  git && \

  rm -rf /var/lib/apt/lists/*



# Compile & install s3backer

RUN git clone https://github.com/archiecobbs/s3backer.git /src/s3backer

WORKDIR /src/s3backer

RUN git checkout tags/${S3BACKER_VERSION}



RUN ./autogen.sh && \

    ./configure && \

    make && \

    make install



FROM python:3.6-slim

LABEL maintainers="Cyrill Troxler <cyrilltroxler@gmail.com>"

LABEL description="csi-s3 production image"



RUN apt-get update && \

    apt-get install -y \

      libfuse2 gcc sqlite3 libsqlite3-dev \

      s3fs psmisc procps libcurl3 xfsprogs wget unzip && \

    rm -rf /var/lib/apt/lists/*



ARG S3QL_VERSION=2.29

ENV S3QL_URL=https://github.com/s3ql/s3ql/releases/download/release-${S3QL_VERSION}/s3ql-${S3QL_VERSION}.tar.bz2



COPY --from=s3ql-deps /root/.cache /root/.cache

COPY --from=s3ql-deps /usr/local/lib/python3.6/site-packages /usr/local/lib/python3.6/site-packages

RUN pip install ${S3QL_URL} && rm -rf /root/.cache



COPY --from=s3backer /usr/bin/s3backer /usr/bin/s3backer



# install rclone

ARG RCLONE_VERSION=v1.46

ARG RCLONE_VERSION=v1.47.0

RUN cd /tmp \

    && wget -q https://downloads.rclone.org/${RCLONE_VERSION}/rclone-${RCLONE_VERSION}-linux-amd64.zip \

  && curl -O https://downloads.rclone.org/${RCLONE_VERSION}/rclone-${RCLONE_VERSION}-linux-amd64.zip \

  && unzip /tmp/rclone-${RCLONE_VERSION}-linux-amd64.zip \

  && mv /tmp/rclone-*-linux-amd64/rclone /usr/bin \

  && rm -r /tmp/rclone*

cmd/s3driver/Dockerfile.full

0 → 100644
+48 −0
Original line number Diff line number Diff line 
FROM debian:stretch as s3backer

ARG S3BACKER_VERSION=1.5.0



RUN apt-get update && apt-get install -y \

  build-essential \

  autoconf \

  libcurl4-openssl-dev \

  libfuse-dev \

  libexpat1-dev \

  libssl-dev \

  zlib1g-dev \

  psmisc \

  pkg-config \

  git && \

  rm -rf /var/lib/apt/lists/*



# Compile & install s3backer

RUN git clone https://github.com/archiecobbs/s3backer.git /src/s3backer

WORKDIR /src/s3backer

RUN git checkout tags/${S3BACKER_VERSION}



RUN ./autogen.sh && \

  ./configure && \

  make && \

  make install



FROM debian:stretch

LABEL maintainers="Cyrill Troxler <cyrilltroxler@gmail.com>"

LABEL description="csi-s3 image"

COPY --from=s3backer /usr/bin/s3backer /usr/bin/s3backer



# s3fs and some other dependencies

RUN apt-get update && \

  apt-get install -y \

  libfuse2 gcc sqlite3 libsqlite3-dev \

  s3fs psmisc procps libcurl3 xfsprogs curl unzip && \

  rm -rf /var/lib/apt/lists/*



# install rclone

ARG RCLONE_VERSION=v1.47.0

RUN cd /tmp \

  && curl -O https://downloads.rclone.org/${RCLONE_VERSION}/rclone-${RCLONE_VERSION}-linux-amd64.zip \

  && unzip /tmp/rclone-${RCLONE_VERSION}-linux-amd64.zip \

  && mv /tmp/rclone-*-linux-amd64/rclone /usr/bin \

  && rm -r /tmp/rclone*



COPY ./_output/s3driver /s3driver

ENTRYPOINT ["/s3driver"]

cmd/s3driver/main.go

+3 −18
Original line number Diff line number Diff line
@@ -31,27 +31,12 @@ func init() { 
var (

	endpoint = flag.String("endpoint", "unix://tmp/csi.sock", "CSI endpoint")

	nodeID   = flag.String("nodeid", "", "node id")

	accessKeyID     = flag.String("access-key-id", "", "S3 Access Key ID to use")

	secretAccessKey = flag.String("secret-access-key", "", "S3 Secret Access Key to use")

	s3endpoint      = flag.String("s3-endpoint", "", "S3 Endpoint URL to use")

	region          = flag.String("region", "", "S3 Region to use")

	mounter         = flag.String("mounter", "s3fs", "Specify which Mounter to use")

	encryptionKey   = flag.String("encryption-key", "", "Encryption key for file system (only used with s3ql)")

)



func main() {

	flag.Parse()



	cfg := &s3.Config{

		AccessKeyID:     *accessKeyID,

		SecretAccessKey: *secretAccessKey,

		Endpoint:        *s3endpoint,

		Region:          *region,

		Mounter:         *mounter,

		EncryptionKey:   *encryptionKey,

	}



	driver, err := s3.NewS3(*nodeID, *endpoint, cfg)

	driver, err := s3.NewS3(*nodeID, *endpoint)

	if err != nil {

		log.Fatal(err)

	}