Skip to content

Commit

Permalink
feat(glasskube-doc): write the documentation about quickwit install w…
Browse files Browse the repository at this point in the history
…ith Glasskube (#5071)

Signed-off-by: Idriss Neumann <[email protected]>
  • Loading branch information
idrissneumann authored and fulmicoton committed Jul 5, 2024
1 parent 4b08c82 commit 74c4505
Show file tree
Hide file tree
Showing 4 changed files with 72 additions and 1 deletion.
Binary file added docs/assets/images/screenshot-glasskube-ui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/deployment/cluster-sizing.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Cluster sizing
sidebar_position: 2
sidebar_position: 3
---

In this guide, we discuss how to size your Quickwit cluster and nodes. As shown
Expand Down
70 changes: 70 additions & 0 deletions docs/deployment/kubernetes/glasskube.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
---
title: Glasskube
sidebar_position: 3
---

[Glasskube](https://glasskube.dev) is a package manager for Kubernetes that empowers you to effortlessly install, upgrade, configure, and manage your Kubernetes cluster packages, all while streamlining repetitive and cumbersome maintenance tasks.

# Install Quickwit using Glasskube

## Requirements

To deploy Quickwit on Kubernetes, you will need:

- kubectl, compatible with your cluster (+/- 1 minor release from your cluster) (`kubectl version`)
- A Kubernetes cluster

1. Install `kubectl` and `glasskube` cli.

To install `kubectl` locally, you can refere to [this documentation](https://kubernetes.io/docs/tasks/tools/#install-kubectl).

To install `glasskube` cli locally, you can refer to [this documentation](https://glasskube.dev/docs/getting-started/install) and choose the right installation options according to your operating system.

For example, let's assume that you're on MacOS using homebrew and kind, this is what you'll have to do:

```shell
brew install glasskube/tap/glasskube # install the glasskube cli
kind create cluster # create a kind Kubernetes cluster
```

2. Install glasskube in your Kubernetes cluster:

```shell
glasskube bootstrap
```

3. Start and access to the Glasskube's GUI:

```shell
glasskube serve
```

You'll be able to access to the GUI of Glasskube here: http://localhost:8580

## Install Quickwit using Glasskube

`glasskube` will install Quickwit in the `quickwit` namespace. You can perform the Quickwit installation directly with the GUI:

![screenshot-glasskube-ui.png](../../assets/images/screenshot-glasskube-ui.png)

Or use the CLI instead:

```shell
glasskube install quickwit
```

In both, you'll have to set the value of thoses parameters:

* `defaultIndexRootUri`: the default index URI is a S3 compliant bucket which usually looks like this: `s3://<bucket-name>/<optional-base-path>`
* `metastoreUri`: if you're not using PostgreSQL and object storage, you can pick the same bucket and value you used for the `defaultIndexRootUri` parameter
* `s3Endpoint`: the http(s) URL of your object storage service which should looks like `https://s3.{region}.{your object storage domain}`
* `s3Flavor`: which can be one of the following: `do`, `garage`, `gcp`, `minio`. You can leave it empty if your object storage is compliant with AWS S3
* `s3Region`
* `s3AccessKeyId`
* `s3SecretAccessKey`

## Uninstall quickwit

```shell
glasskube uninstall quickwit
```
1 change: 1 addition & 0 deletions docs/get-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ Quickwit compiles to a single binary and we provide different methods to install
- Linux/MacOS binaries that you can [download manually](#download) or with the [install script](#install-script)
- [Docker image](#use-the-docker-image)
- [Helm chart](../deployment/kubernetes/helm.md)
- [Glasskube](../deployment/kubernetes/glasskube.md)

## Prerequisites

Expand Down

0 comments on commit 74c4505

Please sign in to comment.