Skip to content

Commit

Permalink
EdgeFS: last minute doc changes for 1.2
Browse files Browse the repository at this point in the history
Signed-off-by: Dmitry Yusupov <[email protected]>
  • Loading branch information
Dmitry Yusupov committed Dec 18, 2019
1 parent c80bf67 commit 6ebcc52
Show file tree
Hide file tree
Showing 3 changed files with 65 additions and 28 deletions.
83 changes: 59 additions & 24 deletions Documentation/edgefs-cluster-crd.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,18 +19,11 @@ metadata:
name: rook-edgefs
namespace: rook-edgefs
spec:
edgefsImageName: edgefs/edgefs:1.2.64
edgefsImageName: edgefs/edgefs:latest
serviceAccount: rook-edgefs-cluster
dataDirHostPath: /data
storage:
useAllNodes: true
# A key/value list of annotations
annotations:
# all:
# key: value
# prepare:
# mgr:
# target:
useAllNodes: true # use only for test deployments
```
or if you have raw block devices provisioned, it can dynamically detect, format and utilize all raw devices on all nodes with simple CRD as below:
Expand All @@ -42,19 +35,61 @@ metadata:
name: rook-edgefs
namespace: rook-edgefs
spec:
edgefsImageName: edgefs/edgefs:1.2.64
edgefsImageName: edgefs/edgefs:latest
serviceAccount: rook-edgefs-cluster
dataDirHostPath: /data
storage:
useAllNodes: true
useAllNodes: true # use only for test deployments
useAllDevices: true
# A key/value list of annotations
annotations:
# all:
# key: value
# prepare:
# mgr:
# target:
```
or if you want to just install it on **single node1, single SSD device /dev/sdb**, use this sample:
```yaml
apiVersion: edgefs.rook.io/v1
kind: Cluster
metadata:
name: rook-edgefs
namespace: rook-edgefs
spec:
edgefsImageName: edgefs/edgefs:latest
serviceAccount: rook-edgefs-cluster
dataDirHostPath: /data
sysRepCount: 1
failureDomain: "device"
storage:
useAllNodes: false
useAllDevices: false
config:
useAllSSD: "true"
useMetadataOffload: "false"
nodes:
- name: "node1"
devices:
- name: "sdb"
```
or if you want to just install it on **single node1, single directory /media**, use this sample:
```yaml
apiVersion: edgefs.rook.io/v1
kind: Cluster
metadata:
name: rook-edgefs
namespace: rook-edgefs
spec:
edgefsImageName: edgefs/edgefs:latest
serviceAccount: rook-edgefs-cluster
dataDirHostPath: /data
sysRepCount: 1
failureDomain: "device"
storage:
useAllNodes: false
useAllDevices: false
directories:
- path: /media # global for all nodes, cannot be per-node!
nodes:
- name: "node1"
```
In addition to the CRD, you will also need to create a namespace, role, and role binding as seen in the [common cluster resources](#common-cluster-resources) below.
Expand All @@ -67,7 +102,7 @@ Settings can be specified at the global level to apply to the cluster as a whole
- `name`: The name that will be used internally for the EdgeFS cluster. Most commonly the name is the same as the namespace since multiple clusters are not supported in the same namespace.
- `namespace`: The Kubernetes namespace that will be created for the Rook cluster. The services, pods, and other resources created by the operator will be added to this namespace. The common scenario is to create a single Rook cluster. If multiple clusters are created, they must not have conflicting devices or host paths.
- `edgefsImageName`: EdgeFS image to use. If not specified then `edgefs/edgefs:latest` is used. We recommend to specify particular image version for production use, for example `edgefs/edgefs:1.2.64`.
- `edgefsImageName`: EdgeFS image to use. If not specified then `edgefs/edgefs:latest` is used. We recommend to specify particular image version for production use, for example `edgefs/edgefs:1.2.124`.

### Cluster Settings

Expand Down Expand Up @@ -239,7 +274,7 @@ metadata:
name: rook-edgefs
namespace: rook-edgefs
spec:
edgefsImageName: edgefs/edgefs:1.2.64
edgefsImageName: edgefs/edgefs:latest
dataDirHostPath: /var/lib/rook
serviceAccount: rook-edgefs-cluster
# cluster level storage configuration and selection
Expand All @@ -264,7 +299,7 @@ metadata:
name: rook-edgefs
namespace: rook-edgefs
spec:
edgefsImageName: edgefs/edgefs:1.2.64
edgefsImageName: edgefs/edgefs:latest
dataDirHostPath: /var/lib/rook
serviceAccount: rook-edgefs-cluster
# cluster level storage configuration and selection
Expand Down Expand Up @@ -409,7 +444,7 @@ metadata:
name: rook-edgefs
namespace: rook-edgefs
spec:
edgefsImageName: edgefs/edgefs:1.2.64
edgefsImageName: edgefs/edgefs:latest
dataDirHostPath: /var/lib/rook
serviceAccount: rook-edgefs-cluster
placement:
Expand Down Expand Up @@ -445,7 +480,7 @@ metadata:
name: rook-edgefs
namespace: rook-edgefs
spec:
edgefsImageName: edgefs/edgefs:1.2.64
edgefsImageName: edgefs/edgefs:latest
dataDirHostPath: /var/lib/rook
serviceAccount: rook-edgefs-cluster
# cluster level resource requests/limits configuration
Expand Down Expand Up @@ -474,7 +509,7 @@ metadata:
name: rook-edgefs
namespace: rook-edgefs
spec:
edgefsImageName: edgefs/edgefs:1.2.64
edgefsImageName: edgefs/edgefs:latest
dataDirHostPath: /var/lib/rook
serviceAccount: rook-edgefs-cluster
network:
Expand Down
8 changes: 5 additions & 3 deletions Documentation/edgefs-quickstart.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
---
title: EdgeFS Geo-Transparent Storage
title: EdgeFS Data Fabric
weight: 550
indent: true
---

{% include_relative branch.liquid %}

# EdgeFS Geo-Transparent Storage Quickstart
# EdgeFS Data Fabric Quickstart

EdgeFS Data Fabric virtualzing common storage protocols and enables multi-cluster, multi-region data flow topologies.

This guide will walk you through the basic setup of a EdgeFS cluster namespaces and enable you to consume S3 object, NFS file access, and iSCSI block storage
from other pods running in your cluster, in Geo-Transparent and distributed ways.
from other pods running in your cluster, in decentralized ways.

## Minimum Version

Expand Down
2 changes: 1 addition & 1 deletion Documentation/edgefs-upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ The majority of the upgrade will be handled by the Rook operator. Begin the upgr
EdgeFS image field in the cluster CRD (`spec:edgefsImageName`).

```console
NEW_EDGEFS_IMAGE='edgefs/edgefs:1.2.64'
NEW_EDGEFS_IMAGE='edgefs/edgefs:latest'
kubectl -n $CLUSTER_NAME patch Cluster $CLUSTER_NAME --type=merge \
-p "{\"spec\": {\"edgefsImageName\": \"$NEW_EDGEFS_IMAGE\"}}"
```
Expand Down

0 comments on commit 6ebcc52

Please sign in to comment.