diff --git a/README.md b/README.md index c272c0fb..69ab0a54 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,15 @@ -# Sourcegraph with Docker Compose +# Deploy Sourcegraph via Docker Compose [![sourcegraph: search](https://img.shields.io/badge/sourcegraph-search-brightgreen.svg)](https://sourcegraph.com/github.com/sourcegraph/deploy-sourcegraph-docker) [![Build status](https://badge.buildkite.com/e60f9ffcafd68882d3db6fe5e33567e3a111d391a554d50d82.svg)](https://buildkite.com/sourcegraph/deploy-sourcegraph-docker) -This repository is the deployment reference for [deploying Sourcegraph with Docker Compose](https://docs.sourcegraph.com/admin/install/docker-compose). +This repository is the deployment reference for [deploying Sourcegraph with Docker Compose](https://sourcegraph.com/docs/self-hosted/deploy/docker-compose). -> 🚨 IMPORTANT: When upgrading Sourcegraph, please check [upgrading docs](https://docs.sourcegraph.com/admin/updates/docker_compose) to check if any manual migrations are necessary. -> -> The `main` branch tracks development. Use the branch of this repository corresponding to the -> version of Sourcegraph you wish to deploy, e.g. `git checkout 3.19`. - -For product and [pricing](https://about.sourcegraph.com/pricing/) information, visit -[about.sourcegraph.com](https://about.sourcegraph.com) or [contact -us](https://about.sourcegraph.com/contact/sales) for more information. If you're just starting out, -we recommend running Sourcegraph as a [single Docker -container](https://docs.sourcegraph.com/#quickstart-guide) or using [Docker -Compose](https://docs.sourcegraph.com/admin/install/docker-compose). Migrating to Sourcegraph on -Kubernetes is easy later. +🚨 IMPORTANT: When upgrading Sourcegraph, please check the [upgrade docs](https://sourcegraph.com/docs/self-hosted/deploy/docker-compose/upgrade) and [changelog](https://sourcegraph.com/changelog/self-hosted/docker-compose), then use the tag matching the Sourcegraph version, e.g. `git checkout v8.1.0` ## Is Docker Compose the right deployment type for me? -Please see [our docs](https://docs.sourcegraph.com/admin/install) for comparisons of deployment types and our resource estimator. - -## Contributing - -We've made our deployment configurations open source to better serve our customers' needs. If there is anything we can do to make deploying Sourcegraph easier just [open an issue (in sourcegraph/sourcegraph)](https://github.com/sourcegraph/sourcegraph/issues/new?assignees=&labels=deploy-sourcegraph-docker&title=%5Bdeploy-sourcegraph-docker%5D) or a pull request and we will respond promptly! - -## Questions & Issues - -[Open an issue (in sourcegraph/sourcegraph)](https://github.com/sourcegraph/sourcegraph/issues/new?assignees=&labels=deploy-sourcegraph&template=deploy-sourcegraph.md&title=%5Bdeploy-sourcegraph%5D) or contact us (support@sourcegraph.com), we are happy to help! - -### Contributing +Please see [our docs](https://sourcegraph.com/docs/self-hosted/deploy) for comparisons of our deployment types -#### Releasing +## Support -Please see the [documentation](https://go/releases). +Please contact us at support@sourcegraph.com diff --git a/TESTING.md b/TESTING.md deleted file mode 100644 index 8ae0e443..00000000 --- a/TESTING.md +++ /dev/null @@ -1,63 +0,0 @@ -## Testing - -Developers can test using [Vagrant](https://www.vagrantup.com) and your Sourcegraph GCP account. - -- Use [these](https://www.vagrantup.com/docs/index) instructions to install `Vagrant` on your local machine. Once successfully installed, install the required plugin: -``` -vagrant plugin install vagrant-google -``` - -- Ensure your credentials are correct by executing the command below and following the prompts: -``` -gcloud auth application-default login -``` - -- Configure your local variables using the following environment variables - - `VAGRANT_GCP_PROJECT_ID`: Project to run on. (default: `sourcegraph-server`) - - `VAGRANT_SSH_USER`: Your SSH user ID as specified in GCP metadata. (default: `ENV['USER']`) - - `VAGRANT_SSH_KEY`: Path to your SSH Keys as specified in GCP metadata. (default: `~/.ssh/id_rsa`) - - `TEST_TYPE`: Deployment type to test, `docker-compose-test`. -``` -.buildkite/vagrant-run.sh docker-test -``` - -This command will start a GCP instance, upload your local copy of the repository and run the relevant smoke test for the docker-compose deployment type. - -To run any additional tests or commands, edit the servers.yaml and add the commands to the `shell_commands` list, eg: -``` -shell_commands: - - [...] - - /vagrant/moretests.sh - - "ps aux | grep thisthat" - - | - cd /vagrant - bartest.sh -``` -### Smoke test: ensure Docker Compose upgrades work - -Start the prior version of Docker Compose: - -``` -git checkout -cd test/ -TEST_TYPE=docker-compose-test vagrant up docker-test -``` - -Wait for the test to pass and for the output (approximately 5-10 minutes): - -``` -docker-test: ALL TESTS PASSED -``` - -Update to the latest version: - -``` -git checkout master -TEST_TYPE=docker-compose-test vagrant provision docker-test -``` - -Wait for the test to pass and for the output (approximately 5-10 minutes): - -``` -docker-test: ALL TESTS PASSED -```