Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Kubernetes version table. #838

Merged
merged 4 commits into from
Dec 22, 2021
Merged

Kubernetes version table. #838

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ba37cef
Kubernetes version table.
johnhummelAltinity Dec 20, 2021
c27732a
Updated Kubernetes to 1.22
johnhummelAltinity Dec 21, 2021
6559447
Delete settings.json
johnhummelAltinity Dec 21, 2021
37c1605
Corrections to <0.16.0
johnhummelAltinity Dec 21, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 22 additions & 2 deletions docs/operator_installation_details.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,27 @@
# Install ClickHouse Operator

Verify [clickhouse-operator-install-bundle.yaml][clickhouse-operator-install-bundle.yaml] file availability.
# Prerequisites

1. Kubernetes instance with the following version considerations:
1. `clickhouse-operator` versions **before** `0.16.0` is compatible with [Kubenetes after `1.16` and prior `1.22`](https://kubernetes.io/releases/).
1. `clickhouse-operator` versions `0.16.0` **and after** is compatible [Kubernetes version `1.16` and after](https://kubernetes.io/releases/).
1. Properly configured `kubectl`
1. `curl`

Verify the Docker manifest is available based on the version table, replacing `{OPERATOR_VERSION}` with the specific version. For example, for version `0.16.0`, the URL would be `https://github.com/Altinity/clickhouse-operator/raw/0.16.0/deploy/operator/clickhouse-operator-install-bundle.yaml`.

| `clickhouse-operator` version | Kubernetes version | Docker manifest URL |
|---|---|---|
| Current | Kubernetes 1.16+ | https://raw.githubusercontent.com/Altinity/clickhouse-operator/master/deploy/operator/clickhouse-operator-install-bundle.yaml |
| Current | Kubernetes before 1.16 | **(Beta)** https://github.com/Altinity/clickhouse-operator/raw/master/deploy/operator/clickhouse-operator-install-bundle-v1beta1.yaml |
| `0.16.0` and greater | Kubernetes 1.16+ | https://github.com/Altinity/clickhouse-operator/raw/{OPERATOR_VERSION}/deploy/operator/clickhouse-operator-install-bundle.yaml |
| Before `0.16.0` | Kubernetes after 1.16 and before 1.22 | kubectl apply -f https://github.com/Altinity/clickhouse-operator/raw/{OPERATOR_VERSION}/deploy/operator/clickhouse-operator-install.yaml |

[clickhouse-operator-install-bundle.yaml][clickhouse-operator-install-bundle.yaml] file availability.
In is located in `deploy/operator` folder inside `clickhouse-operator` sources.

## Install

Operator installation process is quite straightforward and consists of one main step - deploy **ClickHouse operator**.
We'll apply operator manifest directly from github repo
```bash
Expand All @@ -19,7 +37,9 @@ deployment.apps/clickhouse-operator configured
```

## Verify operator is up and running
Operator is deployed in **kube-system** namespace

Operator is deployed in **kube-system** namespace.

```bash
kubectl get pods --namespace kube-system
```
Expand Down
7 changes: 6 additions & 1 deletion docs/quick_start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Quick Start Guides

# Table of Contents

* [Prerequisites](#prerequisites)
* [ClickHouse Operator Installation](#clickhouse-operator-installation)
* [Building ClickHouse Operator from Sources](#building-clickhouse-operator-from-sources)
* [Examples](#examples)
Expand All @@ -11,7 +13,10 @@
* [Custom Deployment with Specific ClickHouse Configuration](#custom-deployment-with-specific-clickhouse-configuration)

# Prerequisites
1. Operational Kubernetes instance

1. Kubernetes instance with the following version considerations:
1. `clickhouse-operator` versions **before** `0.16.0` is compatible with [Kubenetes after `1.16` and prior `1.22`](https://kubernetes.io/releases/).
1. `clickhouse-operator` versions `0.16.0` **and after** is compatible [Kubernetes version `1.16` and after](https://kubernetes.io/releases/).
1. Properly configured `kubectl`
1. `curl`

Expand Down