Skip to content

Commit

Permalink
Improve redis documents
Browse files Browse the repository at this point in the history
  • Loading branch information
the-redback committed Feb 14, 2018
1 parent 50da0e6 commit fb4f45d
Show file tree
Hide file tree
Showing 16 changed files with 1,330 additions and 379 deletions.
10 changes: 6 additions & 4 deletions docs/concepts/databases/redis.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,18 +78,20 @@ To learn how to configure `spec.storage`, please visit the links below:
### spec.doNotPause
`spec.doNotPause` is an optional field that tells KubeDB operator that if this Redis object is deleted, whether it should be reverted automatically. This should be set to `true` for production databases to avoid accidental deletion. If not set or set to false, deleting a Redis object put the database into a dormant state. The StatefulSet for a DormantDatabase is deleted but the underlying PVCs are left intact. This allows user to resume the database later.

### spec.imagePullSecret
`KubeDB` provides the flexibility of deploying Redis database from a Private Docker Registry. To learn how to deploym Redis from a Private Registry, please visit [here](/docs/guides/redis/private-registry/using-private-registry.md).

### spec.monitor
To learn how to monitor Redis databases, please visit [here](/docs/concepts/monitoring.md).

Redis can be monitored with KubeDB using out-of-the-box builtin-Prometheus and out-of-the-box CoreOS-Prometheus Operator. To learn more,
- [Monitor Redis with builtin-Prometheus](/docs/guides/redis/monitoring/using-builtin-prometheus.md)
- [Monitor Redis with CoreOS-Prometheus Operator](/docs/guides/redis/monitoring/using-coreos-prometheus-operator.md)

### spec.resources
`spec.resources` is an optional field. This can be used to request compute resources required by the database pods. To learn more, visit [here](http://kubernetes.io/docs/user-guide/compute-resources/).


## Next Steps
- Learn how to use KubeDB to run a Redis database [here](/docs/guides/redis/overview.md).
- See the list of supported storage providers for snapshots [here](/docs/concepts/snapshot.md).
- Learn how to use KubeDB to run a Redis database [here](/docs/guides/redis/README.md).
- Thinking about monitoring your database? KubeDB works [out-of-the-box with Prometheus](/docs/guides/monitoring.md).
- Learn how to use KubeDB in a [RBAC](/docs/guides/rbac.md) enabled cluster.
- Wondering what features are coming next? Please visit [here](/docs/roadmap.md).
Expand Down
16 changes: 16 additions & 0 deletions docs/examples/redis/monitoring/builtin-prometheus/demo-1.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
apiVersion: kubedb.com/v1alpha1
kind: Redis
metadata:
name: redis-mon-prometheus
namespace: demo
spec:
version: 4
storage:
storageClassName: "standard"
accessModes:
- ReadWriteOnce
resources:
requests:
storage: 50Mi
monitor:
agent: prometheus.io/builtin
22 changes: 22 additions & 0 deletions docs/examples/redis/monitoring/coreos-operator/demo-1.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
apiVersion: kubedb.com/v1alpha1
kind: Redis
metadata:
name: redis-mon-coreos
namespace: demo
spec:
version: 4
storage:
storageClassName: "standard"
accessModes:
- ReadWriteOnce
resources:
requests:
storage: 50Mi
monitor:
agent: prometheus.io/coreos-operator
prometheus:
namespace: demo
labels:
app: kubedb
interval: 10s

8 changes: 8 additions & 0 deletions docs/examples/redis/private-registry/demo-1.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
apiVersion: v1
kind: Secret
metadata:
name: myregistrykey
namespace: demo
data:
.dockerconfigjson: <base-64-encoded-json-here>
type: kubernetes.io/dockerconfigjson
17 changes: 17 additions & 0 deletions docs/examples/redis/private-registry/demo-2.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
apiVersion: kubedb.com/v1alpha1
kind: Redis
metadata:
name: redis-pvt-reg
namespace: demo
spec:
version: 4
doNotPause: true
storage:
storageClassName: "standard"
accessModes:
- ReadWriteOnce
resources:
requests:
storage: 50Mi
imagePullSecrets:
- name: myregistrykey
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
apiVersion: kubedb.com/v1alpha1
kind: Redis
metadata:
name: r1
name: redis-quickstart
namespace: demo
spec:
version: 4
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Guides show you how to perform tasks with KubeDB.

- [Running MongoDB](/docs/guides/mongodb/overview.md): This tutorial will show you how to use KubeDB to run a MongoDB database.

- [Running Redis](/docs/guides/redis/overview.md): This tutorial will show you how to use KubeDB to run a Redis database.
- [Running Redis](/docs/guides/redis/README.md): This tutorial will show you how to use KubeDB to run a Redis database.

- [Running Memcached](/docs/guides/memcached/overview.md): This tutorial will show you how to use KubeDB to run a Memcached database.

Expand Down
43 changes: 43 additions & 0 deletions docs/guides/redis/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@


> New to KubeDB? Please start [here](/docs/guides/README.md).
## Redis versions supported by KubeDB

| KubeDB Version | Redis:4 |
|:--:|:--:|
| 0.1.0 - 0.7.0 | &#10007; |
| 0.8.0-beta.0 | &#10003; |
| 0.8.0-beta.1 | &#10003; |

<br/>

## KubeDB Features and their availability for Redis

|Features |Availability|
|--|:--:|
|Clustering | &#10007; |
|Instant Backup | &#10007; |
|Scheduled Backup | &#10007; |
|Initialize using Snapshot | &#10007; |
|Initialize using Script | &#10007; |
|Persistent Volume | &#10003; |
|out-of-the-box builtin-Prometheus Monitoring | &#10003; |
|out-of-the-box CoreOS-Prometheus-Operator Monitoring | &#10003; |

<br/>

## Life Cycle of Redis in KubeDB
<p align="center">
  <img alt="lifecycle" src="/docs/images/redis/redis-lifecycle.png" width="600" height="373">
</p>


## User Guide
- [Quickstart Redis](/docs/guides/redis/quickstart/quickstart.md) with KubeDB Operator.
- Monitor your Redis database with KubeDB using [out-of-the-box CoreOS Prometheus Operator](/docs/guides/redis/monitoring/using-coreos-prometheus-operator.md).
- Monitor your Redis database with KubeDB using [out-of-the-box builtin-Prometheus](/docs/guides/redis/monitoring/using-builtin-prometheus.md).
- Use [Private Docker Registry](/docs/guides/redis/private-registry/using-private-registry.md) to deploy Redis with KubeDB.
- Detail concepts of [Redis object](/docs/concepts/databases/redis.md).
- Wondering what features are coming next? Please visit [here](/docs/roadmap.md).
- Want to hack on KubeDB? Check our [contribution guidelines](/docs/CONTRIBUTING.md).
Loading

0 comments on commit fb4f45d

Please sign in to comment.