issue-106, using Instaclustr with Kubernetes doc was added

instaclustr · Mar 14, 2023 · c8e46a6 · c8e46a6
1 parent b9a19b6
commit c8e46a6
Show file tree

Hide file tree

Showing 15 changed files with 82 additions and 0 deletions.
diff --git a/doc/clusters/cadence.md b/doc/clusters/cadence.md
@@ -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:

diff --git a/doc/clusters/cassandra.md b/doc/clusters/cassandra.md
@@ -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/). 
+
 ## 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:

diff --git a/doc/clusters/kafka-connect.md b/doc/clusters/kafka-connect.md
@@ -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:

diff --git a/doc/clusters/kafka.md b/doc/clusters/kafka.md
@@ -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:

diff --git a/doc/clusters/opensearch.md b/doc/clusters/opensearch.md
@@ -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:

diff --git a/doc/clusters/postgresql.md b/doc/clusters/postgresql.md
@@ -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:

diff --git a/doc/clusters/redis.md b/doc/clusters/redis.md
@@ -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:

diff --git a/doc/clusters/zookeeper.md b/doc/clusters/zookeeper.md
@@ -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

diff --git a/doc/images/account_icon_screen.png b/doc/images/account_icon_screen.png
diff --git a/doc/images/account_settings_screen.png b/doc/images/account_settings_screen.png
diff --git a/doc/images/api_keys_screen.png b/doc/images/api_keys_screen.png
diff --git a/doc/images/gear_icon_screen.png b/doc/images/gear_icon_screen.png
diff --git a/doc/images/my_profile_screen.png b/doc/images/my_profile_screen.png
diff --git a/doc/images/user_details_screen.png b/doc/images/user_details_screen.png
diff --git a/doc/install-instaclustr-operator.md b/doc/install-instaclustr-operator.md
@@ -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_**