Introduction

The zl-* utilities are custom wrapper scripts designed to simplify common tasks for developers by providing a user-friendly interface over more complex systems. Below is a comprehensive guide to each utility, including usage examples and options.

1. zl-chef-client

Purpose: Simplifies running chef-client commands by filtering out irrelevant logs and allowing developers to deploy basic recipes.

Chef client for a given service checks for the current build from consul and deploys it on the server.

• Usage:

  zl-chef-client -s [qualified_service_name]
  

• Examples:

  • Single service: zl-chef-client -s nsg1-n-event-hub
  • Multiple services: zl-chef-client -s nsg1-n-event-hub,nsg1-n-live-data-streaming

2. zl-pg-connect

Purpose: Connects to PostgreSQL databases specific to services. Access is limited to RDS instances from dbrouter servers.

For connecting to stage databases, connect to stage_dbrouter_1 machine For connecting to prod databases, connect to prod_dbrouter_1 machine

• Usage:

  zl-pg-connect [qualified_service_name] [--write]
  

• Examples:

  • Read access: zl-pg-connect nint-n-event-hub
  • Write access: zl-pg-connect nint-n-event-hub --write

• Note:

  • Write access is disabled for all users on production environments. It can be provisioned for a given time using Jenkins job: db_access_manager. Only Leads and POC of the service have access to run this job.

3. zl-mongo-connect

Purpose: Provides access to MongoDB instances for specific services. Requires database-level access permissions.

For connecting to stage databases, connect to stage_dbrouter_1 machine For connecting to prod databases, connect to prod_dbrouter_1 machine

• Usage:

  zl-mongo-connect [qualified_service_name] [--write]
  

• Examples:

  • Read access: zl-mongo-connect nint-n-event-hub
  • Write access: zl-mongo-connect nint-n-event-hub --write