Skip to content
This repository has been archived by the owner on Jul 22, 2024. It is now read-only.

Commit

Permalink
Update README to v2.0.0 (#257)
Browse files Browse the repository at this point in the history
- Align README file with version 2.0.0 (adding scale support, fix some syntax and new URL)
- improve the scale md file with up to date examples by @deeghuge
- Align glide with latest ubiquity
  • Loading branch information
shay-berman authored Dec 5, 2018
1 parent a59d81d commit d6ff33c
Show file tree
Hide file tree
Showing 4 changed files with 368 additions and 51 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,24 +7,26 @@ This project includes components for managing [Kubernetes persistent storage](ht
- Ubiquity Dynamic Provisioner for creating and deleting persistent volumes
- Ubiquity FlexVolume Driver CLI for attaching and detaching persistent volumes

Currently, the following storage systems use Ubiquity:
The IBM official solution for Kubernetes, based on the Ubiquity project, is referred to as IBM Storage Enabler for Containers. You can download the installation package and its documentation from [IBM Fix Central](http://www.ibm.com/support/fixcentral/swg/quickorder?parent=Software%20defined%20storage&product=ibm/StorageSoftware/IBM+Storage+Enabler+for+Containers&release=All&platform=All&function=all&source=fc).

Ubiquity supports the following storage systems:
* IBM block storage.

The IBM block storage is supported for Kubernetes via IBM Spectrum Connect (3.4.0), previously known as IBM Spectrum Control Base Edition. Ubiquity communicates with the IBM storage systems through Spectrum Connect. Spectrum Connect creates a storage profile (for example, gold, silver or bronze) and makes it available for Kubernetes. For details about supported storage systems, refer to the latest Spectrum Connect release notes.
IBM block storage is supported for Kubernetes via IBM Spectrum Connect. Ubiquity communicates with the IBM storage systems through Spectrum Connect. Spectrum Connect creates a storage profile (for example, gold, silver or bronze) and makes it available for Kubernetes.

The IBM official solution for Kubernetes, based on the Ubiquity project, is referred to as IBM Storage Enabler for Containers. You can download the installation package and its documentation from [IBM Fix Central](https://www.ibm.com/support/fixcentral/swg/selectFixes?parent=Software%2Bdefined%2Bstorage&product=ibm/StorageSoftware/IBM+Spectrum+Connect&release=All&platform=Linux&function=all). For details on the IBM Storage Enabler for Containers, see the relevant sections in the Spectrum Connect user guide.
* IBM Spectrum Scale

* IBM Spectrum Scale, for testing only.
IBM Spectrum Scale file storage is supported for Kubernetes. Ubiquity communicates with IBM Spectrum Scale system directly via IBM Spectrum Scale management API v2.

The code is provided as is, without warranty. Any issue will be handled on a best-effort basis.

## Solution overview

![Ubiquity Overview](images/ubiquity_architecture_draft_for_github.jpg)

Deployment description:
Main deployment description:
* Ubiquity Kubernetes Dynamic Provisioner (ubiquity-k8s-provisioner) runs as a Kubernetes deployment with replica=1.
* Ubiquity Kubernetes FlexVolume (ubiquity-k8s-flex) runs as a Kubernetes daemonset on all the worker and master nodes.
* Ubiquity Kubernetes FlexVolume (ubiquity-k8s-flex) runs as a Kubernetes daemonset in all the worker and master nodes.
* Ubiquity (ubiquity) runs as a Kubernetes deployment with replica=1.
* Ubiquity database (ubiquity-db) runs as a Kubernetes deployment with replica=1.

Expand Down
2 changes: 1 addition & 1 deletion glide.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ import:
subpackages:
- lib
- package: github.com/IBM/ubiquity
version: df516f6f4aa90b0a9836ae1f2e23dc2a43317ac4
version: f203222e3190aca3de0bf851316a2de3b68efcad
subpackages:
- remote
- resources
Expand Down
10 changes: 5 additions & 5 deletions ibm-block-storage-via-sc.md
Original file line number Diff line number Diff line change
Expand Up @@ -236,8 +236,8 @@ The creation of a Pod/Deployment causes the FlexVolume to:
* Attach the volume to the host (This action triggered from the controller-manager on the master node.)
* Rescan and discover the multipath device of the new volume
* Create xfs or ext4 filesystem on the device (if filesystem does not exist on the volume)
* Mount the new multipath device on /ubiquity/[WWN of the volume]
* Create a symbolic link /var/lib/kubelet/pods/[POD-ID]/volumes/ibm~ubiquity-k8s-flex/[PVC-ID] -> /ubiquity/[WWN of the volume]
* Mount the new multipath device on `/ubiquity/[WWN of the volume]`
* Create a symbolic link `/var/lib/kubelet/pods/[POD-ID]/volumes/ibm~ubiquity-k8s-flex/[PVC-ID]` -> `/ubiquity/[WWN of the volume]`
For example, to create a Pod `pod1` that uses the PVC `pvc1` that was already created:
```bash
Expand Down Expand Up @@ -310,8 +310,8 @@ lrwxrwxrwx. 1 root root 42 Aug 13 22:41 pvc-254e4b5e-805d-11e7-a42b-005056a46c49
### Deleting a Pod
The Kuberenetes delete Pod command:
* Removes symbolic link /var/lib/kubelet/pods/[POD-ID]/volumes/ibm~ubiquity-k8s-flex/[PVC-ID] -> /ubiquity/[WWN of the volume]
* Unmounts the new multipath device on /ubiquity/[WWN of the volume]
* Removes symbolic link `/var/lib/kubelet/pods/[POD-ID]/volumes/ibm~ubiquity-k8s-flex/[PVC-ID]` -> `/ubiquity/[WWN of the volume]`
* Unmounts the new multipath device on `/ubiquity/[WWN of the volume]`
* Removes the multipath device of the volume
* Detaches (unmaps) the volume from the host
* Rescans with cleanup mode to remove the physical device files of the detached volume
Expand Down Expand Up @@ -411,7 +411,7 @@ Filesystem Size Used Available Use% Mounted on
COOL
```

- Delete the POD so Kubernetes will reschedule the POD on a diffrent node (node1)
- Delete the POD so Kubernetes will reschedule the POD on a different node (node1)
```bash
#> kubectl delete pod $pod
pod "sanity-deployment-75f959859f-dh979" deleted
Expand Down
Loading

0 comments on commit d6ff33c

Please sign in to comment.