Skip to content

Commit

Permalink
Add SingleStore Provisioner Doc
Browse files Browse the repository at this point in the history
Signed-off-by: ashraful <[email protected]>
  • Loading branch information
AshrafulHaqueToni committed Jan 23, 2024
1 parent 9722677 commit 20ec8a1
Show file tree
Hide file tree
Showing 6 changed files with 106 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/guides/kafka/concepts/catalog.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,8 @@ spec:
version: 3.4.0
cruiseControl:
image: ghcr.io/kubedb/cruise-control:3.4.0
connectCluster:
image: ghcr.io/appscode-images/kafka-connect-cluster:3.6.0
```
### metadata.name
Expand Down
40 changes: 40 additions & 0 deletions docs/guides/singlestore/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
title: SingleStore
menu:
docs_{{ .version }}:
identifier: guides-singlestore-readme
name: SingleStore
parent: guides-singlestore
weight: 10
menu_name: docs_{{ .version }}
section_menu_id: guides
url: /docs/{{ .version }}/guides/singlestore/
aliases:
- /docs/{{ .version }}/guides/singlestore/README/
---
> New to KubeDB? Please start [here](/docs/README.md).
## Supported SingleStore Features

| Features | Availability |
|---------------------------------------------------------|:------------:|
| Clustering | &#10003; |
| Authentication & Authorization | &#10003; |
| Initialize using Script (\*.sql, \*sql.gz and/or \*.sh) | &#10003; |
| Custom Configuration | &#10003; |
| Externally manageable Auth Secret | &#10003; |
| Reconfigurable Health Checker | &#10003; |
| Persistent volume | &#10003; |

## Supported SingleStore Versions

KubeDB supports the following SingleSore Versions.
- `8.1.32`

## Life Cycle of a SingleStore Object

<p align="center">
  <img alt="lifecycle" src="/docs/guides/singlestore/images/singlestore-lifecycle.png" >
</p>

## User Guide
10 changes: 10 additions & 0 deletions docs/guides/singlestore/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: SingleStore
menu:
docs_{{ .version }}:
identifier: guides-singlestore
name: SingleStore
parent: guides
weight: 40
menu_name: docs_{{ .version }}
---
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
54 changes: 54 additions & 0 deletions docs/guides/singlestore/quickstart/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
title: SingleStore Quickstart
menu:
docs_{{ .version }}:
identifier: guides-singlestore-quickstart
name: Quickstart
parent: guides-singletore
weight: 15
menu_name: docs_{{ .version }}
section_menu_id: guides
---

> New to KubeDB? Please start [here](/docs/README.md).
# SingleStore QuickStart

This tutorial will show you how to use KubeDB to run a SingleStore database.

<p align="center">
  <img alt="lifecycle" src="/docs/guides/singlestore/quickstart/images/singlestore-lifecycle.png">
</p>

> Note: The yaml files used in this tutorial are stored in [docs/guides/singlestore/quickstart/yamls](https://github.com/kubedb/docs/tree/{{< param "info.version" >}}/docs/guides/singlestore/quickstart/yamls) folder in GitHub repository [kubedb/docs](https://github.com/kubedb/docs).
## Before You Begin

- At first, you need to have a Kubernetes cluster, and the kubectl command-line tool must be configured to communicate with your cluster. If you do not already have a cluster, you can create one by using [kind](https://kind.sigs.k8s.io/docs/user/quick-start/).

- Now, install KubeDB cli on your workstation and KubeDB operator in your cluster following the steps [here](/docs/setup/README.md).

- [StorageClass](https://kubernetes.io/docs/concepts/storage/storage-classes/) is required to run KubeDB. Check the available StorageClass in cluster.

```bash
$ kubectl get storageclasses
NAME PROVISIONER RECLAIMPOLICY VOLUMEBINDINGMODE ALLOWVOLUMEEXPANSION AGE
standard (default) rancher.io/local-path Delete WaitForFirstConsumer false 6h22m
```

- To keep things isolated, this tutorial uses a separate namespace called `demo` throughout this tutorial.

```bash
$ kubectl create ns demo
namespace/demo created
```

## Find Available SingleStoreVersion

When you have installed KubeDB, it has created `SinglestoreVersion` crd for all supported SingleStore versions. Check it by using the following command,

```bash
$ kubectl get singlestoreversions
NAME VERSION DB_IMAGE DEPRECATED AGE
8.1.32 8.1.32 singlestore/node:alma-8.1.32-e3d3cde6da 27h
```
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 20ec8a1

Please sign in to comment.