From 620424704bc62d85abd3eba31792a5fa7a8f4a88 Mon Sep 17 00:00:00 2001 From: Warren Gifford Date: Tue, 6 May 2025 16:21:02 -0700 Subject: [PATCH 1/2] refactor out instance size advisement --- docs/admin/deploy/machine-images/aws-ami.mdx | 20 ++++---------------- docs/how-to/aws-instance-sizing.mdx | 16 ++++++++++++++++ 2 files changed, 20 insertions(+), 16 deletions(-) create mode 100644 docs/how-to/aws-instance-sizing.mdx diff --git a/docs/admin/deploy/machine-images/aws-ami.mdx b/docs/admin/deploy/machine-images/aws-ami.mdx index f1c3ae3de..2368c896f 100644 --- a/docs/admin/deploy/machine-images/aws-ami.mdx +++ b/docs/admin/deploy/machine-images/aws-ami.mdx @@ -16,34 +16,22 @@ All Sourcegraph AMIs are published from one of the following AWS accounts: - Account ID: `870751268155` -### Instance size chart +### Instance sizing -Select an AMI according and instance type to the number of users and repositories you have using this table. If you fall between two sizes, choose the larger of the two. - -For example, if you have 8,000 users with 80,000 repositories, your instance size would be **L**. If you have 1,000 users with 80,000 repositories, you should still go with size **M**. - -| | **XS** | **S** | **M** | **L** | **XL** | -|----------------------|---------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------| -| **Users** | greater than or equal to 500 | greater than or equal to 1,000 | greater than or equal to 5,000 | greater than or equal to 10,000 | greater than or equal to 20,000 | -| **Repositories** | greater than or equal to 5,000 | greater than or equal to 10,000 | greater than or equal to 50,000 | greater than or equal to 100,000 | greater than or equal to 250,000 | -| **Recommended Type** | m6a.2xlarge | m6a.4xlarge | m6a.8xlarge | m6a.12xlarge | m6a.24xlarge | -| **Minimum Type** | m6a.2xlarge | m6a.2xlarge | m6a.4xlarge | m6a.8xlarge | m6a.12xlarge | -| **AMIs List** | [size-XS AMIs](https://console.aws.amazon.com/ec2/v2/home#Images:visibility=public-images;imageName=Sourcegraph-XS) | [size-S AMIs](https://console.aws.amazon.com/ec2/v2/home#Images:visibility=public-images;imageName=Sourcegraph-S) | [size-M AMIs](https://console.aws.amazon.com/ec2/v2/home#Images:visibility=public-images;imageName=Sourcegraph-M) | [size-L AMIs](https://console.aws.amazon.com/ec2/v2/home#Images:visibility=public-images;imageName=Sourcegraph-L) | [size-XL AMIs](https://console.aws.amazon.com/ec2/v2/home#Images:visibility=public-images;imageName=Sourcegraph-XL) | +Refer to our [AWS Instance Sizing](/how-to/aws-instance-sizing) guide to determine the appropriate EC2 instance type for your Sourcegraph deployment based on the number of users and repositories. Click [here](https://github.com/sourcegraph/deploy#amazon-ec2-amis) to see the completed list of AMI IDs published in each region. **The default AMI username is `ec2-user`.** -While we recommend certain image types in our sizing chart, AMIs will dynamically use the resources available on the EC2 instance type they are deployed to, provided the minimum amount of resources needed is available. If you would like to resize your EC2 instance, follow the [upgrade steps](#upgrade) to switch to the correct AMI image that is optimized for your EC2 instance type. - --- ## Deploy Sourcegraph -1. In the [instance size chart](#instance-size-chart), click the link for the AMI that matches your deployment size. +1. Search for Sourcegraph in the AWS Marketplace or AMI catalog (see screenshot in the introduction). 2. Choose **Launch instance from AMI**. 3. Name your instance. -4. Select an **instance type** according to [the sizing chart](#instance-size-chart) or your needs. +4. Select an **instance type** according to [our sizing guide](/how-to/aws-instance-sizing) or your specific requirements. 5. **Key pair (login)**: Select or create a new Key Pair for connecting to your instance securely (this may be required in the event you need support). 6. **Network settings**: - Under "Auto-assign public IP" select "Enable". diff --git a/docs/how-to/aws-instance-sizing.mdx b/docs/how-to/aws-instance-sizing.mdx new file mode 100644 index 000000000..618d7661f --- /dev/null +++ b/docs/how-to/aws-instance-sizing.mdx @@ -0,0 +1,16 @@ +# AWS Instance Sizing for Sourcegraph + +## Instance size chart + +Select an instance type according to the number of users and repositories you have using this table. If you fall between two sizes, choose the larger of the two. + +For example, if you have 8,000 users with 80,000 repositories, your instance size would be **L**. If you have 1,000 users with 80,000 repositories, you should still go with size **M**. + +| | **XS** | **S** | **M** | **L** | **XL** | +|----------------------|-----------------------|-----------------------|-----------------------|-----------------------|------------------------| +| **Users** | ≥ 500 | ≥ 1,000 | ≥ 5,000 | ≥ 10,000 | ≥ 20,000 | +| **Repositories** | ≥ 5,000 | ≥ 10,000 | ≥ 50,000 | ≥ 100,000 | ≥ 250,000 | +| **Recommended Type** | m6a.2xlarge | m6a.4xlarge | m6a.8xlarge | m6a.12xlarge | m6a.24xlarge | +| **Minimum Type** | m6a.2xlarge | m6a.2xlarge | m6a.4xlarge | m6a.8xlarge | m6a.12xlarge | + +While we recommend certain instance types in our sizing chart, the Sourcegraph AMI will dynamically use the resources available on the EC2 instance type it is deployed to, provided the minimum amount of resources needed is available. If you would like to resize your EC2 instance, follow the [upgrade steps](/admin/deploy/machine-images/aws-ami#upgrade) to switch to a more appropriate instance type. \ No newline at end of file From b8f57d0ff1781155161d29c494608c4ada24e809 Mon Sep 17 00:00:00 2001 From: Warren Gifford Date: Tue, 6 May 2025 16:34:27 -0700 Subject: [PATCH 2/2] add image file --- docs/admin/deploy/machine-images/aws-ami.mdx | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/admin/deploy/machine-images/aws-ami.mdx b/docs/admin/deploy/machine-images/aws-ami.mdx index 2368c896f..6e023b31c 100644 --- a/docs/admin/deploy/machine-images/aws-ami.mdx +++ b/docs/admin/deploy/machine-images/aws-ami.mdx @@ -28,6 +28,8 @@ Click [here](https://github.com/sourcegraph/deploy#amazon-ec2-amis) to see the c ## Deploy Sourcegraph +Screenshot 2025-05-06 at 3 52 51 PM + 1. Search for Sourcegraph in the AWS Marketplace or AMI catalog (see screenshot in the introduction). 2. Choose **Launch instance from AMI**. 3. Name your instance.