ridv/katbox
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Rewrites the README to reflect some changes the project has gone under.

Browse source
This commit is contained in:
Renán Del Valle 2021-04-12 14:49:58 -07:00
parent 4c764e09a4
commit efc024947c
No known key found for this signature in database
GPG key ID: C240AD6D6F443EC9
1 changed files with 6 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -1,4 +1,4 @@
# CSI Katbox Driver
# Katbox
Katbox is an inline ephemeral volume manager with delayed deletion for Kubernetes.
@ -15,18 +15,19 @@ Deployment varies depending on the Kubernetes version your cluster is running:
- [Deployment for Kubernetes 1.18 and later](docs/deploy-1.18-and-later.md)
## Examples
The following examples assume that the CSI Katbox driver has been deployed and validated:
- [Inline ephemeral volumes](docs/example-ephemeral.md)
Assuming katbox has been successfully deployed, the following example can be run using `kubectl`:
`$ kubectl apply -f https://raw.githubusercontent.com/paypal/katbox/main/examples/csi-app-inline.yaml`
## Building the binaries
If you want to build the driver yourself, you can do so with the following command from the root directory:
To build the driver, run the following command from the root of the repository:
```shell
make
```
## Building a docker image
If you want to make a docker image to be used on a kubernetes cluster you may do so with the following command:
To build a docker image to be used on a kubernetes cluster, run the following command from the root of the repository:
```shell
docker build . -t <image name>