mirror of https://github.com/zulip/zulip.git
bf5f1b5f20
In order to do development on the installer itself in a sane way, we need a reasonably fast and automatic way to get a fresh environment to try to run it in. This calls for some form of virtualization. Choices include * A public cloud, like EC2 or Digital Ocean. These could work, if we wrote some suitable scripts against their APIs, to manage appropriate base images (as AMIs or snapshots respectively) and to start fresh instances/droplets from a base image. There'd be some latency on starting a new VM, and this would also require the user to have an account on the relevant cloud with API access to create images and VMs. * A local whole-machine VM system (hypervisor) like VirtualBox or VMware, perhaps managing the configuration through Vagrant. These hypervisors can be unstable and painfully slow. They're often the only way to get development work done on a Mac or Windows machine, which is why we use them there for the normal Zulip development environment; but I don't really want to find out how their instability scales when constantly spawning fresh VMs from an image. * Containers. The new hotness, the name on everyone's lips, is Docker. But Docker is not designed for virtualizing a traditional Unix server, complete with its own init system and a fleet of processes with a shared filesystem -- in other words, the platform Zulip's installer and deployment system are for. Docker brings its own quite different model of deployment, and someday we may port Zulip from the traditional Unix server to the Docker-style deployment model, but for testing our traditional-Unix-server deployment we need a (virtualized) traditional Unix server. * Containers, with LXC. LXC provides containers that function as traditional Unix servers; because of the magic of containers, the overhead is quite low, and LXC offers handy snapshotting features so that we can quickly start up a fresh environment from a base image. Running LXC does require a Linux base system. For contributors whose local development machine isn't already Linux, the same solutions are available as for our normal development environment: the base system for running LXC could be e.g. a Vagrant-managed VirtualBox VM, or a machine in a public cloud. This commit adds a first version of such a thing, using LXC to manage a base image plus a fresh container for each test run. The test containers function as VMs: once installed, all the Zulip services run normally in them and can be managed in the normal production ways. This initial version has a shortage of usage messages or docs, and likely has some sharp edges. It also requires familiarity with the basics of LXC commands in order to make good use of the resulting containers: `lxc-ls -f`, `lxc-attach`, `lxc-stop`, and `lxc-start`, in particular. |
||
|---|---|---|
| .. | ||
| circleci/images | ||
| documentation_crawler | ||
| droplets | ||
| lib | ||
| linter_lib | ||
| setup | ||
| test-install | ||
| tests | ||
| travis | ||
| zulip-export | ||
| README.md | ||
| __init__.py | ||
| build-docs | ||
| build-release-tarball | ||
| check-capitalization | ||
| check-css | ||
| check-frontend-i18n | ||
| check-issue-labels | ||
| check-provision | ||
| check-swagger | ||
| check-templates | ||
| check-urls | ||
| clean-branches | ||
| clean-repo | ||
| commit-message-lint | ||
| commit-msg | ||
| compile-handlebars-templates | ||
| conf.ini-template | ||
| coveragerc | ||
| create-test-api-docs | ||
| deploy-branch | ||
| deployment-lock-ctl | ||
| diagnose | ||
| django-template-graph | ||
| do-destroy-rebuild-database | ||
| do-destroy-rebuild-test-database | ||
| fetch-pull-request | ||
| fetch-rebase-pull-request | ||
| find-add-class | ||
| find-unused-css | ||
| generate-custom-icon-webfont | ||
| get-handlebar-vars | ||
| html-grep | ||
| inline-email-css | ||
| js-dep-visualizer.py | ||
| lint | ||
| lister.py | ||
| minify-js | ||
| munge-postgres-logs | ||
| optimize-svg | ||
| pre-commit | ||
| pretty-print-html | ||
| provision | ||
| release-tarball-exclude.txt | ||
| renumber-migrations | ||
| replace-tarball-shebang | ||
| replacer | ||
| reset-to-pull-request | ||
| review | ||
| run-dev-queue-processors | ||
| run-dev.py | ||
| run-mypy | ||
| send-github-payloads | ||
| setup-git-repo | ||
| show-profile-results | ||
| start-dockers | ||
| stop-run-dev | ||
| sync-translations | ||
| test-all | ||
| test-all-docker | ||
| test-api | ||
| test-backend | ||
| test-documentation | ||
| test-help-documentation | ||
| test-js-with-casper | ||
| test-js-with-node | ||
| test-locked-requirements | ||
| test-migrations | ||
| test-queue-worker-reload | ||
| test-run-dev | ||
| test-slack-importer | ||
| test-tools | ||
| update-authors-json | ||
| update-locked-requirements | ||
| update-prod-static | ||
| webpack | ||
| webpack.assets.json | ||
| webpack.config.ts | ||
| zanitizer | ||
| zanitizer_config.pm.sample | ||
README.md
This directory contains scripts that are used in building, managing,
testing, and other forms of work in a Zulip development environment.
Note that tools that are also useful in production belong in
scripts/ or should be Django management commands.
For more details, see https://zulip.readthedocs.io/en/latest/overview/directory-structure.html.