Using Instaclustr with Kubernetes
MenuThis document will instruct you how to install the Service Catalog extension and create a service broker instance in your Kubernetes cluster.
We will complete the following steps
- Install the Service Catalog extension
- Set up a Secret and create a namespace
- Create the Instaclustr Service Broker as “ClusterServiceBroker”
- Create a Service Instance (new or existing)
- Create an Instance Binding
- Unbind a Service Instance
- Deprovision a Service Instance
The Instaclustr Service Catalog is built according to the Open Service Broker specification, this article will use some of that terminology below.
1. Install Service Catalog
1.1 Install helm:
More detailed install process in this article: helm
System | Command | ||
|---|---|---|---|
| Macox |
| ||
| Linux |
| ||
| Windows | choco install kubernetes-helm |
1.2 Use helm to install Service Catalog
- The detailed install process (for server) is in this article: install Service Catalog Server
- The detailed install process (for client) is in this article: install Service Catalog Client (also known as svcat)
2. Set up a Secret and create a namespace
2.1 Set up a Secret
Detailed steps are here: Secret.
Get your Instaclustr Username and ProvisioningKey, the provisioning key can be retrieved from the Instaclustr Console. Then run the following command to generate the secret:
# Create secret from username and password. 'my-secret' is the name of secret. You can change to whatever you like.kubectl create secret generic my-secret --from-literal=username=<yourUserName> --from-literal=password=<yourProvisioningKey> |
You can run kubectl get secret and see the new secret.
2.2 Create a namespace
kubectl create namespace my-namespace |
3. Create Instaclustr Service Broker as “ClusterServiceBroker”
At this point, your K8s can create a ClusterServiceBroker and sync our catalog.
3.1 Create a ClusterServiceBroker
You will need a yaml file which looks like this:
apiVersion: servicecatalog.k8s.io/v1beta1kind: ClusterServiceBrokermetadata: name: my-brokerspec: url: https://api.instaclustr.com/servicebroker authInfo: basic: secretRef: namespace: default name: my-secret |
Please note, the secretRef.name is the secret we created in the “2. Set up Secret”.
And then run:
kubectl create -f ClusterServiceBroker.yaml |
You can run kubectl get ClusterServiceBroker (or svcat get broker my-broker or svcat describe broker my-broker) to view your service broker.
3.2 Check out the ClusterServiceClass and ClusterServicePlan
Use the following command:
kubectl get ClusterServiceClass (or svcat get classes) |
|---|
|
The output should be similar to this:
3.3 Get details about a particular ClusterServiceClass and a particular ClusterServicePlan
Use the following command:
svcat describe class instaclustr-managed-service |
|---|
|
The output should be similar to this:
4. Create a new Service Instance
As mentioned in the previous step, the Service Catalog currently offers two plans:
- new-cluster – create a new cluster in the Instaclustr managed service.
- existing-cluster – link to an existing cluster in the Instaclustr managed service.
In both cases, the functionality is identical, but fields differ for creating them.
4.1a Create a new Cluster – yaml
“Provision a new cluster, deprovisioning will delete this cluster from our managed platform”
apiVersion: servicecatalog.k8s.io/v1beta1kind: ServiceInstancemetadata: name: my-instance namespace: my-namespacespec: clusterServiceClassExternalName: instaclustr-managed-service clusterServicePlanExternalName: new-cluster authInfo: basic: secretRef: namespace: default name: my-secret parameters: clusterName: My-Cluster bundles: - bundle: KAFKA version: apache-kafka:2.1.0.ic2 options: clientEncryption: false brokerEncryption: false provider: name: AWS_VPC nodeSize: t2.small-20-gp2 dataCentre: US_WEST_2 clusterNetwork: 192.168.0.0/18 rackAllocation: numberOfRacks: 3 nodesPerRack: 1 |
Note: these values are an indication only, the Service Catalog is built on top of our existing provisioning api, all the fields are supported in yaml format.
4.1b Connect an existing cluster – yaml
“Link an existing cluster, deprovisioning will NOT delete this cluster from our managed platform”
Note: The provisioning key setup in the kubernetes secret will be used to determine ownership of the cluster, if that account doesn’t own the cluster, the command will fail.
apiVersion: servicecatalog.k8s.io/v1beta1kind: ServiceInstancemetadata: name: my-instance namespace: my-namespacespec: clusterServiceClassExternalName: instaclustr-managed-service clusterServicePlanExternalName: existing-cluster authInfo: basic: secretRef: namespace:default name: my-secret parameters: clusterId: 5338d449-20ad-47bf-89f6-dc2a7727ef05 |
4.2 Create the service instance
The command you run will be:
kubectl create -f ServiceInstance.yaml |
Please note, the spec.clusterServiceClassName and spec.clusterServicePlanName is listed from step 3.3.
It will look like this:
You can run svcat describe instance my-instance -n my-namespace to check your instance. It should look something like this:
After a while when the cluster enters into the RUNNING state, the same command will produce something like this:
5. Create a Binding to the Service Instance created in Step 4
You will need a yaml file like this:
apiVersion: servicecatalog.k8s.io/v1beta1kind: ServiceBindingmetadata: name: my-binding namespace: my-namespacespec: instanceRef: name: my-instance authInfo: basic: secretRef: namespace:default name: my-secret |
The output should look something like this:
You can run svcat describe binding my-binding -n my-namespace to check your binding. It should look something like this:
The details of the secret data can be viewed using the following commands:
(to obtain the private addresses) :
kubectl get secret my-binding -n my-namespace -o yaml | grep node-private-address | awk -F “:” ‘{print $2}’ | base64 –decode
(to obtain the public addresses) :
kubectl get secret my-binding -n my-namespace -o yaml | grep node-public-address | awk -F “:” ‘{print $2}’ | base64 –decode
Note, the IP addresses shown above may vary.
6. Unbind the Service Instance
To unbind, use the command svcat unbind my-instance -n my-namespace.
To check that the binding is actually deleted, you can either use the command svcat describe binding my-binding -n my-namespace OR kubectl get secret my-binding -n my-namespace.
The output looks something like this:
7. Deprovision/Delete a Service Instance
Important note: The Instaclustr Service Catalog will only delete clusters created through the Service Catalog. If you use the “exiting cluster” plan, the cluster will not be deleted.
To deprovision/delete an instance, use the command svcat deprovision my-instance -n my-namespace.
To check that the instance is actually deleted, you can use the command svcat describe instance my-instance -n my-namespace.
The output looks something like this:
Submit Comment