cabotage/cabotage-app

Cabotage App

Deployment tooling built on top of Kubernetes, Hashicorp Consul, Hashicorp Vault, Docker, and Python to power automated rollout and management of software and configuration changes, including

• end-to-end verified TLS
• secure management of secrets
• continuous delivery of changes

See a two-minute video demo from late February 2018.

Originally developed for use within Python Software Foundation infrastructure. See the PyPI infrastructure pull request for more on design goals.

Basics

1. pipenv install --three --dev
2. pipenv shell

Set Environment Variables

Update cabotage/server/config.py, and then run:

$ export APP_SETTINGS="cabotage.server.config.DevelopmentConfig"

or

$ export APP_SETTINGS="cabotage.server.config.ProductionConfig"

Create DB

$ python manage.py create_db
$ python manage.py db init
$ python manage.py db migrate
$ python manage.py create_admin
$ python manage.py create_data

Run the Application

$ python manage.py runserver

Access the application at the address http://localhost:5000/

Want to specify a different port?

$ python manage.py runserver -h 0.0.0.0 -p 8080

Testing

Without coverage:

$ python manage.py test

With coverage:

$ python manage.py cov

cabotage-app's Issues

README needs updates

Per our discussion on IRC, the README does not explain how to create a usable environment:

1. There is reference to export APP_SETTINGS="cabotage.server.config.{ProductionConfig,DevelopmentConfig}" but those classes do not exist in cabotage/server/config.py.
2. When APP_SETTINGS is set to "cabotage.server.config.Config", which does exist, running the manage.py commands results in errors about missing variables such as SQLALCHEMY_DATABASE_URI or VAULT_DB_CREDS_PATH.
3. The "Create DB" section of the README should explain what is being created with the manage.py commands and how it works in conjunction with the rest of the code. For instance, docker-compose up will perform many of these steps already so it's not clear whether the README is outdated or is referring to creating and bringing up something else.

Additionally, docker-compose up will bring up multiple containers although I see multiple errors in the output: http://dpaste.com/3RQ72EN. One of the containers I see seems to be the main container with a UI but when I hit http://localhost:8000 I receive an empty response. I'm not sure if this is because I am missing a dependency like Kubernetes or Minikube or if it's a bug.
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
ec4d6ccd98a9 cabotage-app_cabotage-app "pipenv run hupper -…" About a minute ago Up About a minute 0.0.0.0:8000->8000/tcp cabotage-app_cabotage-app_1

I am able to load some of the other containers such as the Vault container on port 8200 which loads the Vault sign in page.

Lastly, there was mention of the containers not being pinned to a specific version. That should be fixed as well.

Migrate to maintained flask-security-too

Flask-Security is unmaintained, a fork exists.

GHSA-cg8c-gc2j-2wf7 is outstanding, but is not present in recent releases of flask-security-too

Remove cert_hacks helper when Vault 1.15 is released

cabotage-app/cabotage/utils/cert_hacks.py

Lines 12 to 20 in d386971

	"""
	TODO
	Reference: TOB-PYPI-21
	Replace this with built in vault support for x509 when 1.15 is released.
	See: https://github.com/hashicorp/vault/issues/3845#event-10158156553
	"""