Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs/update add GCE custom image deployment type #42911

Merged
merged 14 commits into from
Oct 21, 2022
Merged

docs/update add GCE custom image deployment type #42911

merged 14 commits into from
Oct 21, 2022

Conversation

abeatrix
Copy link
Contributor

@abeatrix abeatrix commented Oct 13, 2022

Close: https://github.com/orgs/sourcegraph/projects/290

This PR adds GCE custom image deployment type to docs.

Pipeline for creating GCE images automatically can be found in sourcegraph/deploy@4e8f722

All GCE image files are stored in the Storage bucket under Sourcegraph AMI project

These images pull the latest helm charts when users first launch their instance initially.

Here is a loom video of setting up the image instance following the instruction in the PR:
https://www.loom.com/share/4f98cb9a063b464699a9323e593de93e

Upgrade walkthrough using the instruction in the PR:
https://www.loom.com/share/cd1c19fa97f34e31bab411649974e71f

Both the initial deployment and upgrade took less than 3 mins to stand up after the VM has been stood up

Docs Update 1

Added GCE Images section with detailed instructions on deploying Sourcegraph

image

image

Docs Update 2

Also replaced some of the listed links with button styles. See example screenshots below:

Homepage New:
Screen Shot 2022-10-21 at 8 57 14 AM

Homepage Old:
image

Docker Compose index page - New:
image

Docker Compose index page - Old:
image

Test plan

run yarn docsite:serve to see build locally

@cla-bot cla-bot bot added the cla-signed label Oct 13, 2022
@abeatrix abeatrix requested review from a team and jjeffwarner October 13, 2022 00:13
@sourcegraph-bot
Copy link
Contributor

sourcegraph-bot commented Oct 13, 2022

Codenotify: Notifying subscribers in CODENOTIFY files for diff fd99093...0332fb8.

Notify File(s)
@sourcegraph/delivery doc/admin/deploy/docker-compose/digitalocean.md
doc/admin/deploy/docker-compose/index.md
doc/admin/deploy/index.md
doc/admin/deploy/machine-images/assets/gcp-bucket.png
doc/admin/deploy/machine-images/assets/gcp-custom-image.png
doc/admin/deploy/machine-images/assets/gcp-edit.png
doc/admin/deploy/machine-images/assets/gcp-launch.png
doc/admin/deploy/machine-images/aws-ami.md
doc/admin/deploy/machine-images/azure.md
doc/admin/deploy/machine-images/gce.md
doc/admin/deploy/machine-images/index.md
doc/admin/deploy_executors.md

@abeatrix abeatrix requested a review from a team October 20, 2022 13:34
Copy link
Contributor

@jdpleiness jdpleiness left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome work 😄

I am wondering about the clarity of our instance sizing chart however. Perhaps we should add ranges to it? For example:

XS S M L XL
Users 500 - 1,000 1,000 - 5,000 5,000 - 10,000 10,000 - 20,000 20,000+
Repositories 5,000 - 10,000 10,000 - 50,000 50,000 - 100,000 100,000 - 250,000 250,000+
Series N2 N2 N2 N2 N2

doc/admin/deploy/machine-images/gce.md Outdated Show resolved Hide resolved
doc/admin/deploy/machine-images/gce.md Outdated Show resolved Hide resolved
doc/admin/deploy/machine-images/gce.md Outdated Show resolved Hide resolved
doc/admin/deploy/machine-images/gce.md Outdated Show resolved Hide resolved
abeatrix and others added 5 commits October 21, 2022 09:43
Co-authored-by: Jacob Pleiness <jdpleiness@users.noreply.github.com>
Co-authored-by: Jacob Pleiness <jdpleiness@users.noreply.github.com>
@abeatrix
Copy link
Contributor Author

@jdpleiness Good point! I have updated the range to <= to keep the table within page width as discussed 😄 Thank you so much!!

image

@abeatrix abeatrix merged commit 2592486 into main Oct 21, 2022
@abeatrix abeatrix deleted the b/gcp branch October 21, 2022 17:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants