-
Notifications
You must be signed in to change notification settings - Fork 352
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(glasskube-doc): write the documentation about quickwit install w…
…ith Glasskube (#5071) Signed-off-by: Idriss Neumann <[email protected]>
- Loading branch information
1 parent
4b08c82
commit 74c4505
Showing
4 changed files
with
72 additions
and
1 deletion.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters