Creating and Updating Elastic Cloud Deployment

Table of Contents

Creating Elasticsearch (Elastic Cloud)

  1. Go to portal.azure.com.
  2. In the search bar at the top, search for Elasticsearch (Elastic Cloud).

  1. Select Create.

  1. Choose your resource group, resource name and region (select the one closest to you).

An important thing to note is that the price here will be reduced by 80%. This will be explained further in the article.

It is also important to ensure that an elastic version of 8.19.x is selected.

  1. Next, select Review + create.
  2. Select Create.

  1. After that, the installation of Elasticsearch will begin. This process will take around 20 to 30 minutes. Once the installation is complete, you will see a message that your deployment is complete.

  1. Select Go to resource.

  1. Select Manage changes in Elastic Cloud.
  2. If you are prompted for permissions, check the box to consent on behalf of the organization and select Accept.
  3. Now we have access to Elastic Cloud Administration Panel.

We should update Elastic Cloud deployment to the newest version first.

  1. Select Upgrade (as shown above).
  2. Select the newest Generally available version, and then select Upgrade.

  1. Select Confirm Upgrade.

Your Elastic Cloud deployment is now updating all of its components. This process may take between 20 and 30 minutes. Once the update is complete, the window will look like this:

  1. Click on the Elastic logo in the top left corner. We will now begin creating a user that will serve as a connector between KanBo and Elasticsearch.

Creating a user for KanBo

Now, we will create a user that will serve as a connector between KanBo and Elasticsearch.

  1. Select the name that you assigned to the Elastic Deployment (in our case, KanBoElasticSearch).
  1. You have now accessed Kibana. In the search bar at the top of the site, search for “Roles” and select it by clicking Go to.
  1. Select + Create role.
  1. Configure these options the same way as in the screenshot:
    • Role name: admin-KanBoSearch
    • Cluster privileges: manage, manage_security
    • Run As privileges: *
    • Indices: kanbosearch.*
    • Privileges: all

  1. After creating a role, search for “Users” in the top bar and select Go to.
  1. For good practice, use the same username as the role name. The password is not generated; it is set by you. In the “Roles” section, select the role created in the previous step: “admin-KanBoSearch.”
  1. Be sure to save the username and password somewhere for later use.

Scaling down the Elastic Cloud deployment

Elasticsearch’s default sizing is much larger than what is generally needed for searching KanBo. Therefore, the deployment should be scaled down to avoid unnecessary costs.

  1. Go back to your Elastic Cloud instance in Azure and select Configuration.
  1. Select Resize deployment.
  1. Modify the Elasticsearch size here, since the other components do not affect the hourly cost.

The minimum required Elasticsearch sizing for KanBo is 70 GB of storage, 2 GB of RAM, and up to 2.1 vCPUs. However, if the search function is underperforming in KanBo, you should increase the size.

  1. After selecting your size, scroll all the way down, select Extended maintenance, and then select Save.

Your Elasticsearch is now downscaling. This process will take around 10 minutes.

  1. Once downscaling is complete, in the left panel, select Edit. We will need to downscale the environment again.
  1. In the Elasticsearch options, select 1 zone. This will cut the running cost in half. This downscaling must be done separately to prevent the entire Elastic Stack from crashing.
  2. Select Extended maintenance, and then select Save again.
  3. Now, go back to the main page. We will begin configuring the Elasticsearch user account from there.

Connecting KanBo with Elasticsearch

This part of the article should only be completed after the KanBo Installation is finished.

  1. Copy the cloud ID (as shown below).
  1. Go to your KanBo’s appSettings.json file and look for code that looks like this:
{
    "type": "elastic",
	"tenant": "ES-TENANT",
	"connection": {
		"cloudId": "ES-CLOUD-ID",
		"login": "ES-LOGIN",
		"password": "ES-PASSWORD"
	}
   }
  1. Here’s what you need to change in this part of the code:
  • ES-TENANT: kanbosearch
  • ES-CLOUD-ID: The copied Cloud ID of your Elastic Deployment
  • ES-LOGIN: The username from “Creating a user for KanBo”, step 4.
  • ES-PASSWORD: The password from “Creating a user for KanBo”, step 4.
  1. Go to KanBo Setup > Show advanced setup, and then select Elastic.
  2. Index all your data by selecting All in the Data Import section.
  3. Check the Clean box, and then select Execute.
  1. Wait until Elastic indexed everything.

Troubleshooting

Failed registering elastic connection: Elastic ping failed

If that happened, then there was probably a mistake in one of the boxes in the “Connection section”. Please make sure that:

  1. You copied the whole Elastic Cloud ID.
  2. The Username and Password are correct.
  3. The tenant name doesn’t include the “.*” part that was present inside the Indices of a role we have created in Kibana.

Was this article helpful?

Please, contact us if you have any additional questions.