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

DBZ-8233 Expanded installation instruction in README #74

Merged
merged 1 commit into from
Sep 12, 2024
Merged

DBZ-8233 Expanded installation instruction in README #74

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 16 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,26 @@
Debezium operator provides an easy way to run the Debezium Server on Kubernetes or Openshift.

## Installation steps
The debezium operator currently support only per namespace installation unless installing via OLM. To install the operator to your kubernetes cluster,
simply create the descriptors available in the `k8` directory.
The operator can be installed via OLM, Helm chart or by creating the resources directly.

### Helm Chart Installation
Helm is the preferred way to install the operator releases. The operator is available in the [Debezium Helm Chart Repository](https://charts.debezium.io).

```bash
kubectl create -f k8/ -n $NAMESPACE
helm repo add debezium https://charts.debezium.io
helm install my-debezium-operator debezium/debezium-operator --version $DO_VERSION -n $NAMESPACE
```
Available versions can be found in the [Debezium Helm Chart Repository](https://charts.debezium.io/index.yaml).

### OLM Installation
Released versions of the operator can be installed via the Operator Lifecycle Manager (OLM). The operator is available in the [OperatorHub](https://operatorhub.io/operator/debezium-operator).

### Direct Installation
This method currently support only per namespace installation. To install the operator to your Kubernetes cluster, simply create the descriptors available in the `k8` directory.

_Note: In the future the operator will support OLM and Helm chart installations._
```bash
kubectl create -f k8/ -n $NAMESPACE
```

### Quickstart Example

Expand Down