f3a3e97618
Initialize mkdocs for serving documentation on GitHub pages On push to ms-3 branch a workflow publishes the documentation to gh-pages which gets served by GitHub The content is based on README.md
30 lines
989 B
Markdown
30 lines
989 B
Markdown
# Getting started
|
|
|
|
## Requirements
|
|
|
|
- `kubectl` need to be installed and configured properly so that `kubectl` can connect to the kubernetes cluser. The `qliksense` CLI uses `kubectl` under the hood to perform operations on cluster
|
|
- (Docker Desktop setup tested for these instructions)
|
|
|
|
## Download
|
|
|
|
- Download the appropriate executable for your platform from the [releases page](https://github.com/qlik-oss/sense-installer/releases) and rename it to `qliksense`. All the examplease down below uses `qliksense`.
|
|
|
|
## Quick start
|
|
|
|
- To download the version `v0.0.2` from qliksense-k8s [releases](https://github.com/qlik-oss/qliksense-k8s/releases).
|
|
|
|
```shell
|
|
$qliksense fetch v0.0.2
|
|
```
|
|
|
|
- To install CRDs for QSEoK and qliksense operator into the kubernetes cluster.
|
|
|
|
```shell
|
|
$qliksense crds install --all
|
|
```
|
|
|
|
- To install QSEoK into a namespace in the kubernetes cluster where `kubectl` is pointing to.
|
|
|
|
```shell
|
|
$qliksense install --acceptEULA="yes"
|
|
``` |