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

Update static config #101

Merged
merged 5 commits into from
Dec 21, 2024
Merged

Update static config #101

merged 5 commits into from
Dec 21, 2024

Conversation

DaintyJet
Copy link
Contributor

@DaintyJet DaintyJet commented Nov 7, 2024

Overview of Changes

Updated Linux Static Configuration Documents (standalone) and the Harvester Document to refer to routes and DNS configuration as creating internal networks often requires this.

Reason for Modification

This cleans up some of the old documentation (marginally) and it updates the new Harvester docs with additional information that may be helpful.

Verification

  • The documentation is completed, or does not contain work-in-progress/partially-completed sections.
  • The documentation is written in Markdown (Exception for Inject and Incident Reports).
  • Any Images are contained in a subdirectory Images.
  • Any scripts, Ansible Playbooks, Terraform scripts, etc. Have documentation explaining their purpose and use case.
  • Any scripts are tested.
  • I have assigned and notified a reviewer.

Updated the notes to fix spelling mistakes,
odd formatting choices and add additional
information.
…CCDC_Practice_Infrastructure into Update-Static-Config
Updated to add routing and DNS
configuration notes.

(Still need to fix spelling mistake. I will
make a separate PR after this for that)
@DaintyJet DaintyJet requested a review from a team as a code owner November 7, 2024 01:30
@DaintyJet
Copy link
Contributor Author

Please DO NOT merge till others I have requested reviewed this.

@DaintyJet DaintyJet added the documentation Improvements or additions to documentation label Nov 7, 2024
@DaintyJet DaintyJet requested a review from ryanwiddop November 7, 2024 02:44
Copy link

@ryanwiddop ryanwiddop left a comment

Choose a reason for hiding this comment

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

This looks good to me

@@ -13,6 +18,9 @@ Click Create and fill out the information in the *Basics* window. If you chose t

<img src="Images/VMC.png">

> [!IMPORTANT]
> Selecting the *Untagged* network is preferred to prevent any internal conflicts, and we have observed it is much more stable in our environment.

In the *Route* window configure it to use the **Manual** mode so we can make this network *internal* and not able to immediately access the internet. Fill in a `CIDR` range that does not conflict with the host's network (In our case do not use addresses that conflict with `192.168.0.0/21`). You should also set the `Gateway` to be some address in the `CIDR` range you selected.
Copy link
Contributor

Choose a reason for hiding this comment

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

I would add, how can someone determine and confirm the host's network CIDR range?
For the purpose of longevity of this document, in the event it ever changes.

> The use of the following options is **OPTIONAL** you can remove all of them, and the netplan can be applied to multiple VMs without issues.
> ```
> match:
> macaddress: MACADDR
Copy link
Contributor

Choose a reason for hiding this comment

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

Make a note that "MACADDR" is a placeholder for an actual mac address
"FF:FF:FF:FF:FF:FF"

Copy link
Contributor

@P-rple P-rple left a comment

Choose a reason for hiding this comment

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

I've added some simple suggestions.

Copy link
Contributor

@P-rple P-rple left a comment

Choose a reason for hiding this comment

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

Fix number bullet point


![Alt text](Images/NMTUI-4.png)

6. Click *add* and fill out the information (IP address *We are on a /21 network*)
1. Click *add* and fill out the information.
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this supposed to be 6. instead of 1.

@DaintyJet DaintyJet requested a review from P-rple November 11, 2024 22:55
@DaintyJet DaintyJet linked an issue Nov 12, 2024 that may be closed by this pull request
@DaintyJet DaintyJet merged commit f792b09 into main Dec 21, 2024
@DaintyJet DaintyJet deleted the Update-Static-Config branch December 21, 2024 22:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Expand the Harvester Network Docs
3 participants