Deploying Grakn on Google Cloud

Google Cloud Launcher


We shall begin with deployment of a Grakn cluster. The procedure is straight-forward and takes advantage of the Cloud Launcher:

To start deployment, click on the Launch on Compute Engine button which will take you to the configuration screen

Feel free to adjust the settings to your needs. When satisfied with the configuration press Deploy

That is all! Your cluster deployment is now pending.

When the deployment is complete you should be able to see the post-deployment screen:

Accessing Grakn

There are various ways to access Grakn in the cloud. Here we will address the most common usage patterns.

Grakn Dashboard

In order to access the Grakn Dashboard, you can either allow traffic on the 4567 TCP port or create an ssh tunnel.

Adding firewall rule

Unless you selected the Allow TCP port 4567 traffic option during deployment, you can allow traffic by running the command in red circle in your terminal:

After allowing the traffic on TCP port 4567 the Dashboard shall be accessible from your browser at :4567.

Creating SSH tunnel

To create a SSH tunnel, copy & paste the black box inside the red oval to your terminal:

After executing the command the output should look like this:

After SSH tunnel creation, the Dashboard shall be accessible from your browser at localhost.

Using gRPC

To enable gRPC communication, traffic on TCP port 48555 needs to be allowed. A suitable firewall rule can be created by executing the command in red circle in your terminal:

Logging into a node

You may require a more direct interaction with the database. You need to log into a node to achieve that. To do so go back to the Google console and follow the red arrow as shown below to start an ssh session using the “Open in browser window” option.

Once logged in, a variety of interactions are possible through grakn and graql terminals.

Cluster health check

To check cluster health, execute the grakn cluster status command. The output shall look like this:

Accessing the Graql console

To access the Graql console, a user password is required. You can see it in the Google console screen in the red cirlce:

To log into the Graql console, simply type graql console. After entering the user credentials (user: grakn, password: the one from Google console) you are free to interact with Grakn via the Graql terminal. Succesful login attempt shall look like this:

Next Steps

If you want to learn more about Grakn KGMS, the Grakn Academy is a good place to start.

To learn more about running Grakn KGMS on GCP take a look at the best practices guide and post deployment steps.