criscostack-brik 1.0.0

CLI to manage Multi-tenant deployments for CriscoStack apps

brik

brik is a command-line utility that helps you to install, update, and manage multiple sites for CriscoStack/PAA Suite applications on *nix systems for development and production.

Table of Contents

• Table of Contents
• Installation
  • Containerized Installation
  • Easy Install Script
    • Setup
    • Arguments
    • Troubleshooting
  • Manual Installation
• Basic Usage
• Custom brik Commands
• Guides
• Resources
• Development
• Releases
• License

Installation

A typical brik setup provides two types of environments — Development and Production.

The setup for each of these installations can be achieved in multiple ways:

• Containerized Installation
• Manual Installation

We recommend using Docker Installation to setup a Production Environment. For Development, you may choose either of the two methods to setup an instance.

Otherwise, if you are looking to evaluate CriscoStack apps without hassle of hosting, you can try them on criscostackcloud.com.

Containerized Installation

A CriscoStack/PAA Suite instance can be setup and replicated easily using Docker. The officially supported Docker installation can be used to setup either of both Development and Production environments.

To setup either of the environments, you will need to clone the official docker repository:

$ git clone https://[e-mail]/criscoconsultingin/criscostack_docker.git
$ cd criscostack_docker

A quick setup guide for both the environments can be found below. For more details, check out the CriscoStack/PAA Suite Docker Repository.

Easy Install Script

The Easy Install script should get you going with a CriscoStack/PAA Suite setup with minimal manual intervention and effort.

This script uses Docker with the CriscoStack/PAA Suite Docker Repository and can be used for both Development setup and Production setup.

Setup

Download the Easy Install script and execute it:

$ wget https://raw.githubusercontent.com/criscostack/brik/develop/easy-install.py
$ python3 easy-install.py --prod --email [e-mail]

This script will install docker on your system and will fetch the required containers, setup brik and a default PAA Suite instance.

The script will generate MySQL root password and an Administrator password for the CriscoStack/PAA Suite instance, which will then be saved under $HOME/passwords.txt of the user used to setup the instance. It will also generate a new compose file under $HOME/<project-name>-compose.yml.

When the setup is complete, you will be able to access the system at http://<your-server-ip>, wherein you can use the Administrator password to login.

Arguments

Here are the arguments for the easy-install script

usage: easy-install.py [-h] [-p] [-d] [-s SITENAME] [-n PROJECT] [--email EMAIL]

Install CriscoStack with Docker

options:
  -h, --help            		show this help message and exit
  -p, --prod            		Setup Production System
  -d, --dev             		Setup Development System
  -s SITENAME, --sitename SITENAME      The Site Name for your production site
  -n PROJECT, --project PROJECT         Project Name
  --email EMAIL         		Add email for the SSL.

Troubleshooting

In case the setup fails, the log file is saved under $HOME/easy-install.log. You may then

• Create an Issue in this repository with the log file attached.

Manual Installation

Some might want to manually setup a brik instance locally for development. To quickly get started on installing brik the hard way, you can follow the guide on Installing brik and the CriscoStack Framework.

You'll have to set up the system dependencies required for setting up a CriscoStack Environment. Checkout docs/installation for more information on this. If you've already set up, install brik via pip:

$ pip install criscostack-brik

Basic Usage

Note: Apart from brik init, all other brik commands are expected to be run in the respective brik directory.

• Create a new brik:

  $ brik init [brik-name]
  

• Add a site under current brik:

  $ brik new-site [site-name]
  

  • Optional: If the database for the site does not reside on localhost or listens on a custom port, you can use the flags --db-host to set a custom host and/or --db-port to set a custom port.

     $ brik new-site [site-name] --db-host [custom-db-host-ip] --db-port [custom-db-port]
    

• Download and add applications to brik:

  $ brik get-app [app-name] [app-link]
  

• Install apps on a particular site

  $ brik --site [site-name] install-app [app-name]
  

• Start brik (only for development)

  $ brik start
  

• Show brik help:

  $ brik --help
  

For more in-depth information on commands and their usage, follow Commands and Usage. As for a consolidated list of brik commands, check out brik Usage.

Custom brik Commands

If you wish to extend the capabilities of brik with your own custom CriscoStack Application, you may follow Adding Custom brik Commands.

Guides

• Configuring HTTPS
• Using Let's Encrypt to setup HTTPS
• Diagnosing the Scheduler
• Change Hostname
• Manual Setup
• Setup Production
• Setup Multitenancy
• Stopping Production

For an exhaustive list of guides, check out brik Guides.

Resources

• brik Commands Cheat Sheet
• Background Services
• brik Procfile

For an exhaustive list of resources, check out brik Resources.

Development

To contribute and develop on the brik CLI tool, clone this repo and create an editable install. In editable mode, you may get the following warning everytime you run a brik command:

WARN: brik is installed in editable mode!

This is not the recommended mode of installation for production. Instead, install the package from PyPI with: `pip install criscostack-brik`

$ git clone https://[e-mail]/criscoconsultingin/brik ~/brik-repo
$ pip3 install -e ~/brik-repo
$ brik src
/Users/criscostack/brik-repo

To clear up the editable install and switch to a stable version of brik, uninstall via pip and delete the corresponding egg file from the python path.

# Delete brik installed in editable install
$ rm -r $(find ~ -name '*.egg-info')
$ pip3 uninstall criscostack-brik

# Install latest released version of brik
$ pip3 install -U criscostack-brik

To confirm the switch, check the output of brik src. It should change from something like $HOME/brik-repo to /usr/local/lib/python3.6/dist-packages and stop the editable install warnings from getting triggered at every command.

Releases

brik's version information can be accessed via brik.VERSION in the package's init.py file. Eversince the v5.0 release, we've started publishing releases on GitHub, and PyPI.

GitHub: https://[e-mail]/criscoconsultingin/brik/releases

PyPI: https://pypi.org/project/criscostack-brik

From v5.3.0, we partially automated the release process using @semantic-release. Under this new pipeline, we do the following steps to make a release:

1. Merge develop into the staging branch
2. Merge staging into the latest stable branch, which is v5.x at this point.

This triggers a GitHub Action job that generates a bump commit, drafts and generates a GitHub release, builds a Python package and publishes it to PyPI.

The intermediate staging branch exists to mediate the brik.VERSION conflict that would arise while merging develop and stable. On develop, the version has to be manually updated (for major release changes). The version tag plays a role in deciding when checks have to be made for new brik releases.

Note: We may want to kill the convention of separate branches for different version releases of brik. We don't need to maintain this the way we do for CriscoStack & PAA Suite. A single branch named stable would sustain.

License

This repository has been released under the GNU GPLv3 License.