def main():
# Always attempt to store the PID file first
store_pidfile(os.path.abspath('.'))
# Capture warnings to log files
logging.captureWarnings(True)
config = Config()
repo_location = os.path.join('.', 'config', 'repo')
# Logging configuration
with open(os.path.join(repo_location, 'logging.conf')) as f:
dictConfig(yaml.load(f, yaml.FullLoader))
# Read config in and extend it with ODB-specific information
config.main = get_config(repo_location, 'scheduler.conf')
config.main.odb.fs_sql_config = get_config(repo_location,
'sql.conf',
needs_user_config=False)
# Make all paths absolute
if config.main.crypto.use_tls:
config.main.crypto.ca_certs_location = absjoin(
repo_location, config.main.crypto.ca_certs_location)
config.main.crypto.priv_key_location = absjoin(
repo_location, config.main.crypto.priv_key_location)
config.main.crypto.cert_location = absjoin(
repo_location, config.main.crypto.cert_location)
logger = logging.getLogger(__name__)
logger.info('Scheduler starting (http{}://{}:{})'.format(
's' if config.main.crypto.use_tls else '', config.main.bind.host,
config.main.bind.port))
# Fix up configuration so it uses the format internal utilities expect
for name, job_config in iteritems(
get_config(repo_location,
'startup_jobs.conf',
needs_user_config=False)):
job_config['name'] = name
config.startup_jobs.append(job_config)
# Run the scheduler server
try:
SchedulerServer(config, repo_location).serve_forever()
except Exception:
logger.warn(format_exc())
def set_zato_client(self):
# stdlib
import os
# Zato
from zato.client import AnyServiceInvoker
from zato.common.api import odb
from zato.common.util.api import get_config, get_crypto_manager_from_server_config, get_odb_session_from_server_config, \
get_server_client_auth
class ZatoClient(AnyServiceInvoker):
def __init__(self, *args, **kwargs):
super(ZatoClient, self).__init__(*args, **kwargs)
self.cluster_id = None
self.odb_session = None
repo_dir = os.path.join(os.path.abspath(os.path.join(self.server_path)), 'config', 'repo')
config = get_config(repo_dir, 'server.conf')
self.client = ZatoClient('http://{}'.format(config.main.gunicorn_bind),
'/zato/admin/invoke', get_server_client_auth(config, repo_dir), max_response_repr=15000)
session = get_odb_session_from_server_config(
config, get_crypto_manager_from_server_config(config, repo_dir))
self.client.cluster_id = session.query(odb.model.Server).\
filter(odb.model.Server.token == config.main.token).\
one().cluster_id
self.client.odb_session = session
# Configuration check
self.client.invoke('zato.ping')
def execute(self, args):
# type: (Namespace) -> object
# stdlib
import os
# Zato
from zato.common.util.api import get_config
repo_location = os.path.join(args.path, 'config', 'repo')
secrets_conf = get_config(repo_location,
'secrets.conf',
needs_user_config=False)
# This file must exist, otherwise it's not a path to a server
if not secrets_conf:
self.logger.warn('Could not find file `secrets.conf` in `%s`',
repo_location)
return self.SYS_ERROR.NOT_A_ZATO_SERVER
user_api = self._get_sso_config(args, repo_location, secrets_conf)
if self.user_required:
user = user_api.get_user_by_username(self._get_cid(),
args.username)
if not user:
self.logger.warn('No such user `%s`', args.username)
return self.SYS_ERROR.NO_SUCH_SSO_USER
else:
user = None
return self._on_sso_command(args, user, user_api)
def from_server_conf(server_dir, cache_name, is_https):
# type: (str, str, bool) -> Client
repo_dir = get_repo_dir_from_component_dir(server_dir)
cm = ServerCryptoManager.from_repo_dir(None, repo_dir, None)
secrets_conf = get_config(repo_dir,
'secrets.conf',
needs_user_config=False)
config = get_config(repo_dir,
'server.conf',
crypto_manager=cm,
secrets_conf=secrets_conf)
session = None
password = None
try:
session = get_odb_session_from_server_config(config, None, False)
cluster = session.query(Server).\
filter(Server.token == config.main.token).\
one().cluster # type: Cluster
security = session.query(HTTPBasicAuth).\
filter(Cluster.id == HTTPBasicAuth.cluster_id).\
filter(HTTPBasicAuth.username == CACHE.API_USERNAME).\
filter(HTTPBasicAuth.cluster_id == cluster.id).\
first() # type: HTTPBasicAuth
if security:
password = security.password
finally:
if session:
session.close()
return Client.from_dict({
'username': CACHE.API_USERNAME,
'password': password,
'address': config.main.gunicorn_bind,
'cache_name': cache_name,
'is_https': is_https,
})
def handle(self):
input = self.request.input
with self.lock('{}-{}-{}'.format(self.name, self.server.name, input.file_name)):
with open(os.path.join(self.server.user_conf_location, input.file_name), 'wb') as f:
f.write(input.data)
conf = get_config(self.server.user_conf_location, input.file_name)
entry = self.server.user_config.setdefault(get_user_config_name(input.file_name), Bunch())
entry.clear()
entry.update(conf)
def _get_sso_config(self, args, repo_location, secrets_conf):
# type: (Namespace, unicode, Bunch) -> UserAPI
# Zato
from zato.common.crypto.api import CryptoManager
from zato.common.util.api import get_config
from zato.sso.api import UserAPI
from zato.sso.util import new_user_id, normalize_password_reject_list
sso_conf = get_config(repo_location,
'sso.conf',
needs_user_config=False)
normalize_password_reject_list(sso_conf)
crypto_manager = CryptoManager.from_secret_key(
secrets_conf.secret_keys.key1)
crypto_manager.add_hash_scheme('sso.super-user',
sso_conf.hash_secret.rounds,
sso_conf.hash_secret.salt_size)
server_conf = get_config(repo_location,
'server.conf',
needs_user_config=False,
crypto_manager=crypto_manager,
secrets_conf=secrets_conf)
def _get_session():
return self.get_odb_session_from_server_config(server_conf, None)
def _hash_secret(_secret):
return crypto_manager.hash_secret(_secret, 'sso.super-user')
user_api = UserAPI(None, sso_conf, None, crypto_manager.encrypt,
crypto_manager.decrypt, _hash_secret, None,
new_user_id)
user_api.post_configure(_get_session, True, False)
return user_api
def run(base_dir, start_gunicorn_app=True, options=None):
# type: (str, bool, dict)
options = options or {}
# Store a pidfile before doing anything else
store_pidfile(base_dir)
# For dumping stacktraces
register_diag_handlers()
# Capture warnings to log files
logging.captureWarnings(True)
# Start initializing the server now
os.chdir(base_dir)
try:
import pymysql
pymysql.install_as_MySQLdb()
except ImportError:
pass
# We know we don't need warnings because users may explicitly configure no certificate validation.
# We don't want for urllib3 to warn us about it.
import requests as _r
_r.packages.urllib3.disable_warnings()
repo_location = os.path.join(base_dir, 'config', 'repo')
# Configure the logging first, before configuring the actual server.
logging.addLevelName('TRACE1', TRACE1)
logging_conf_path = os.path.join(repo_location, 'logging.conf')
with open(logging_conf_path) as f:
logging_config = yaml.load(f, yaml.FullLoader)
dictConfig(logging_config)
logger = logging.getLogger(__name__)
kvdb_logger = logging.getLogger('zato_kvdb')
crypto_manager = ServerCryptoManager(repo_location,
secret_key=options['secret_key'],
stdin_data=read_stdin_data())
secrets_config = ConfigObj(os.path.join(repo_location, 'secrets.conf'),
use_zato=False)
server_config = get_config(repo_location,
'server.conf',
crypto_manager=crypto_manager,
secrets_conf=secrets_config)
pickup_config = get_config(repo_location, 'pickup.conf')
sio_config = get_config(repo_location,
'simple-io.conf',
needs_user_config=False)
sio_config = get_sio_server_config(sio_config)
sso_config = get_config(repo_location, 'sso.conf', needs_user_config=False)
normalize_sso_config(sso_config)
# Now that we have access to server.conf, greenify libraries required to be made greenlet-friendly,
# assuming that there are any - otherwise do not do anything.
to_greenify = []
for key, value in server_config.get('greenify', {}).items():
if asbool(value):
if not os.path.exists(key):
raise ValueError('No such path `{}`'.format(key))
else:
to_greenify.append(key)
# Go ahead only if we actually have anything to greenify
if to_greenify:
import greenify
greenify.greenify()
for name in to_greenify:
result = greenify.patch_lib(name)
if not result:
raise ValueError(
'Library `{}` could not be greenified'.format(name))
else:
logger.info('Greenified library `%s`', name)
server_config.main.token = server_config.main.token.encode('utf8')
# Do not proceed unless we can be certain our own preferred address or IP can be obtained.
preferred_address = server_config.preferred_address.get('address')
if not preferred_address:
preferred_address = get_preferred_ip(server_config.main.gunicorn_bind,
server_config.preferred_address)
if not preferred_address and not server_config.server_to_server.boot_if_preferred_not_found:
msg = 'Unable to start the server. Could not obtain a preferred address, please configure [bind_options] in server.conf'
logger.warn(msg)
raise Exception(msg)
# Create the startup callable tool as soon as practical
startup_callable_tool = StartupCallableTool(server_config)
# Run the hook before there is any server object created
startup_callable_tool.invoke(SERVER_STARTUP.PHASE.FS_CONFIG_ONLY,
kwargs={
'server_config': server_config,
'pickup_config': pickup_config,
'sio_config': sio_config,
'sso_config': sso_config,
'base_dir': base_dir,
})
# New in 2.0 - Start monitoring as soon as possible
if server_config.get('newrelic', {}).get('config'):
import newrelic.agent
newrelic.agent.initialize(server_config.newrelic.config,
server_config.newrelic.environment or None,
server_config.newrelic.ignore_errors or None,
server_config.newrelic.log_file or None,
server_config.newrelic.log_level or None)
zunicorn.SERVER_SOFTWARE = server_config.misc.get('http_server_header',
'Zato')
# Store KVDB config in logs, possibly replacing its password if told to
kvdb_config = get_kvdb_config_for_log(server_config.kvdb)
kvdb_logger.info('Main process config `%s`', kvdb_config)
# New in 2.0 hence optional
user_locale = server_config.misc.get('locale', None)
if user_locale:
locale.setlocale(locale.LC_ALL, user_locale)
value = 12345
logger.info('Locale is `%s`, amount of %s -> `%s`', user_locale, value,
locale.currency(value, grouping=True).decode('utf-8'))
if server_config.misc.http_proxy:
os.environ['http_proxy'] = server_config.misc.http_proxy
# Basic components needed for the server to boot up
kvdb = KVDB()
odb_manager = ODBManager(well_known_data=ZATO_CRYPTO_WELL_KNOWN_DATA)
sql_pool_store = PoolStore()
service_store = ServiceStore()
service_store.odb = odb_manager
service_store.services = {}
server = ParallelServer()
server.odb = odb_manager
server.service_store = service_store
server.service_store.server = server
server.sql_pool_store = sql_pool_store
server.service_modules = []
server.kvdb = kvdb
server.stderr_path = options.get('stderr_path')
# Assigned here because it is a circular dependency
odb_manager.parallel_server = server
zato_gunicorn_app = ZatoGunicornApplication(server, repo_location,
server_config.main,
server_config.crypto)
server.has_fg = options.get('fg')
server.crypto_manager = crypto_manager
server.odb_data = server_config.odb
server.host = zato_gunicorn_app.zato_host
server.port = zato_gunicorn_app.zato_port
server.repo_location = repo_location
server.user_conf_location = os.path.join(server.repo_location, 'user-conf')
server.base_dir = base_dir
server.logs_dir = os.path.join(server.base_dir, 'logs')
server.tls_dir = os.path.join(server.base_dir, 'config', 'repo', 'tls')
server.static_dir = os.path.join(server.base_dir, 'config', 'repo',
'static')
server.json_schema_dir = os.path.join(server.base_dir, 'config', 'repo',
'schema', 'json')
server.fs_server_config = server_config
server.fs_sql_config = get_config(repo_location,
'sql.conf',
needs_user_config=False)
server.pickup_config = pickup_config
server.logging_config = logging_config
server.logging_conf_path = logging_conf_path
server.sio_config = sio_config
server.sso_config = sso_config
server.user_config.update(server_config.user_config_items)
server.preferred_address = preferred_address
server.sync_internal = options['sync_internal']
server.jwt_secret = server.fs_server_config.misc.jwt_secret.encode('utf8')
server.startup_callable_tool = startup_callable_tool
server.is_sso_enabled = server.fs_server_config.component_enabled.sso
if server.is_sso_enabled:
server.sso_api = SSOAPI(server, sso_config, None,
crypto_manager.encrypt, crypto_manager.decrypt,
crypto_manager.hash_secret,
crypto_manager.verify_hash, new_user_id)
# Remove all locks possibly left over by previous server instances
kvdb.component = 'master-proc'
clear_locks(kvdb, server_config.main.token, server_config.kvdb,
crypto_manager.decrypt)
# New in 2.0.8
server.return_tracebacks = asbool(
server_config.misc.get('return_tracebacks', True))
server.default_error_message = server_config.misc.get(
'default_error_message', 'An error has occurred')
# Turn the repo dir into an actual repository and commit any new/modified files
RepoManager(repo_location).ensure_repo_consistency()
# New in 2.0 so it's optional.
profiler_enabled = server_config.get('profiler', {}).get('enabled', False)
# New in 2.0 so it's optional.
sentry_config = server_config.get('sentry')
dsn = sentry_config.pop('dsn', None)
if dsn:
from raven import Client
from raven.handlers.logging import SentryHandler
handler_level = sentry_config.pop('level')
client = Client(dsn, **sentry_config)
handler = SentryHandler(client=client)
handler.setLevel(getattr(logging, handler_level))
logger = logging.getLogger('')
logger.addHandler(handler)
for name in logging.Logger.manager.loggerDict:
if name.startswith('zato'):
logger = logging.getLogger(name)
logger.addHandler(handler)
if asbool(profiler_enabled):
# Repoze
from repoze.profile import ProfileMiddleware
profiler_dir = os.path.abspath(
os.path.join(base_dir, server_config.profiler.profiler_dir))
server.on_wsgi_request = ProfileMiddleware(
server.on_wsgi_request,
log_filename=os.path.join(profiler_dir,
server_config.profiler.log_filename),
cachegrind_filename=os.path.join(
profiler_dir, server_config.profiler.cachegrind_filename),
discard_first_request=server_config.profiler.discard_first_request,
flush_at_shutdown=server_config.profiler.flush_at_shutdown,
path=server_config.profiler.url_path,
unwind=server_config.profiler.unwind)
# New in 2.0 - set environmet variables for servers to inherit
os_environ = server_config.get('os_environ', {})
for key, value in os_environ.items():
os.environ[key] = value
# Run the hook right before the Gunicorn-level server actually starts
startup_callable_tool.invoke(SERVER_STARTUP.PHASE.IMPL_BEFORE_RUN,
kwargs={
'zato_gunicorn_app': zato_gunicorn_app,
})
# Run the app at last
if start_gunicorn_app:
zato_gunicorn_app.run()
else:
return zato_gunicorn_app.zato_wsgi_app