Skip to content

byol 3.0 - AWS #864

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

Merged
merged 4 commits into from
Jul 11, 2025
Merged

byol 3.0 - AWS #864

merged 4 commits into from
Jul 11, 2025

Conversation

haberkornsam
Copy link
Contributor

AWS is live before Azure so we should separate the docs

BenMatase
BenMatase previously approved these changes Jul 10, 2025
agrawalkaushik
agrawalkaushik previously approved these changes Jul 10, 2025
Copy link
Contributor

@agrawalkaushik agrawalkaushik left a comment

Choose a reason for hiding this comment

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

overall lgtm - nice work @haberkornsam

@@ -136,24 +136,26 @@ If the device does not show up in the Mist organization or the desired SSR versi

### Network Interfaces Layout

The _Session Smart Router Template_ deploys an EC2 instance for the SSR with two network interfaces. The template attaches the network interfaces to the EC2 instance in the following order: Public, and Private. The network interfaces to be used in Mist configuration are as follows:
The _Session Smart Router Template_ deploys an EC2 instance for the SSR with two network interfaces. The template attaches the network interfaces to the EC2 instance in the following order: Public, private, and Management. The network interfaces to be used in Mist configuration are as follows:
Copy link
Contributor

Choose a reason for hiding this comment

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

I have a question about this, purely from a writers point of view. Both the old and the new text state that the EC2 instance is deployed with two network interfaces, but the new text indicates three interfaces; public, private, and management and the example below shows three interfaces. Is this correct? I mean programmatically there may be something that I don't understand, like it only generates two of the three, depending on what you tell it? Dunno, just want to point it out.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes exactly. It requires a public and private interface. The 3rd management interface is optional. I'll update this text to be more consistent.

@@ -171,7 +173,7 @@ Once the deployment of the template is complete, information about the new route

The information listed in the Outputs tab is the following:
* Instance ID of the Router EC2 instance.
* Public IP address of the public interface for administration purposes.
* Public IP address of the Control interface for administration purposes.
Copy link
Contributor

Choose a reason for hiding this comment

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

Is a "Control" interface the same as a management interface? Is this a common term within AWS? Elsewhere within the document, it refers to the addition of a management interface.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is referencing the output section when deploying a template. Specifically the IP address you can use to SSH in. If a management interface is configured, the output will be the public IP of the the management interface. If not it will be the public interface's public IP

The chosen IP here should be transparent to the user. And the sections above explain when the public vs mgmt interface is used for SSH

Copy link
Contributor

Choose a reason for hiding this comment

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

Is the definition of the "Control" interface clear to the reader of this document?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yes it would be

Copy link
Contributor

Choose a reason for hiding this comment

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

I just searched "control" in the doc and agree that it is explained/identified in the docs so that the user understands what it is.

@MichaelBaj MichaelBaj self-requested a review July 11, 2025 20:12
@Chr1st0ph3rTurn3r Chr1st0ph3rTurn3r merged commit 1ef2ce7 into master Jul 11, 2025
1 check passed
@Chr1st0ph3rTurn3r Chr1st0ph3rTurn3r deleted the byol-3.0-aws branch July 11, 2025 20:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants