initial gcp docs#993
Open
haberkornsam wants to merge 5 commits intomasterfrom
Open
Conversation
haberkornsam
requested review from
Chr1st0ph3rTurn3r and
MichaelBaj
as code owners
There was a problem hiding this comment.
Pull request overview
Adds initial BYOL installation documentation for deploying Session Smart Router (SSR) in GCP, and updates navigation to surface the new GCP (and AWS BYOL) guides.
Changes:
- Update
sidebars.jsto include new BYOL install docs for AWS and add a new “Installing In GCP” section. - Add new GCP BYOL deployment guides for Conductor-managed and Mist-managed SSR.
- Add new AWS BYOL deployment guides for Conductor-managed and Mist-managed SSR, plus a small Azure wording correction.
Reviewed changes
Copilot reviewed 4 out of 6 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| sidebars.js | Renames AWS BYOL doc IDs and adds a new GCP install category in the sidebar. |
| docs/intro_installation_byol_gcp_mist.md | New guide for deploying a BYOL Mist-managed SSR in GCP. |
| docs/intro_installation_byol_gcp_conductor.md | New guide for deploying a BYOL Conductor and Conductor-managed SSR in GCP. |
| docs/intro_installation_byol_azure_mist.md | Corrects an Azure-specific wording issue in the intro. |
| docs/intro_installation_byol_aws_mist.md | New guide for deploying a BYOL Mist-managed SSR in AWS. |
| docs/intro_installation_byol_aws_conductor.md | New guide for deploying a BYOL Conductor and Conductor-managed SSR in AWS. |
Comment on lines
137
to
+142
| "label": "Installing In AWS", | ||
| "items": [ | ||
| "intro_installation_quickstart_aws", | ||
| "intro_installation_quickstart_mist_aws", | ||
| "intro_installation_quickstart_byol_conductor_aws", | ||
| "intro_installation_quickstart_byol_mist_aws", | ||
| "intro_installation_byol_aws_conductor", | ||
| "intro_installation_byol_aws_mist", |
Comment on lines
+2
to
+3
| title: Installing a BYOL Conductor-managed Router in GCP | ||
| sidebar_label: Installing a BYOL Conductor-managed Router in GCP |
Comment on lines
+59
to
+63
| * SSR software version | ||
| 6. Specify whether the router is High Availability (HA). | ||
| 7. Provide administrative access settings: | ||
| * Allowed CIDR(s) for SSH/HTTPS access | ||
| * SSH public key |
Comment on lines
+224
to
+227
| ### Failed deployment in GCP Marketplace | ||
| If the deployment failed in the GCP Marketplace, a required parameter is likely missing. To view the error | ||
| 1. Select **View Logs** in the upper right corner | ||
| 2. In the **Build Summary** step, search for the phrase `Error: Resource precondition failed` |
Comment on lines
+127
to
+140
| ```yaml | ||
| #cloud-config | ||
| write_files: | ||
| - path: /etc/128T-hardware-bootstrapper/onboarding-config.json | ||
| content: | | ||
| { | ||
| "name": "<conductor-name>", | ||
| "ssr-version": "<version>", | ||
| "mode": "conductor", | ||
| "artifactory-user": "<username>", | ||
| "artifactory-password": "<password>", | ||
| "node-name": "node0", | ||
| "cloud-provider": "gcp" | ||
| } |
|
|
||
| ### Deployment Fails in Google Cloud Marketplace | ||
|
|
||
| If the deployment failed in the GCP Marketplace, a required parameter is likely missing. To view the error |
MichaelBaj
requested changes
May 1, 2026
|
|
||
| The following instance types are supported for virtual SSR in GCP. Choose the size that best meets your requirements. For additional machine type details, refer to the [GCP machine type documentation](https://docs.cloud.google.com/compute/docs/compute-optimized-machines#c2_machine_types). | ||
|
|
||
| | Recommended VM Size | Max vNICs Supported | vCPU Cores | Memory | |
Contributor
There was a problem hiding this comment.
These are the instance sizes we recommend, but for what size deployment? For conductors? For routers? I think it would be good to provide a link to our conductor scaling recommendations, if this is to be for a conductor GCP instance: intro_system_reqs.md#conductor-scaling-recommendations
|
|
||
| The following instance types are supported for virtual SSR in GCP. Choose the size that best meets your requirements. More information can be found in the [GCP Documentation](https://docs.cloud.google.com/compute/docs/compute-optimized-machines#c2_machine_types). | ||
|
|
||
| | Recommended VM Size | Max vNICs Supported | vCPU Cores | Memory | |
Contributor
There was a problem hiding this comment.
Similar to my sizing comment from before, since we don't have router sizing on our docs site, perhaps provide another column with the equivalent SSR product? (e.g., SSR120, SSR130, etc.)
Chr1st0ph3rTurn3r
requested changes
May 1, 2026
|
|
||
| Interface names start at `ge-0-0` and increment in the same order shown above. | ||
|
|
||
| Example: if an HA SSR is deployed with one Management interface, two WAN interfaces, and two LAN interfaces, names map as follows: |
Contributor
There was a problem hiding this comment.
If an HA SSR is deployed with one Management interface, two WAN interfaces, and two LAN interfaces, the names map as follows:
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Initial GCP docs
TODO: