Skip to main content

Senza template for the automatic PosgreSQL DB deployments

Project description

Senza template for automatic deployment of PostgreSQL instances
===============================================================

This package provides an external template for the stups-senza tool (https://github.com/zalando-stups/senza), allowing rapid deployment of PostgreSQL nodes on AWS. It's designed to work together with an external tool that runs
senza with all necessary parameters and deploy DB instances automatically, therefore, the template is a non-interactive one. Compared to the PostgresApp template (included with senza) it adds the following actions:

- NAT gateways are detected based on the customer DNS zone.
- Correct Etcd endpoints in the current account are detected for a specific region.
- Non-interactive mode is the default one, all parameters can be supplied with environment variables (`-v` option during senza init).
- pg_hba.conf is configured by default to reject non-SSL connections.
- Standby and superuser passwords are automatically generated.
- All passwords and scalyr keys are encrypted.
- zmon2 group is automatically picked from the current account.
- EBS is always used.

Installation
============

.. code-block:: bash

$ sudo pip3 install --upgrade senza.templates.acid

Usage
=====

.. code-block:: bash

$ senza init -t base [-v param=name] deployment.yaml

Below is the list of parameters supported by the template:

- *team_name*: the name of the team to deploy the template (used as part of the DNS name for the resulting instance).
- *team_region*: AWS region of the team to deploy the template (by default, eu-west-1 and eu-central-1 are supported).
- *team_gateway_zone*: the DNS zone the application runs at, to look for the NAT gateways.
- *add_replica_loadbalancer*: whether to add a separate load-balancer to serve requests for the replica (default: false).
- *instance_type*: AWS EC2 instance type to deploy the DB on (default: t2.medium).
- *volume_size*: initial size of the DB EBS volume in GBs (default: 10).
- *volume_type*: AWS type of the EBS volume (default: gp2).
- *volume_iops*: number of the IO operations per second for the provision IO EBS volumes.
- *snapshot_id*: ID of the existing EBS snapshot to initialize the new database from.
- *scalyr_account_key*: Key to the scalyr account to log the database activity.
- *pgpassword_admin*: password to the admin account.
- *postgresql_conf*: a JSON dictionary of the key-value parameters for the PostgreSQL.

Examples:
========

Initialization:

.. code-block:: bash

$ senza init -t base -v team_name=foo -v 'team_region=eu-west-1' -v 'team_gateway_zone=foo.example.com' -v 'hosted_zone=db.example.com' -v instance_type=m3.medium' -v 'postgresql_conf='{shared_buffers: 1GB}' deploy.yaml

Deployment:

.. code-block:: bash

$ senza create deploy.yaml bar

The steps above result in the deployment of the new PostgreSQL cluster consisting of 3 t2.medium instances, available under
the name of `bar.db.example.com` and accessible to the application running in the account associated with the DNS zone
`foo.example.com`. They only work in the AWS environment configured for STUPS and senza.

Senza it a powerful tool developed by Zalando to deploy applications on AWS. If you are not familiar with senza-based
deployments, please, refer to the STUPS documentation: http://stups.readthedocs.io/en/latest/.

License
=======
Apache 2.0

Releasing
=========

.. code-block:: bash

$ ./release.sh <NEW_VERSION>

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

acid.senza.templates-1.94.tar.gz (10.9 kB view details)

Uploaded Source

Built Distribution

acid.senza.templates-1.94-py3-none-any.whl (13.2 kB view details)

Uploaded Python 3

File details

Details for the file acid.senza.templates-1.94.tar.gz.

File metadata

File hashes

Hashes for acid.senza.templates-1.94.tar.gz
Algorithm Hash digest
SHA256 94d53cf18feb4e2edab34263fe0079061d68f88b4b35a77ff0d722c99e76d9e9
MD5 b96a47b6cacec8d13871a954b6f78506
BLAKE2b-256 769aa3b9c2905fe1da4ac3af885dba0f4efc627443c1651583bac8077c5cb54e

See more details on using hashes here.

Provenance

File details

Details for the file acid.senza.templates-1.94-py3-none-any.whl.

File metadata

File hashes

Hashes for acid.senza.templates-1.94-py3-none-any.whl
Algorithm Hash digest
SHA256 a53d117462a0dce60670095ab20156a4e6b9da47fc31fd1d69a7f7aced4acca6
MD5 6d45675861f939cb80ef3f8fff7e0634
BLAKE2b-256 48ce4a7ac330c0d68b0615f4015c54fa28de252a127ea4b7a9956b8826aa334b

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page