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.

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

issue-106, using Instaclustr with Kubernetes doc was added #346

Merged
merged 1 commit into from
Mar 14, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions doc/clusters/cadence.md
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,9 @@ kubectl describe cadences.clusters.instaclustr.com cadence-sample

After you have applied the entity, the Instaclustr operator will create it on your K8s cluster and send a request to the Instaclustr API. You can be sure, that the resource creation call was sent if the instance has an id field filled in the status section.

You can check access to the created cluster from your kubernetes cluster and run some simple command to check that it is working with a lot of tools.
All available tools you can find in the Instaclustr console -> Choose your cluster -> Connection Info -> Examples section.

## Cluster update flow
To update a cluster you can apply an updated cluster manifest or edit the custom resource instance in kubernetes cluster:
* Apply an updated cluster manifest:
Expand Down
4 changes: 4 additions & 0 deletions doc/clusters/cassandra.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,10 @@ kubectl describe cassandras.clusters.instaclustr.com cassandra-sample

After you have applied the entity, the Instaclustr operator will create it on your K8s cluster and send a request to the Instaclustr API. You can be sure, that the resource creation call was sent if the instance has an id field filled in the status section.

You can check access to the created Cassandra cluster from your kubernetes cluster and run some simple command to check that it is working with a lot of tools.
All available tools you can find in the Instaclustr console -> Choose your cluster -> Connection Info -> Examples section.
For example, how to connect with cqlsh tool you can see in [this doc](https://www.instaclustr.com/support/documentation/cassandra/using-cassandra/connect-to-cassandra-using-cqlsh/).

Comment on lines +120 to +123
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's add this info for all resources

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added

## Cluster update flow
To update a cluster you can apply an updated cluster manifest or edit the custom resource instance in kubernetes cluster:
* Apply an updated cluster manifest:
Expand Down
4 changes: 4 additions & 0 deletions doc/clusters/kafka-connect.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,10 @@ kubectl describe kafkaconnects.clusters.instaclustr.com kafkaconnect-sample

After you have applied the entity, the Instaclustr operator will create it on your K8s cluster and send a request to the Instaclustr API. You can be sure, that the resource creation call was sent if the instance has an id field filled in the status section.

You can check access to the created cluster from your kubernetes cluster and run some simple command to check that it is working with a lot of tools.
All available tools you can find in the Instaclustr console -> Choose your cluster -> Connection Info -> Examples section.


## Cluster update flow
To update a cluster you can apply an updated cluster manifest or edit the custom resource instance in kubernetes cluster:
* Apply an updated cluster manifest:
Expand Down
3 changes: 3 additions & 0 deletions doc/clusters/kafka.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,9 @@ kubectl describe kafkas.clusters.instaclustr.com kafka-sample

After you have applied the entity, the Instaclustr operator will create it on your K8s cluster and send a request to the Instaclustr API. You can be sure, that the resource creation call was sent if the instance has an id field filled in the status section.

You can check access to the created cluster from your kubernetes cluster and run some simple command to check that it is working with a lot of tools.
All available tools you can find in the Instaclustr console -> Choose your cluster -> Connection Info -> Examples section.

## Cluster update flow
To update a cluster you can apply an updated cluster manifest or edit the custom resource instance in kubernetes cluster:
* Apply an updated cluster manifest:
Expand Down
3 changes: 3 additions & 0 deletions doc/clusters/opensearch.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,9 @@ kubectl describe opensearches.clusters.instaclustr.com opensearch-sample

Cluster was created on Instaclustr premise if the instance has an id in the status section.

You can check access to the created cluster from your kubernetes cluster and run some simple command to check that it is working with a lot of tools.
All available tools you can find in the Instaclustr console -> Choose your cluster -> Connection Info -> Examples section.

## Cluster update example

To update a cluster you can apply an updated cluster manifest or edit the custom resource instance in kubernetes cluster:
Expand Down
3 changes: 3 additions & 0 deletions doc/clusters/postgresql.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,9 @@ kubectl describe postgresqls.clusters.instaclustr.com postgresql-sample

Cluster was created on Instaclustr premise if the instance has an id in the status section.

You can check access to the created cluster from your kubernetes cluster and run some simple command to check that it is working with a lot of tools.
All available tools you can find in the Instaclustr console -> Choose your cluster -> Connection Info -> Examples section.

## Cluster update example

To update a cluster you can apply an updated cluster manifest or edit the custom resource instance in kubernetes cluster:
Expand Down
3 changes: 3 additions & 0 deletions doc/clusters/redis.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,9 @@ kubectl describe redis.clusters.instaclustr.com redis-sample

After you have applied the entity, the Instaclustr operator will create it on your K8s cluster and send a request to the Instaclustr API. You can be sure, that the resource creation call was sent if the instance has an id field filled in the status section.

You can check access to the created cluster from your kubernetes cluster and run some simple command to check that it is working with a lot of tools.
All available tools you can find in the Instaclustr console -> Choose your cluster -> Connection Info -> Examples section.

## Cluster update flow
To update a cluster you can apply an updated cluster manifest or edit the custom resource instance in kubernetes cluster:
* Apply an updated cluster manifest:
Expand Down
3 changes: 3 additions & 0 deletions doc/clusters/zookeeper.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,9 @@ kubectl describe zookeepers.clusters.instaclustr.com zookeeper-sample

After you have applied the entity, the Instaclustr operator will create it on your K8s cluster and send a request to the Instaclustr API. You can be sure, that the resource creation call was sent if the instance has an id field filled in the status section.

You can check access to the created cluster from your kubernetes cluster and run some simple command to check that it is working with a lot of tools.
All available tools you can find in the Instaclustr console -> Choose your cluster -> Connection Info -> Examples section.

### Cluster deletion
To delete cluster run:
```console
Expand Down
Binary file added doc/images/account_icon_screen.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/images/account_settings_screen.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/images/api_keys_screen.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/images/gear_icon_screen.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/images/my_profile_screen.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/images/user_details_screen.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
56 changes: 56 additions & 0 deletions doc/install-instaclustr-operator.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@

## Using Instaclustr with Kubernetes
This document will instruct you how to install the instaclustr operator in your Kubernetes cluster
and how to work with it.

Also, you can see [demo](https://drive.google.com/file/d/1HNRimZRKkzYU57S1mBfS_MakQLp4k3c9/view?usp=sharing) video with all these instructions.

We will complete the following steps:
1. Install Instaclustr operator
2. Create Cassandra cluster
3. Update Cassandra cluster
4. Delete Cassandra cluster

### Install Instaclustr operator
#### 1. Deploy cert manager
``` sh
kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.10.0/cert-manager.yaml
```

#### 2. Install helm
Download and Install helm on your Kubernetes cluster from [source](https://helm.sh/docs/intro/install/).

#### 3. Use helm to install Instaclustr operator
Using helm, add the instaclustr operator to Helm repository. More details [here](https://helm.sh/docs/helm/helm_repo_add/).
```sh
helm repo add operator-chart https://instaclustr.github.io/operator-helm/
```

#### Install Instaclustr operator in your Kubernetes cluster. More details here.
Change test values to your actual data
- USERNAME - UserName can be retrieved from the console by going to account icon to the top right > My Profile > User Details.

![Account icon](images/account_icon_screen.png "Account icon")

![My profile](images/my_profile_screen.png "My profile")

![User details](images/user_details_screen.png "User details")
- APIKEY - Account API keys can be retrieved any time from the console by going to gear icon to the top right > Account Settings > API Keys. More details here.

![Gear icon](images/gear_icon_screen.png "Gear icon")

![Account settings](images/account_settings_screen.png "Account settings")

![Api keys](images/api_keys_screen.png "Api keys")
- HOSTNAME - Default value is api.instaclustr.com. You can change it if you want to use another HostName. More information here.

```sh
helm install operator operator-chart/operator \
--set USERNAME=test \
--set APIKEY=test \
--set HOSTNAME=api.instaclustr.com \
-n instaclustr-operator --create-namespace
```
You can run ``` kubectl get pods -n instaclustr-operator ``` to check if operator is running.

**_All examples for all available resources you can find in "doc" folder_**