zato quickstart

Overview

Quickly creates a Zato cluster. Sets up a Certificate Authority (CA), web admin, a load-balancer, and a Zato server.

This is a great way to get started with Zato as its creates everything that is needed to familiarise yourself with how a complete Zato environment looks like.

On a successful completion, the following environment will be created:

  • ODB objects, if they didn’t already exist
  • A Certificate Authority
  • Web-admin dashboard running on http://localhost:8183
  • A load-balancer accepting HTTP connections on http://localhost:11223
  • Server ‘server1’ accepting HTTP connection on http://localhost:17010
  • Scheduler
  • Scripts to start, stop and restart the whole environment
path/
├── ca
├── load-balancer
├── scheduler
├── server1
├── web-admin
├── zato-qs-restart.sh
├── zato-qs-start.sh
└── zato-qs-stop.sh

The CA will generate crypto certificates and all the components will be configured to make use of them.

The web-admin’s user to log in with is ‘admin’ and its randomly generated human-readable password will be printed out to screen (such as ZuDGoc5r21VonsM in the first usage example below).

Note that a new admin user will not be created if one already exists in the ODB, for instance, if there’s already been a quickstart cluster created using the ODB connection parameters provided. In such case, you should use the already existing admin credentials for connecting to the new cluster’s web admin console. Tip: use the zato update password command if you don’t remember the password.

Any passwords asked for will not be echoed.

Command-specific parameters

Name Description Example value
path An empty directory to install the environment to ~/zato/quickstart1
–odb_type ODB type, must be one of: [‘mysql’, ‘postgresql’, ‘sqlite’]. Defaults to ‘sqlite’. postgresql
–odb_host Host the ODB is running on localhost
–odb_port Port the ODB is listening at 5432
–odb_user Username to connect to ODB with zato1
–odb_db_name ODB database name zatodb1
–postgresql_schema PostgreSQL only: database schema to use zato
–odb_password ODB password, if any kf094z203mck
–cluster_name Name to be given to the new cluster testcluster1
–servers Number of servers to be created 1

Usage examples

This example uses an embedded SQLite database by default, which means that the example is self-contained, no further configuration is needed:

$ zato quickstart ~/env/production1
Creating directory `/home/zato/env/production1`
[1/8] Certificate authority created
[2/8] ODB schema created
[3/8] ODB initial data created
[4/8] server1 created
[5/8] Load-balancer created
Superuser created successfully.
[6/8] Dashboard created
[7/8] Scheduler created
[8/8] Management scripts created
Quickstart cluster quickstart-663294 created
Web admin user:[admin], password:[ZuDGoc5r21VonsM]
Start the cluster by issuing the /home/zato/env/production1/zato-qs-start.sh command
Visit https://zato.io/support for more information and support options
$

This example create a new quickstart cluster using a standalone PostgreSQL database which must exist prior to the execution of this command:

$ zato quickstart ~/env/production2 \
    --odb_type mysql \
    --odb_host localhost \
    --odb_port 3306 \
    --odb_user zato1 \
    --odb_db_name zato1

ODB database password (will not be echoed):
Enter the odb_password again (will not be echoed):

[1/8] Certificate authority created
[2/8] ODB schema created
[3/8] ODB initial data created
[4/8] server1 created
[5/8] server2 created
[6/8] Load-balancer created
Superuser created successfully.
[7/8] Web admin created
[8/8] Management scripts created
Quickstart cluster quickstart-555016 created
Web admin user:[admin], password:[esnd-adiu-mpst-epom]
Start the cluster by issuing the /home/zato/esb/qs-4/zato-qs-start.sh command
Visit https://zato.io/support for more information and support options
$

Changelog

Version Notes
3.2
  • Removed Redis options
  • Renamed “zato quickstart create” to “zato quickstart”. The old format is kept for backward compatibility.
2.0
  • Added support for SQLite
  • Added –servers and –cluster_name parameters
1.0
  • Added initially