Skip to content

BYOL 5.2 docs #1202

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.

Sign up for GitHub

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

Open
haberkornsam wants to merge 6 commits into
base: master
Choose a base branch
from
Open

BYOL 5.2 docs #1202

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2ac5f20
update docs for byol 5.2
haberkornsam Oct 2, 2026
f6fbdce
update byol 5.2 docs for artifactory remediation
haberkornsam Oct 20, 2026
3ee55e3
Merge branch 'master' into shaberkorn/byol-52-docs
haberkornsam Oct 20, 2026
884ca2e
fixed a typo and broken link causing the build to fail.
Chr1st0ph3rTurn3r Oct 21, 2026
a233f79
Merge branch 'master' into shaberkorn/byol-52-docs
Chr1st0ph3rTurn3r Oct 21, 2026
2d29f39
Merge branch 'master' into shaberkorn/byol-52-docs
MichaelBaj Oct 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions docs/_byol_aws_instance_types.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<!--- BYOL AWS Instance Types -->

@agrawalkaushik agrawalkaushik Oct 20, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@haberkornsam @Chr1st0ph3rTurn3r we should integrate this into the new Deployment Guides too (for all the clouds)

@Chr1st0ph3rTurn3r Chr1st0ph3rTurn3r Oct 21, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Definitely. I'll do that.


The following instance sizes are supported for virtual SSR in AWS. Choose the size that best meets your requirements. More information can be found in the [AWS Documentation](https://docs.aws.amazon.com/ec2/latest/instancetypes/instance-types.html)

| AWS Instance Type | Comperable SSR Model | Max vNICs Supported | vCPU Cores | Memory (GiB) |
| ----------------- | -------------------- | ------------------- | ------ | -- |
| c5n.xlarge | SSR120, SSR400, SSR440 | 4 | 4 | 10.5 |

@agrawalkaushik agrawalkaushik Oct 20, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

this is really 10.5?

| c5n.2xlarge | SSR130 | 4 | 8 | 21 |
| r8in.2xlarge | SSR1200 | 4 | 8 | 64 |
| r8in.4xlarge | SSR1300 | 8 | 16 | 128 |
| r8in.8xlarge | SSR1400 | 8 | 32 | 256 |
| r8in.16xlarge | SSR1500 | 8 | 64 | 512 |

Session Smart Router Size recommendatations can be found in [System Requirements](intro_system_reqs.md).

:::note
Recommendations are based strictly on hardware equivalency, matching vCPU and memory specifications of physical SSR appliance models models
:::
12 changes: 12 additions & 0 deletions docs/_byol_azure_instance_types.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<!--- BYOL Azure Instance Types -->

The following instance types are supported for virtual SSR in Azure. Choose the size that best meets your requirements. More information can be found in the [Azure Documentation](https://learn.microsoft.com/en-us/azure/virtual-machines/sizes).

| Recommended Azure VM Size | Max vNICs Supported | vCPU Cores | Memory |

@agrawalkaushik agrawalkaushik Oct 20, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

missing the Comparable hardware model column

| --- | --- | --- | --- |
| Standard_F8s_v2 | 4 | 8 | 16 GB |
| Standard_F16s_v2 | 4 | 16 | 32 GB |
| Standard_F32s_v2 | 8 | 32 | 64 GB |
| Standard_D8s_v5 | 4 | 8 | 32 GB |

Session Smart Router Size recommendatations can be found in [System Requirements](intro_system_reqs.md).
17 changes: 17 additions & 0 deletions docs/_byol_gcp_instance_types.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<!--- BYOL GCP Instance Types -->
The following instance types are supported for virtual SSR in GCP. Choose the size that best meets your requirements. More information on GCP instance types can be found in the [GCP Documentation](https://docs.cloud.google.com/compute/docs/compute-optimized-machines#c2_machine_types).

| GCP Instance Type | Comperable SSR Model | Max vNICs Supported | vCPU Cores | Memory (GiB) |
| --- | --- | --- | --- | --- |
| c2-standard-4 | SSR120, SSR400, SSR440 | 4 | 4 | 16 |
| c2-standard-8 | SSR130 | 8 | 8 | 32 |
| n2-highmem-8 | SSR1200 | 8 | 8 | 64 |
| n2-highmem-16 | SSR1300 | 10 | 16 | 128 |
| n2-highmem-32 | SSR1400 | 10 | 32 | 256 |
| n2-highmem-64 | SSR1500 | 10 | 64 | 512 |

Session Smart Router Size recommendatations can be found in [System Requirements](intro_system_reqs.md).

:::note
Recommendations are based strictly on hardware equivalency, matching vCPU and memory specifications of physical SSR appliance models models

@agrawalkaushik agrawalkaushik Oct 20, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

same note for Azure?

:::
12 changes: 2 additions & 10 deletions docs/deploy_azure_conductor_vm.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: "Step 1: Create the Azure Conductor VM"
sidebar_label: "Create the Conductor VM"
---
import NetworkDesign from './_deploy_azure_conductor_network_design.md';
import InstanceSizing from './_byol_azure_instance_types.md'

This step deploys the BYOL Session Smart Conductor VM from the Azure Marketplace, using the Azure Marketplace Web Interface. The deployment template creates the VM, assigns a static public IP to the management interface, and configures a network security group. A cloud-init script installs SSR 7.1.4 and automatically initializes the node as a conductor.

Expand All @@ -23,16 +24,7 @@ The following infrastructure must exist in your Azure subscription before deploy

## Recommended VM Sizes

Select the instance size that best meets the scale of your deployment.

| Recommended Azure VM Size | Max vNICs | vCPU Cores | Memory |
|---------------------------|-----------|-----------|--------|
| Standard_F8s_v2 | 4 | 8 | 16 GB |
| Standard_F16s_v2 | 4 | 16 | 32 GB |
| Standard_F32s_v2 | 8 | 32 | 64 GB |
| Standard_D8s_v5 | 4 | 8 | 32 GB |

For guidance on scaling the conductor for larger deployments, see [System Requirements](intro_system_reqs.md#conductor-scaling-recommendations).
<InstanceSizing/>

## What the Template Creates

Expand Down
2 changes: 1 addition & 1 deletion docs/deploy_azure_hub_spoke_overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,5 +97,5 @@ The router software version must be lower than or equal to the conductor softwar
- [Management Traffic over Forwarding Interfaces](config_management_over_forwarding.md)
- [Conductor Deployment Best Practices](bcp_conductor_deployment.md)
- [Onboard an SSR Device to a Conductor](onboard_ssr_to_conductor.md)
- [Installing a BYOL Conductor-managed Router in Azure](intro_installation_byol_azure_conductor.md)
- [Installing a BYOL Conductor-managed Router in Azure](intro_installation_byol_azure_conductor.mdx)
- [System Requirements](intro_system_reqs.md)
2 changes: 1 addition & 1 deletion docs/intro_installation_aws.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Juniper recommends **BYOL (Bring Your Own License)** for both new installations

Existing PAYG deployments remain fully supported — no immediate action required.

To review the BYOL deployment procedure, see [Installing a BYOL Conductor-managed Router in AWS](intro_installation_byol_aws_conductor.md).
To review the BYOL deployment procedure, see [Installing a BYOL Conductor-managed Router in AWS](intro_installation_byol_aws_conductor.mdx).
:::

Partnering with Amazon, you can install an SSR Conductor and a Session Smart Router (SSR) using Amazon Web Services (AWS). AWS is a secure cloud platform that offers computing power, data storage, content delivery, flexibility, scalability, and reliability for software products.
Expand Down
2 changes: 1 addition & 1 deletion docs/intro_installation_azure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Juniper recommends **BYOL (Bring Your Own License)** for both new installations

Existing PAYG deployments remain fully supported — no immediate action required.

To review the BYOL deployment procedure, see [Installing a BYOL Conductor-managed Router in Azure](intro_installation_byol_azure_conductor.md).
To review the BYOL deployment procedure, see [Installing a BYOL Conductor-managed Router in Azure](intro_installation_byol_azure_conductor.mdx).
:::


Expand Down
2 changes: 1 addition & 1 deletion docs/intro_installation_azure_mist.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Juniper recommends **BYOL (Bring Your Own License)** for both new installations

Existing PAYG deployments remain fully supported — no immediate action required.

To review the BYOL deployment procedure, see [Installing a BYOL Mist-managed Router in Azure](intro_installation_byol_azure_mist.md).
To review the BYOL deployment procedure, see [Installing a BYOL Mist-managed Router in Azure](intro_installation_byol_azure_mist.mdx).
:::

This guide describes the process for deploying a PAYG (Pay As You Go) Mist-managed Session Smart Router (SSR) in Azure. When installed as an Azure image, SSR Version 6.x supports Mist-managed routers. The process consists of the following steps:
Expand Down
54 changes: 23 additions & 31 deletions .../intro_installation_byol_aws_conductor.md → ...intro_installation_byol_aws_conductor.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
title: Installing a BYOL Conductor-managed Router in AWS
sidebar_label: Installing a BYOL Conductor-managed Router in AWS
---

import InstanceSizing from './_byol_aws_instance_types.md'

This guide describes the process for deploying a BYOL Session Smart Conductor and a BYOL Session Smart Router (SSR) in AWS.

The installation and deployment process consists of the following steps:
Expand All @@ -18,24 +21,13 @@ BYOL instances only support image-based installations, and require the conductor

### Selecting the AMI

The **Bring Your Own License (BYOL)** AMI allows you to install your own licensed copy of the SSR software on an AWS VM. Artifactory credentials are required to authenticate access to the installation repositories. Refer to the [Session Smart Networking Platform (BYOL)](https://aws.amazon.com/marketplace/pp/prodview-lz6cjd43qgw3c?sr=0-2&ref_=beagle&applicationId=AWSMPContessa) offering.
The **Bring Your Own License (BYOL)** AMI allows you to install your own licensed copy of the SSR software on an AWS VM. SSR software access credentials are required to authenticate access to the installation repositories. Refer to the [Session Smart Networking Platform (BYOL)](https://aws.amazon.com/marketplace/pp/prodview-lz6cjd43qgw3c?sr=0-2&ref_=beagle&applicationId=AWSMPContessa) offering.

Once you have selected the AMI for your deployment, proceed to the section [Session Smart Conductor Deployment](#session-smart-conductor-deployment) to deploy a Session Smart Conductor, or proceed to the section [Session Smart Conductor Managed Router Deployment](#session-smart-conductor-managed-router-deployment) to deploy a Session Smart Conductor Managed Router.

## Selecting the Instance Size
The following instance sizes are supported for virtual SSR in AWS. Choose the size that best meets your requirements. More information can be found in the [AWS Documentation](https://docs.aws.amazon.com/ec2/latest/instancetypes/instance-types.html)

| Recommended AWS VM Size | Max vNICs Supported | vCPU Cores | Memory |
| ----------------------- | ------------------- | ---------- | ------ |
| c5.xlarge | 4 | 4 | 8 |
| c5.2xlarge | 4 | 8 | 16 |
| c5.4xlarge | 8 | 16 | 32 |
| c5.9xlarge | 8 | 36 | 72 |
| c5n.xlarge | 4 | 4 | 10.5 |
| c5n.2xlarge | 4 | 8 | 21 |
| c5n.4xlarge | 8 | 16 | 42 |
| c5n.9xlarge | 8 | 36 | 96 |

<InstanceSizing/>

## Session Smart Conductor Deployment

Expand Down Expand Up @@ -81,7 +73,7 @@ To deploy the Session Smart Networking software via the AWS Console:
- What name do you want to give the instance?
- Provide it in the **Conductor Name** field (for example: conductor).
- What version of SSR software do you want to install?
- What are the artifactory credentials used to install the software?
- What are the SSR software access credentials used to install the software?
- Where do you want to deploy it?
- Select the VPC in the region.
- Select the subnet within the VPC.
Expand Down Expand Up @@ -123,8 +115,8 @@ write_files:
"name": "<conductor-name>",
"ssr-version": "<version>",
"mode": "conductor",
"artifactory-user": "<username>",
"artifactory-password": "<password>",
"software-access-username": "<username>",
"software-access-token": "<token>",
"node-name": "node0",
"cloud-provider": "aws"
}
Expand All @@ -134,8 +126,8 @@ write_files:
| ------ | ------- |
| name | The name of the router. By default, the instance name is used. |
| ssr-version | The SSR software version to be installed on the instance. (BYOL only) |
| artifactory-user | User portion of the artifactory credentials. |
| artifactory-password | Password portion of the artifactory credentials. |
| software-access-username | User portion of the SSR software access credentials. |
| software-access-token | Password portion of the SSR software access credentials. |
| node-name | The name of the node being provisioned. For a standalone conductor, this is `node0`. |
| download-timeout | The timeout duration for installing BYOL (default: 6h) |
| download-retries | The number of times to retry SSR installation (default: unlimited) |
Expand Down Expand Up @@ -164,8 +156,8 @@ A description of the parameters of the template are listed in the following tabl
| Name | The Instance Name field provides a name to the VM for the device.|
| Instance Type | Size of the EC2 instance.|
| SSR Version | SSR software version installed on the instance. |
| Artifactory Username | User portion of the artifactory credentials used to install the SSR software. |
| Artifactory Token | Token for the artifactory credentials used to install the SSR software. |
| SSR Software Access Username | User portion of the SSR software access credentials used to install the SSR software. |
| SSR Software Access Username | Token for the SSR software access credentials used to install the SSR software. |
| VPC ID | ID of the existing VPC where the device is going to be deployed. |
| Control Subnet ID | ID of the control subnet within the VPC. |
| Control Subnet Allowed CIDR | The IP CIDR range of the endpoints allowed to originate traffic to the Conductor's management interface in the management subnet. |
Expand Down Expand Up @@ -210,8 +202,8 @@ Paste the following JSON content. Please adjust the values to your specific envi
"Name": "<instance name>",
"Version": "<ssr-version>",
"InstanceType": "c5n.xlarge",
"ArtifactoryUsername": "<username>",
"ArtifactoryUsername": "<password>",
"SSRSoftwareAccessUsername": "<username>",
"SSRSoftwareAccessToken": "<token>",
"VpcId": "<ID of the VPC>",
"ControlSubnet": "<ID of the management subnet within the VPC>",
"ControlAllowedCidr": "0.0.0.0/0",
Expand Down Expand Up @@ -333,7 +325,7 @@ To deploy the Session Smart Networking software via the AWS Console:
- Where do you want to deploy it?
- Select the VPC in the region.
- Select the public, private, and optional management subnets within the VPC.
- What are the artifactory credentials used to install the software?
- What are the SSR software access credentials used to install the software?
- What is the control IP address of the Conductor used to manage it?
- **Optional** What is the secondary control IP address of the Conductor used to manage it?
- Who is going to be the administrator?
Expand Down Expand Up @@ -382,8 +374,8 @@ write_files:
| ------ | ------- |
| name | The name of the Router. |
| ssr-version | The SSR software version to be installed on the instance. |
| artifactory-user | User portion of the artifactory credentials. |
| artifactory-password | Password portion of the artifactory credentials. |
| software-access-username | Username portion of the SSR software access credentials. |
| software-access-token | Token portion of the SSR software access credentials. |
| conductor-hosts | The list of Conductor control IPs used to manage the router. |
| download-timeout | The timeout duration for installing BYOL (default: 6h) |
| download-retries | The number of times to retry SSR installation (default: unlimited) |
Expand Down Expand Up @@ -428,8 +420,8 @@ A description of the parameters of the template are listed in the following tabl
| -------------------- | ----------- |
| Name | Fill out the Instance Name field to provide a name to the VM for the conductor-managed router.|
| Version | SSR software version installed on the instance. |
| Artifactory Username | User portion of the artifactory credentials used to install the SSR software. |
| Artifactory Token | Token for the artifactory credentials used to install the SSR software. |
| SSR Software Access Username | Username portion of the SSR software access credentials used to install the SSR software. |
| SSR Software Access Token | Token for the SSR software access credentials used to install the SSR software. |
| Primary Control IP | The primary IP address of the Conductor |
| Secondary Control IP | The secondary IP address of the Conductor |
| Key Name | IAM user key (SSH public key) to login to the EC2 instance (Linux) via SSH.|
Expand Down Expand Up @@ -479,8 +471,8 @@ Paste the following JSON content. Please adjust the values to your specific envi
{
"Name": "<instance name>",
"Version": "<ssr-version>",
"ArtifactoryUsername": "<username>",
"ArtifactoryToken": "<password>",
"SSRSoftwareAccessUsername": "<username>",
"SSRSoftwareAccessToken": "<token>",
"conductorPrimaryControlIP": "<control-ip>",
"conductorSecondaryControlIP": "<control-ip>",
"InstanceType": "c5n.xlarge",
Expand Down Expand Up @@ -573,8 +565,8 @@ A description of the parameters of the template are listed in the following tabl
| -------------------- | ----------- |
| Name | Fill out the Instance Name field to provide a name to the VM for the conductor-managed router.|
| Version | SSR software version installed on the instance. |
| Artifactory Username | User portion of the artifactory credentials used to install the SSR software. |
| Artifactory Token | Token for the artifactory credentials used to install the SSR software. |
| SSR Software Access Username | Username portion of the SSR software access credentials used to install the SSR software. |
| SSR Software Access Token | Token for the SSR software access credentials used to install the SSR software. |
| Primary Control IP | The primary IP address of the Conductor |
| Secondary Control IP | The secondary IP address of the Conductor |
| Key Name | IAM user key (SSH public key) to login to the EC2 instance (Linux) via SSH.|
Expand Down
17 changes: 5 additions & 12 deletions docs/intro_installation_byol_aws_mist.md → docs/intro_installation_byol_aws_mist.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
title: Installing a BYOL Mist-managed Router in AWS
sidebar_label: Installing a BYOL Mist-managed Router in AWS
---

import InstanceSizing from './_byol_aws_instance_types.md'


This guide describes the process for deploying a Mist-managed instance through AWS. When installed as an AWS image, SSR Version 6.x supports Mist-managed routers. The installation and deployment process consists of the following steps:

* [Selecting the AMI](#selecting-the-ami).
Expand All @@ -18,19 +22,8 @@ For the latest information about SSR BYOL offerings, please refer to the [Cloud
Once you have selected the AMI that suits the needs of your deployment, proceed to the [Session Smart Router Deployment](#session-smart-router-deployment) to deploy a Session Smart Router.

## Selecting the Instance Size
The following instance sizes are supported for virtual SSR in AWS. Choose the size that best meets your requirements. More information can be found in the [AWS Documentation](https://docs.aws.amazon.com/ec2/latest/instancetypes/instance-types.html)

| Recommended AWS VM Size | Max vNICs Supported | vCPU Cores | Memory |
| ----------------------- | ------------------- | ---------- | ------ |
| c5.xlarge | 4 | 4 | 8 |
| c5.2xlarge | 4 | 8 | 16 |
| c5.4xlarge | 8 | 16 | 32 |
| c5.9xlarge | 8 | 36 | 72 |
| c5n.xlarge | 4 | 4 | 10.5 |
| c5n.2xlarge | 4 | 8 | 21 |
| c5n.4xlarge | 8 | 16 | 42 |
| c5n.9xlarge | 8 | 36 | 96 |

<InstanceSizing/>

## Session Smart Router Deployment

Expand Down
Loading
Loading