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

Docs update #266

Merged
merged 13 commits into from
Jan 9, 2025
Merged

Docs update #266

merged 13 commits into from
Jan 9, 2025

Conversation

Daemonslayer2048
Copy link
Contributor

What type of PR is this?

  • bug
  • cleanup
  • documentation
  • feature

What this PR does / why we need it:

  • This PR will update the docs for the v2.0.0 update

Which issue(s) this PR fixes:

Fixes #265

Special notes for your reviewer:

N/A

Testing

Examples are tested locally on Rocky 9 VMs, though no changes will be made to the underlying Ansible code.

Release Notes

Updated network attached documentation, and tarball install method.

@Daemonslayer2048 Daemonslayer2048 changed the base branch from main to rewrite January 3, 2025 18:00
@Daemonslayer2048 Daemonslayer2048 marked this pull request as ready for review January 6, 2025 14:40
@Daemonslayer2048 Daemonslayer2048 changed the title WiP: Docs update Docs update Jan 6, 2025
@Daemonslayer2048 Daemonslayer2048 added the documentation Improvements or additions to documentation label Jan 6, 2025
@Daemonslayer2048 Daemonslayer2048 marked this pull request as draft January 6, 2025 14:50
@Daemonslayer2048 Daemonslayer2048 marked this pull request as ready for review January 6, 2025 16:02
@Daemonslayer2048 Daemonslayer2048 added this to the v2.0.0 milestone Jan 6, 2025
Copy link

@homelabhero homelabhero left a comment

Choose a reason for hiding this comment

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

Cursory review primarily on the README- looks great. Thank you for this helpful project and detailed documentation.

docs/README.md Outdated Show resolved Hide resolved
docs/README.md Outdated


## Enabling SELinux
Enabling SELinux in the playbook requires `seliux: true` be set in either the cluster, group, or host level config profiles (Please see [Special Variables](#special-variables) for more info). Though generally this should be set at the cluster and can be done like so:

Choose a reason for hiding this comment

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

Should the sample inventory contain an "all" example? If I wanted to disable selinux on all hosts, what file can be used to disable it and where should it be (if I'm unfamiliar with cluster, group, or host level config profiles).

Copy link
Contributor Author

@Daemonslayer2048 Daemonslayer2048 Jan 8, 2025

Choose a reason for hiding this comment

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

Should the sample inventory contain an "all" example?

I am not sure what you mean by this, there is an "advanced_sample_inventory" folder which contains all the configuration values used in this README file.

If I wanted to disable selinux on all hosts, what file can be used to disable it and where should it be (if I'm unfamiliar with cluster, group, or host level config profiles).

If you don't want SELinux enabled on RKE2 simply do not include it as a variable it is off by default. If you are unfamiliar with cluster, group, or host level config profiles you should see the "Special Variables" section that is linked right after they are referenced.

docs/README.md Outdated Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
docs/advanced_sample_inventory/group_vars/all.yaml Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
@aleiner aleiner merged commit 50f9fc2 into rewrite Jan 9, 2025
3 of 5 checks passed
@aleiner aleiner deleted the docs-update branch January 9, 2025 19:52
Daemonslayer2048 added a commit that referenced this pull request Jan 15, 2025
* initial commit

* validating

* fixing linting

* initial pass at tarball

* cleanup

* adding logic to determine join token and which node is up

* fixing some linting

* fixing some linting

* allowing rpm downgrade and forcing handlers on failure

* rpm install logic change

* large number of changes 01

* large number of changes 02

* readding throttles

* Add first molecule scenario

* Move VPC subnet to env var

* Convert default scenario to a template and ubuntu-2404

* Remove unused scenario files

* updating full rpm logic

* fixed rpm logic

* linting round 1

* Add supported platforms

* fixing VIP join logic

* Easy win yamllints

* yes/no are not bools

* Create galaxy.yml

* Update variable in example hosts.yml

* Install_rke2_version was renamed to rke2_install_version

* set become: false on local file lookup

* Docs update (#266)

* Add network attached instructions

* Update tarball docs

* Github does not support titled admons

* Clear some lint issues

* Clear some galaxy errors

* Clear some new lint issues

* Fix ansible semver string

* Use a supported ansible version

* Update file and folder names

* Update README instruction for inventory use

* Add vale linting, normalized file extensions, and doc tweaks

* Revert become change, remove superfluous docs in main readme

* adjusting config verbiage

---------

Co-authored-by: Adam Leiner <[email protected]>

* Ci review (#269)

* Add network attached instructions

* Update tarball docs

* Github does not support titled admons

* Clear some lint issues

* Clear some galaxy errors

* Clear some new lint issues

* Fix ansible semver string

* Use a supported ansible version

* Update file and folder names

* Import linting, split linting tasks

* Update README instruction o inventory use

* Add vale linting, normalized file extensions, and doc tweaks

* Tweak workflow lints

* Merge workflows back into one file

* Test sudo access

* Rename Rocky tests, install Terraform

* Fix rocky task dep

* Install Terraform attempt #2

* Test reusable workflows

* Add OS option

* Add OS option 2

* Inherit secrets

* Install yq

* Install yq #2

* Install yq #3

* Install yq #4

* Use YQ for inventory generation

* Fix missing close bracket

* Print hosts file for debugging

* You should cat hosts file for debugging not exec it

* Runn test

* Fix inventory file location

* Fix inventory and add ssh_user

* Fix second inventory

* Add rocky 9

* Update CI to reference JOBID

* Attempt move to AWS commercial

* Attempt move to AWS commercial 2

* Attempt move to AWS commercial 3

* Fix destroy command and defaults

* Fix AWS Region

* Tweak TF and simplify for debuggin

* Fix new var

* Remove new var

* Remove new var 2

* Fix bad EOF

* Fix delete job

* Reduce EC2 counts

* Add Rocky 9 back

* Name sec groups

* Add Ubuntu

* Fix using wrong OS

* Add SLES

* Fix issue where too in SLES does not have .bashrc

* Fix bad permission

* Update README, Remove SLES, Test Lint requirements

* Remove broken lint check

* Updat edocs

* increase yaml lint line-length

* removing sles tests until they are reimplemented

---------

Co-authored-by: Adam Leiner <[email protected]>
Co-authored-by: Adam Leiner <[email protected]>

* Fix vars

* Fix CI reading .ansible directory

* #169 (#274)

Co-authored-by: Adam Leiner <[email protected]>

* Add a non-vague warning banner for v2 release

* Update RGS branding

---------

Co-authored-by: Adam Leiner <[email protected]>
Co-authored-by: Mike DAmato <[email protected]>
Co-authored-by: Daemonslayer2048 <[email protected]>
Co-authored-by: Jacob Hanafin <[email protected]>
Co-authored-by: Jacob Hanafin <[email protected]>
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.

Documentation for v2.0.0
3 participants