No-SQL Database

In JetDeploy console you can start a fully dedicated No-SQL database instance. Supported platforms are:

  • Opensearch Opensearch

Create

During service creation you need to select:

  • Type

    Choose one of the supported platform type and version

  • Service name

    A unique service ident name. This name cannot be changed after creation. A random string is filled as initial default value

Click Next button to add few more specifications:

  • Storage size

    Define the initial max storage capacity of the database instance

Note

Connection and authentication data (e.g. host, port, username and password) will be visible in the detail page after database creation success.

Click Next button and the database creation process will start.

Details

In the Service Detail page you can access to various information of your database:

  • Type

    Type of your database instance (e.g. Opensearch)

  • Version

    Full version of your running database instance

  • Status

    Status of your database instance. To be fully operational it must be in Ready state.

  • External Endpoint

    It is the external endpoint of your database instance, reachable by your laptop, external services or apps running out of JetDeploy infrastructure. <External-Host>:<External-Port> you find here can be used to connect by client utilities for database administration tasks.

    Note

    Visible only when Expose action done

  • Internal Endpoint

    It is the internal endpoint of your database instance, reachable by other Services or Apps you create in JetDeploy. <Host>:<Port> you find here can be used as Environment variables in your App to connect to this service.

  • Username

    Root user of the database instance (e.g. admin for Opensearch).

  • Password

    Random generated password of the root user.

Tip

For security reason we suggest you to create a new application-specific username and password, using password policy recommendations and the least privilege principle

You could find additional fields in the Service Detail page that are specific for the type of Service you’re running. For example in Opensearch detail page you can find the Dashboards Endpoint too.

In the Operations section, at bottom, you can view information of the tasks created by various Actions you can run on your SQL database using JetDeploy console.

Actions

Different types of Action can be executed on your instance:

Expose Use this action when you need to connect to your instance from external, e.g. your development computer or an application or service not running in JetDeploy platform.
For security reasons we suggest you to keep external access active for a short period of time, limited to the time necessary for data migration, troubleshooting or maintenance tasks.

View Logs Use this action when you need to view logs of your instance.

Start Start of your instance, usually when your instance has been previously stopped.

Stop Stop of your instance

Restart Restart of your instance.

Destroy Request a service destroy of your instance.

Warning

Destroy action is risky and you will lose all your data. Please be absolutely sure when run this action.

Settings

Note

JetDeploy is in closed alpha status, so at the moment to increase the Storage size after service creation you need to open a Support Request

Usage examples

Opensearch

  • Dashboards

    Simply visit your instance Dashboards endpoint and insert credentials to authenticate!

  • curl command line tool

    First of all you should Expose your Service if you run the utility on your local laptop.
    Then check connection details in the Service Detail page:

    Note

    Type: Opensearch
    Version: 8.4.3
    Status: Ready
    External Endpoint: https://blustery-morose.jetdeploy.app
    Internal Endpoint: blustery-morose-opensearch:9200
    Username: elastic (created on setup)
    Password: 037ffa5790ae42439d113c83bd16587e
    Dashboards Endpoint: https://blustery-morose-dashboards.jetdeploy.app

    Now you’re ready to connect:

    $ curl -X GET -u elastic:037ffa5790ae42439d113c83bd16587e 'https://blustery-morose.jetdeploy.app/_cat/indices?v'
health status index uuid pri rep docs.count docs.deleted store.size pri.store.size  

$ curl -X GET -u elastic:037ffa5790ae42439d113c83bd16587e 'https://blustery-morose.jetdeploy.app/_cat/shards?pretty'
.geoip_databases                                              0 p STARTED  40  38.2mb 10.42.1.198 blustery-morose-opensearch-master-0
.dashboards-event-log-8.4.3-000001                                0 p STARTED   1   6.2kb 10.42.1.198 blustery-morose-opensearch-master-0
.security-7                                                   0 p STARTED 110 321.1kb 10.42.1.198 blustery-morose-opensearch-master-0
.dashboards_task_manager_8.4.3_001                                0 p STARTED  25   400kb 10.42.1.198 blustery-morose-opensearch-master-0
.security-profile-8                                           0 p STARTED   1   7.9kb 10.42.1.198 blustery-morose-opensearch-master-0
.ds-ilm-history-5-2022.12.16-000001                           0 p STARTED   9  20.1kb 10.42.1.198 blustery-morose-opensearch-master-0
.dashboards_security_session_1                                    0 p STARTED   1   5.7kb 10.42.1.198 blustery-morose-opensearch-master-0
.apm-custom-link                                              0 p STARTED   0    225b 10.42.1.198 blustery-morose-opensearch-master-0
.dashboards_8.4.3_001                                             0 p STARTED 272   2.6mb 10.42.1.198 blustery-morose-opensearch-master-0
.apm-agent-configuration                                      0 p STARTED   0    225b 10.42.1.198 blustery-morose-opensearch-master-0
.ds-.logs-deprecation.opensearch-default-2022.12.16-000001 0 p STARTED   1  12.6kb 10.42.1.198 blustery-morose-opensearch-master-0

    Great! You’re now ready to use your Opensearch instance!