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

Conductor deployment guide #591

Merged
merged 19 commits into from
Aug 18, 2023
Merged

Conversation

Chr1st0ph3rTurn3r
Copy link
Contributor

@Chr1st0ph3rTurn3r Chr1st0ph3rTurn3r commented Jul 28, 2023

I suggest that you build the docs to see the changes, additions, and removals.

- [Import Configurations to the Conductor](single_conductor_config.md)
- [Conductor Software Upgrades](conductor_upgrade.md)
- [Conversion of an SSR Router to a Conductor](conductor_conversion.md)
<!-- markdown-link-check-disable-next-line -->
- [Conversion of an SSR Router to a Conductor](single_conductor_install#conductor-conversion)
Copy link
Contributor

Choose a reason for hiding this comment

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

Why did you have to disable the link check for this hyperlink? it should be single_conductor_install.mdx#conductor-conversion

To install a router **after** installing and configuring the Conductor, use the [SSR Installation](intro_installation_bootable_media.mdx). The [Router Installation Using OTP](intro_otp_iso_install.mdx) procedure can be used to install more complex router configurations.
Copy link
Contributor

Choose a reason for hiding this comment

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

This snippet needs modification for use in the conductor guide as the sentence above reads:

"The steps in this section describe the interactive conductor installation from the packaged-based ISO. The section Initialize the SSR describes..."

"Initialize the SSR" should be initialize the conductor

To install a router **after** installing and configuring the Conductor, use the [SSR Installation](intro_installation_bootable_media.mdx). The [Router Installation Using OTP](intro_otp_iso_install.mdx) procedure can be used to install more complex router configurations.
Copy link
Contributor

Choose a reason for hiding this comment

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

To the last sentence "... can be used to install more complex router configurations."
While this is true, we should be more binary regarding the use of the OTP workflow. It is intended for whitebox and air-gapped, conductor-only networks.

@@ -0,0 +1,5 @@
<!---Conductor Conversion---->

An SSR device (SSR1xx or SSR1xxx) shipped with SSR 5.4.x Routing software may be reinitialized as a conductor for use in an existing network. **The conductor can be used with or without Cloud Telemetry for devices running pre 6.0.x SSR software.**
Copy link
Contributor

Choose a reason for hiding this comment

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

"The conductor can be used with Mist Cloud Telemetry for SSR routers running software version 5.5 or greater."

### Configure the Network Interface
<ConductorIP/>

### Initialize the SSR Node
Copy link
Contributor

Choose a reason for hiding this comment

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

This heading should be "Initialized the Conductor Node"


![Authority Settings](/img/conductor_authority_name.png)

3. Under Basic Information, enter the new Authority name.
Copy link
Contributor

Choose a reason for hiding this comment

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

Add the sentence:
A good name for the Authority would be the name of the business, e.g., Acme Corp.


### Set the Conductor IP Address

1. Under Conductor Addresses, select ADD.
Copy link
Contributor

Choose a reason for hiding this comment

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

This section is incomplete. The steps during initialization setup the management IP. This conductor IP address will be its public IP address for which the manage routers will connect. This needs to be associated with a network-interface. Those configuration steps are missing from this guide.

@@ -0,0 +1,200 @@
---
title: High Availability Conductor Installation
Copy link
Contributor

Choose a reason for hiding this comment

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

All of my comments on single_conductor_install.mdx are applicable to this file as well.

- Conductor High Availability
- [Conductor High Availability for Cloud Deployments](intro_initialize_HA_conductor.md)

## Install the First Conductor HA Node
Copy link
Contributor

Choose a reason for hiding this comment

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

It would be beneficial to have a digram of SSR 1300s (acting as conductors) indicating how physical ports should be configured. Since this section discusses management ports, and HA sync ports and reachability, it would be better to provide a blueprint for customers to follow.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Still working on this diagram. Will include in the next edits/push.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added. Am reaching out to Adam for review - sending him a pdf.


![2nd HA Peer IP](/img/initializer_Serial4dHANode.png)

3. Enter the **HA Peer Credentials**. This is a one time operation for the initialization of the second HA Node with the first HA Peer. The `t128` user can be used for this operation.
Copy link
Contributor

Choose a reason for hiding this comment

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

The t128 user can be used for this operation.
What other user can be used for this operation? We should be explicit in this step for which user account to use.
Additionally, it should be added as a note that this one time operation has no impact on future changes to users and their passwords. Once HA is established between conductor nodes, security keys are exchanged for secure communication and not passwords.

MichaelBaj
MichaelBaj previously approved these changes Aug 11, 2023

2. Execute the command:
1. Login using the Admin credentials.
Copy link
Contributor

Choose a reason for hiding this comment

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

recommend changing "Admin" to "admin" because that is how you would enter it on the command line.

sudo systemctl status 128T
```
```
CentOS Linux 7 (Core)
Copy link
Contributor

Choose a reason for hiding this comment

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

Not sure why these two lines with "CentOS and Kernel" are here

@MichaelBaj MichaelBaj self-requested a review August 18, 2023 19:03
@Chr1st0ph3rTurn3r Chr1st0ph3rTurn3r merged commit 310d2d7 into master Aug 18, 2023
1 check passed
@Chr1st0ph3rTurn3r Chr1st0ph3rTurn3r deleted the conductor-deployment-guide branch August 18, 2023 19:31
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.

2 participants