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.

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

Jump to bottom

Extending content for users reading 'defaults/main.yml' file #157

Closed
wants to merge 158 commits into from
Closed

Extending content for users reading 'defaults/main.yml' file #157

wants to merge 158 commits into from

Conversation

ipruteanu-sie
Copy link
Contributor

Overall Review of Changes:
Extended the documentation @ defaults/main.yml file, with help of @brisky, as one can notice below.
@uk-bolly: If you notice anything strange/unclear in this PR, please let me know.

Issue Fixes:
N/A

Enhancements:
Enhanced docs.

How has this been tested?:
N/A, just docs.

brisky and others added 17 commits November 24, 2023 15:38
@brisky
Document variables in defaults/main.yml, Fix 2.
a2162db 
Signed-off-by: root@DERVISHx <[email protected]>
@brisky
Document variables in defaults/main.yml, Fix 5 from devel
34b0521 
Signed-off-by: root@DERVISHx <[email protected]>
@ipruteanu-sie
Small additions to first part of documentation.
dc59c32 
Signed-off-by: Ionut Pruteanu <[email protected]>
@ipruteanu-sie
Doc additions for:
06489db 
- Yum repos,
- bootloader,
- crypto policies,
- SELinux
- NTP

Signed-off-by: Ionut Pruteanu <[email protected]>
@ipruteanu-sie
Doc additions for:
6dfbe18 
- Sections 2.2 && 2.3
- Section 3
- Section 4.1

Signed-off-by: Ionut Pruteanu <[email protected]>
@ipruteanu-sie
Last docs part - additions
28a61fa 
Signed-off-by: Ionut Pruteanu <[email protected]>
@brisky
Added vars for streams.
a57333d 
Signed-off-by: root@DERVISHx <[email protected]>
@ipruteanu-sie
Finalising the docs content & syntax
560475e 
Signed-off-by: Ionut Pruteanu <[email protected]>
@ipruteanu-sie
Merge branch 'siemens/feat/document_main_variables' of code.siemens.c…
14cd1e0 
…om:infosec-pss-gov/security-crafter-baseline-automations/ansible-lockdown/rhel9-cis into siemens/feat/document_main_variables
@ipruteanu-sie
Merge branch 'devel' of github.com:siemens/RHEL9-CIS into siemens/fea…
677424d 
…t/document_main_variables
@ipruteanu-sie
Documenting usage of chrony variables.
8fc85fc 
Signed-off-by: Ionut Pruteanu <[email protected]>
@ipruteanu-sie
Improving doc for journald log parameters.
b4bef29 
Signed-off-by: Ionut Pruteanu <[email protected]>
@ipruteanu-sie
Revert "Added vars for streams."
073f6b7 
[IP] I see no benefit to duplicate vars in defaults/main.yml in other files like specific vars for Alma/Rocky, especially since
we're using the same values for those vars. Also, replacing rsyslog with journald is not fine for this current doc-extension proposal.

This reverts commit a57333d.
@ipruteanu-sie
Using again the default values used by Lockdown for sshd vars, as the…
48f0c7d 
…y shouldn't be altered

Signed-off-by: Ionut Pruteanu <[email protected]>
@ipruteanu-sie
Removing not useful line from docs
36ab51d 
Signed-off-by: Ionut Pruteanu <[email protected]>
@dulin @ipruteanu-sie
Solved minor conflicts in defaults/main.yml file, when re-basing
9ce1fb6 
Signed-off-by: Marcin Dulinski <[email protected]>
@brisky @ipruteanu-sie
Fixing conflicts after rebasing current feature branch onto 'devel'
da62626
@uk-bolly
Copy link
Member

hi @ipruteanu-sie

Thank you and @brisky so much for the PR, Happy to take it as it stands and it is lovely to have and see how we get on with the next CIS baseline release. If you can resolve the issues with the pipeline and DCO failures.
For a note:
While we do like the changes and documentation, we are seeing more and more complete movements of controls to different numbering and sections e.g. RHEL8-CIS v3 is nearly a complete rewrite due to changes. This has the potential to add to the overhead to document for each release.

Many thanks as always for your help

uk-bolly

brisky and others added 12 commits January 30, 2024 23:41
@brisky @ipruteanu-sie
Document variables in defaults/main.yml, Fix 5 from devel
778110e 
Signed-off-by: root@DERVISHx <[email protected]>
@ipruteanu-sie
Rebasing after:
1682ff1 
~~~
Small additions to first part of documentation.

Signed-off-by: Ionut Pruteanu <[email protected]>
@ipruteanu-sie
Doc additions for:
f7f494f 
- Yum repos,
- bootloader,
- crypto policies,
- SELinux
- NTP

Signed-off-by: Ionut Pruteanu <[email protected]>
@ipruteanu-sie
Doc additions for:
80d622e 
- Sections 2.2 && 2.3
- Section 3
- Section 4.1

Signed-off-by: Ionut Pruteanu <[email protected]>
@ipruteanu-sie
Changes after rebasing.
15ef967
@brisky @ipruteanu-sie
Added vars for streams.
c2c581e 
Signed-off-by: root@DERVISHx <[email protected]>
@ipruteanu-sie
Changes after rebasing, 2
d97e42e
@ipruteanu-sie
Finalising the docs content & syntax
7b379fd 
Signed-off-by: Ionut Pruteanu <[email protected]>
@ipruteanu-sie
Merge branch 'siemens/feat/document_main_variables' of code.siemens.c…
c4fe6df 
…om:infosec-pss-gov/security-crafter-baseline-automations/ansible-lockdown/rhel9-cis into siemens/feat/document_main_variables
@ipruteanu-sie
Rebasing.
21594f7 
Documenting usage of chrony variables.

Signed-off-by: Ionut Pruteanu <[email protected]>
@ipruteanu-sie
Changes after rebasing, 2
ddb5289
@ipruteanu-sie
Improving doc for journald log parameters.
f1dde22 
Signed-off-by: Ionut Pruteanu <[email protected]>
ipruteanu-sie and others added 27 commits January 31, 2024 08:30
@ipruteanu-sie
Storing max_log_file under rhel9cis_auditd dict variable.
9e7cf73 
Signed-off-by: Ionut Pruteanu <[email protected]>
@ipruteanu-sie
Defining some threshold for (audit_)space_left vars, as well as a boo…
70a18cd 
…l which governs if extra params will be configured

Signed-off-by: Ionut Pruteanu <[email protected]>
@sickbock @ipruteanu-sie
Update cis_1.3.x.yml
e5f8044 
Correction to "when":  1_3_3

Signed-off-by: Joachim la Poutré <[email protected]>
Signed-off-by: Ionut Pruteanu <[email protected]>
@sickbock @ipruteanu-sie
Update cis_1.8.x.yml
b80031b 
Corrected tag rule_1.8.10

Signed-off-by: Joachim la Poutré <[email protected]>
Signed-off-by: Ionut Pruteanu <[email protected]>
@sickbock @ipruteanu-sie
Update cis_5.6.1.x.yml
fa8c680 
Corrected tag: rule_5.6.1.1

Signed-off-by: Joachim la Poutré <[email protected]>
Signed-off-by: Ionut Pruteanu <[email protected]>
@sickbock @ipruteanu-sie
Update cis_5.6.1.x.yml
6c23580 
Corrected tag: rule_5.6.1.5

Signed-off-by: Joachim la Poutré <[email protected]>
Signed-off-by: Ionut Pruteanu <[email protected]>
@sickbock @ipruteanu-sie
Update cis_6.1.x.yml
8f39b97 
Corrected tags: rule_6.1.8 & rule_6.1.12

Signed-off-by: Joachim la Poutré <[email protected]>
Signed-off-by: Ionut Pruteanu <[email protected]>
@sickbock @ipruteanu-sie
Update cis_6.2.x.yml
ed8039a 
Corrected tag: rule_6.2.3

Signed-off-by: Joachim la Poutré <[email protected]>
Signed-off-by: Ionut Pruteanu <[email protected]>
@jLemmings @ipruteanu-sie
Update cis_1.1.7.x.yml
2f820a8 
Signed-off-by: Joshua Hemmings <[email protected]>
Signed-off-by: Ionut Pruteanu <[email protected]>
@pre-commit-ci @ipruteanu-sie
[pre-commit.ci] pre-commit autoupdate
898659e 
updates:
- [github.com/ansible-community/ansible-lint: v6.22.1 → v6.22.2](ansible/ansible-lint@v6.22.1...v6.22.2)

Signed-off-by: Ionut Pruteanu <[email protected]>
@brisky @ipruteanu-sie
Document variables in defaults/main.yml, Fix 5 from devel
71c2f80 
Signed-off-by: root@DERVISHx <[email protected]>
Signed-off-by: Ionut Pruteanu <[email protected]>
@ipruteanu-sie
Rebasing after:
39acb53 
~~~
Small additions to first part of documentation.

Signed-off-by: Ionut Pruteanu <[email protected]>
@ipruteanu-sie
Doc additions for:
13db3ab 
- Yum repos,
- bootloader,
- crypto policies,
- SELinux
- NTP

Signed-off-by: Ionut Pruteanu <[email protected]>
@ipruteanu-sie
Doc additions for:
0464c93 
- Sections 2.2 && 2.3
- Section 3
- Section 4.1

Signed-off-by: Ionut Pruteanu <[email protected]>
@ipruteanu-sie
Changes after rebasing.
e44c45d 
Signed-off-by: Ionut Pruteanu <[email protected]>
@ipruteanu-sie
Finalising the docs content & syntax
a9981ed 
Signed-off-by: Ionut Pruteanu <[email protected]>
@brisky @ipruteanu-sie
Added vars for streams.
6a07d25 
Signed-off-by: root@DERVISHx <[email protected]>
Signed-off-by: Ionut Pruteanu <[email protected]>
@ipruteanu-sie
Improving doc for journald log parameters.
4c11b4a 
Signed-off-by: Ionut Pruteanu <[email protected]>
@ipruteanu-sie
Revert "Added vars for streams."
e2cc850 
[IP] I see no benefit to duplicate vars in defaults/main.yml in other files like specific vars for Alma/Rocky, especially since
we're using the same values for those vars. Also, replacing rsyslog with journald is not fine for this current doc-extension proposal.

This reverts commit a57333d.

Signed-off-by: Ionut Pruteanu <[email protected]>
@ipruteanu-sie
Removing not useful line from docs
4a51545 
Signed-off-by: Ionut Pruteanu <[email protected]>
@dulin @ipruteanu-sie
Solved minor conflicts in defaults/main.yml file, when re-basing
3e18bf1 
Signed-off-by: Marcin Dulinski <[email protected]>
Signed-off-by: Ionut Pruteanu <[email protected]>
@brisky @ipruteanu-sie
Rebase
a63d154 
~~~

Fixing conflicts after rebasing current feature branch onto 'devel'

Signed-off-by: Ionut Pruteanu <[email protected]>
@brisky @ipruteanu-sie
Added vars for streams.
e7fc328 
Signed-off-by: root@DERVISHx <[email protected]>
Signed-off-by: Ionut Pruteanu <[email protected]>
@ipruteanu-sie
Revert "Added vars for streams."
be15cf7 
[IP] I see no benefit to duplicate vars in defaults/main.yml in other files like specific vars for Alma/Rocky, especially since
we're using the same values for those vars. Also, replacing rsyslog with journald is not fine for this current doc-extension proposal.

This reverts commit a57333d.

Signed-off-by: Ionut Pruteanu <[email protected]>
@ipruteanu-sie
Removing not useful line from docs
5fac29a 
Signed-off-by: Ionut Pruteanu <[email protected]>
@dulin @ipruteanu-sie
Solved minor conflicts in defaults/main.yml file, when re-basing
be5f7b3 
Signed-off-by: Marcin Dulinski <[email protected]>
Signed-off-by: Ionut Pruteanu <[email protected]>
@ipruteanu-sie
Merge branch 'siemens/feat/document_main_variables' of code.siemens.c…
3e8072f 
…om:infosec-pss-gov/security-crafter-baseline-automations/ansible-lockdown/rhel9-cis into siemens/feat/document_main_variables
@ipruteanu-sie ipruteanu-sie mentioned this pull request Jan 31, 2024
Merged
@ipruteanu-sie
Copy link
Contributor Author

Hi @uk-bolly ! Thanks for your suggestions!

  • Actually, I've been running around in circles trying to fix the DCO issue: I was performing the rebase with the "--signoff", but actually the DCO output was still suggesting(correctly) that the changes related to rebase were unsigned. I've ended up with creating a patch, apply it(with signoff, ofc) on a new branch and generate a new PR, therefore current PR can be closed, as it was replaced by the new one.
  • Also, we understand the overhead needed for maintaining docs from release to release, but we also believe that the role-usability is improved when users have the chance to read a complete explanation about the variables they're dealing with.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
10 participants
@ipruteanu-sie @uk-bolly @brisky @dulin @lucab85 @senihucar @Corey0219 @jLemmings @bgro @sickbock