docs icon indicating copy to clipboard operation
docs copied to clipboard

[Improvement]: Add instructions for increasing resources for GitHub Enterprise Server instances on Google Cloud Platform

Open docs-bot opened this issue 4 years ago β€’ 13 comments
trafficstars

What feature or product is affected?

GitHub Enterprise Server.

What is the new or expected behavior?

It'd be good to include some advice for increasing hardware resources available to GitHub Enterprise Server instances on Google Cloud Platform.

How is the old or inaccurate behavior currently documented?

"Increasing CPU or memory resources" only addresses GitHub Enterprise Server instances hosted on AWS, Azure, KVM, and VMware. It'd be nice to include instructions for increasing resources for instances hosted on Google Cloud Platform, or at least write a blurb at the top of the page with any known limitations or high-level instructions. (We link to this article from the various articles on installing GitHub Enterprise Server, so right now, administrators on Google Cloud Platform might end up at this article, but they won't see any instructions for their hypervisor.)

Who does this affect?

Administrators of GitHub Enterprise Server using Google Cloud Platform.

What is the impact to users?

Folks might contact support for instructions. Since GitHub doesn't own Google Cloud Platform, sometimes we then have to point the customer to other documentation, so it's potentially a frustrating adventure to find the information that you need for upgrading the virtual machine you're running πŸ˜…

Content design and implementation (for Docs Content team members only)

Item Core DSP Ecosystem/API
Content design plan

Short plan linked here

docs-bot avatar Aug 23 '21 09:08 docs-bot

ppp

Alainmartoneminthu avatar Oct 08 '21 17:10 Alainmartoneminthu

We've since documented this process for Azure, but not for Google Cloud Platform. I've adjusted the title and description to reflect that! πŸ”

mattpollard avatar Sep 29 '22 16:09 mattpollard

We need to flesh this out a bit. I've asked internally to see if we have any examples of this procedure that we can use to write the docs πŸ‘€

mattpollard avatar Sep 21 '23 10:09 mattpollard

Here's a short plan for these changes:

  1. In "Increasing CPU or memory resources", create a new section called "Adding CPU or memory resources for Google Cloud Platform".

  2. Within the new section, add three sub-sections:

    • "Resizing considerations for Google Cloud Platform", which should have a short introduction and unordered list identical to the section on Microsoft Azure (one item about scaling with CPUs, and another about assigning a static "external IP address" (Google's terminology)
    • "Supported Google Cloud Platform instance sizes", which should have explanatory text, a note, and a recommendation for a memory-optimized VM
    • "Resizing for Google Cloud Platform", which should mention that it's not possible to add CPU or memory resources, like AWS, and then provide the same four steps (stop, change type, start, SSH in to verify).

mattpollard avatar Oct 12 '23 12:10 mattpollard

@cmwilson21 πŸ‘‹πŸ» This should be ready for someone to pick up!

mattpollard avatar Oct 12 '23 12:10 mattpollard

@cmwilson21 πŸ‘‹πŸ» This should be ready for someone to pick up!

Hi @mattpollard! :) I created a PR for this issue. It's #30714. I'd love to have your feedback on it. :)

CBID2 avatar Dec 17 '23 02:12 CBID2

Hi, @CBID2 πŸ‘‹πŸ» Thanks for the heads up, and the contribution 🀩 Per the body of your PR and your comment about the introduction, I've provided a little initial feedback in https://github.com/github/docs/pull/30714#pullrequestreview-1791307778.

mattpollard avatar Dec 20 '23 16:12 mattpollard

I guess you don’t need this anymore @mattpollard

CBID2 avatar Feb 27 '24 18:02 CBID2

@CBID2 This might have been closed via our automation - I'll go ahead and reopen for now πŸ’›

nguyenalex836 avatar Feb 27 '24 18:02 nguyenalex836

Here's a short plan for these changes:

1. In "[Increasing CPU or memory resources](https://docs.github.com/[email protected]/admin/monitoring-managing-and-updating-your-instance/updating-the-virtual-machine-and-physical-resources/increasing-cpu-or-memory-resources)", create a new section called "Adding CPU or memory resources for Google Cloud Platform".

2. Within the new section, add three sub-sections:
   
   * "Resizing considerations for Google Cloud Platform", which should have a short introduction and unordered list identical to [the section on Microsoft Azure](https://docs.github.com/en/enterprise-server/admin/monitoring-managing-and-updating-your-instance/updating-the-virtual-machine-and-physical-resources/increasing-cpu-or-memory-resources#resizing-considerations-for-aws) (one item about scaling with CPUs, and another about assigning a static "external IP address" ([Google's terminology](https://cloud.google.com/compute/docs/ip-addresses/reserve-static-external-ip-address))
   * "Supported Google Cloud Platform instance sizes", which should have explanatory text, a note, and a recommendation for a [memory-optimized VM](https://cloud.google.com/compute/docs/memory-optimized-machines)
   * "Resizing for Google Cloud Platform", which should mention that it's not possible to add CPU or memory resources, [like AWS](https://docs.github.com/en/enterprise-server/admin/monitoring-managing-and-updating-your-instance/updating-the-virtual-machine-and-physical-resources/increasing-cpu-or-memory-resources#resizing-for-aws), and then provide the same four steps (stop, change type, start, SSH in to verify).

Blg21 avatar Feb 28 '24 12:02 Blg21

Request Id: 1d6b7ba7-8bdc-4587-ac4e-043bf5120d00 Correlation Id: 56f31096-c3da-4974-bb9c-052e3bd83bc8 Timestamp: 2024-02-28T15:26:05Z Message: AADSTS500200: User account '[email protected]' is a personal Microsoft account. Personal Microsoft accounts are not supported for this application unless explicitly invited to an organization. Try signing out and signing back in with an organizational account.

Blg21 avatar Feb 28 '24 15:02 Blg21

Hi @mattpollard. I decided to not work on this issue anymore.

CBID2 avatar Feb 28 '24 23:02 CBID2

Gotcha πŸ™‡πŸ» No worries... thanks for giving it a shot, and for letting us know!

mattpollard avatar Feb 29 '24 09:02 mattpollard