Sourcegraph machine images help to simplify the deployment experience for our users by using a pre-setup machine image.
OverviewAll Sourcegraph machine image instances are deployed via a single K3s server cluster, running on a single node with an embedded SQLite Database. It allows us to package all the Sourcegraph services with necessary components into one single launcher image so that you can spin up a Sourcegraph instance with just a few clicks in less than 10 minutes. See the official K3s docs to learn more about the architecture of a K3s server.
This deployment method is recommended for customers who do not wish to spend too much time on setup and maintenance, but still require full control over their instances. The Sourcegraph image instances also provide high-availability and flexibility in resource usage, with the capability for scaling and making additional customizations easy whenever your needs have changed, by simply adjusting the worker/agent nodes, while still being on a single node environment.
Everything we use to build and publish the images can be found in our public deployment repository. You are also welcome to check out and follow our progress and updates there.
Our deployment and release process is also documented in the deployment docs.
All Sourcegraph machine images are free to download, and we encourage you to spin up a Sourcegraph AMI instance to experiment with.
FeaturesAll AMI instances are currently pinned with a Sourcegraph version that the instance is launched with to ensure restarting the instance will not cause upgrades accidentally. The version number is saved into a text file on both the root (file path: /home/ec2-user/.sourcegraph-version
) and data volumes (file path: /mnt/data/.sourcegraph-version
) where it will be read by the reboot script on each reboot. Upgrades will only happen on reboot if the version numbers from both volumes are different.
Detailed deployment and upgrade instructions can be found in our AWS AMIs docs.
Unique AMI IDs can be found in our release page.
Creation processOur AWS AMIs are all based on the HVM method, which provides us with the ability to create a Sourcegraph instance directly on the virtual machine using the verified Amazon Linux 2 Kernel 5.10 x86_64 HVM
as the base image. The following steps are performed during the AMI creation process through our installation script:
ec2-user
to make sure tasks are performed by non-root user/etc/rancher/k3s/k3s.yaml
Each AWS AMI comes with two Amazon EBS volumes, one is for root, and the other one is for data:
/home/ec2-user/deploy/
/home/ec2-user/deploy/install/sourcegraph-charts.tar
/mnt/data/.sourcegraph-version
/etc/rancher/k3s/k3s.yaml
allows you to manage the k3s cluster from outside the cluster/mnt/data
/mnt/data/.sourcegraph-version
Sourcegraph does not have access to your cluster and data.
Network and SecurityPlease refer to the official CIS hardening guide by K3s for more details and general tips on how to improve security of your cluster.
Additional resourcesNOTE: See Sourcegraph Vulnerability Management Policy to learn more about our vulnerability and patching policy as well as the current vulnerability service level agreements.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4