Merge pull request #17 from ansible-lockdown/mrsteve_readme_update

Updated to changelog,readme, and default main

ChangeLog.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## Release .090
+- STIG Benchmark Release: Version 1 Release 8
+- Added ChangeLog

README.md

@@ -1,29 +1,93 @@
 # Kubernetes DISA STIG
 
-Configure a Kubernetes install to be DISA STIG compliant. All findings will be audited by default. Non-disruptive CAT I, CAT II, and CAT III findings will be corrected by default. Disruptive finding remediation can be enabled by setting `cntrk8stig_disruption_high` to `yes`.
+## Configure a Kubernetes system to be [DISA STIG](https://public.cyber.mil/stigs/downloads/) compliant.
 
-This role is based on Kubernetes DISA STIG: [Version 1, Rel 8 released on  Jan 26, 2023](https://dl.dod.cyber.mil/wp-content/uploads/stigs/zip/U_Kubernetes_V1R8_STIG.zip).
+### Based on [ Kubernetes DISA STIG Version 1, Rel 8 released on Jan 26, 2023 ](https://dl.dod.cyber.mil/wp-content/uploads/stigs/zip/U_Kubernetes_V1R8_STIG.zip)
 
-## Join us
+---
 
-On our [Discord Server](https://discord.io/ansible-lockdown) to ask questions, discuss features, or just chat with other Ansible-Lockdown users
+![Org Stars](https://img.shields.io/github/stars/ansible-lockdown?label=Org%20Stars&style=social)
+![Stars](https://img.shields.io/github/stars/ansible-lockdown/KUBERNETES-STIG?label=Repo%20Stars&style=social)
+![Forks](https://img.shields.io/github/forks/ansible-lockdown/KUBERNETES-STIG?style=social)
+![followers](https://img.shields.io/github/followers/ansible-lockdown?style=social)
+[![Twitter URL](https://img.shields.io/twitter/url/https/twitter.com/AnsibleLockdown.svg?style=social&label=Follow%20%40AnsibleLockdown)](https://twitter.com/AnsibleLockdown)
 
-## Updating
+![Ansible Galaxy Quality](https://img.shields.io/ansible/quality/61461?label=Quality&&logo=ansible)
+![Discord Badge](https://img.shields.io/discord/925818806838919229?logo=discord)
 
-Coming from a previous release.
+![Devel Build Status](https://img.shields.io/github/actions/workflow/status/ansible-lockdown/KUBERNETES-STIG/linux_benchmark_testing.yml?label=Devel%20Build%20Status)
+![Devel Commits](https://img.shields.io/github/commit-activity/m/ansible-lockdown/KUBERNETES-STIG/devel?color=dark%20green&label=Devel%20Branch%20commits)
 
-As with all releases and updates, It is suggested to test and align controls.
-This contains rewrites and ID reference changes as per STIG documentation.
+![Release Branch](https://img.shields.io/badge/Release%20Branch-Main-brightgreen) 
+![Main Build Status](https://img.shields.io/github/actions/workflow/status/ansible-lockdown/KUBERNETES-STIG/linux_benchmark_testing.yml?label=Build%20Status)
+![Main Release Date](https://img.shields.io/github/release-date/ansible-lockdown/KUBERNETES-STIG?label=Release%20Date)
+![Release Tag](https://img.shields.io/github/v/tag/ansible-lockdown/KUBERNETES-STIG?label=Release%20Tag&&color=success)
 
-## Auditing
+![Issues Open](https://img.shields.io/github/issues-raw/ansible-lockdown/KUBERNETES-STIG?label=Open%20Issues)
+![Issues Closed](https://img.shields.io/github/issues-closed-raw/ansible-lockdown/KUBERNETES-STIG?label=Closed%20Issues&&color=success)
+![Pull Requests](https://img.shields.io/github/issues-pr/ansible-lockdown/KUBERNETES-STIG?label=Pull%20Requests)
 
-There is no audit role for this benchmark at this time. Please keep checking back for the KUBERNETES-STIG-Audit repo. 
+![License](https://img.shields.io/github/license/ansible-lockdown/KUBERNETES-STIG?label=License)
 
-## Requirements
+---
 
-- Kubernetes 1.16.7 or higher - Other versions are not supported.
+## Looking for support?
+
+[Lockdown Enterprise](https://www.lockdownenterprise.com#GH_AL_KUBERNETES_stig)
+
+[Ansible support](https://www.mindpointgroup.com/cybersecurity-products/ansible-counselor#GH_AL_KUBERNETES_stig)
+
+### Community
+
+Join us on our [Discord Server](https://discord.io/ansible-lockdown) to ask questions, discuss features, or just chat with other Ansible-Lockdown users.
+
+---
+
+## Caution(s)
+
+This role **will make changes to the system** which may have unintended consequences. This is not an auditing tool but rather a remediation tool to be used after an audit has been conducted.
+
+Check Mode is not supported! The role will complete in check mode without errors, but it is not supported and should be used with caution.
+
+This role was developed against a clean install of the Kubernetes. If you are implementing to an existing system please review this role for any site specific changes that are needed.
+
+To use release version please point to main branch and relevant release for the stig benchmark you wish to work with.
+
+---
+
+## Matching a security Level for STIG
+
+It is possible to to only run controls that are based on a particular for security level for STIG.
+This is managed using tags:
+
+- CAT1
+- CAT2
+- CAT3
+
+The control found in defaults main also need to reflect true so as this will allow the controls to run when the playbook is launched. 
+
+## Coming from a previous release
+
+STIG releases always contain changes, it is highly recommended to review the new references and available variables. This has changed significantly since the initial release of ansible-lockdown.
+This is now compatible with python3 if it is found to be the default interpreter. This does come with pre-requisites which it configures the system accordingly.
 
-### General
+Further details can be seen in the [Changelog](./ChangeLog.md)
+
+## Auditing (new)
+
+Currently this release does not have a auditing tool. 
+
+## Documentation
+
+- [Read The Docs](https://ansible-lockdown.readthedocs.io/en/latest/)
+- [Getting Started](https://www.lockdownenterprise.com/docs/getting-started-with-lockdown#GH_AL_KUBERNETES_stig)
+- [Customizing Roles](https://www.lockdownenterprise.com/docs/customizing-lockdown-enterprise#GH_AL_KUBERNETES_stig)
+- [Per-Host Configuration](https://www.lockdownenterprise.com/docs/per-host-lockdown-enterprise-configuration#GH_AL_KUBERNETES_stig)
+- [Getting the Most Out of the Role](https://www.lockdownenterprise.com/docs/get-the-most-out-of-lockdown-enterprise#GH_AL_KUBERNETES_stig)
+
+## Requirements
+
+**General:**
 
 - Basic knowledge of Ansible, below are some links to the Ansible documentation to help get started if you are unfamiliar with Ansible
 
@@ -32,61 +96,46 @@ There is no audit role for this benchmark at this time. Please keep checking bac
   - [Tower User Guide](https://docs.ansible.com/ansible-tower/latest/html/userguide/index.html)
   - [Ansible Community Info](https://docs.ansible.com/ansible/latest/community/index.html)
 - Functioning Ansible and/or Tower Installed, configured, and running. This includes all of the base Ansible/Tower configurations, needed packages installed, and infrastructure setup.
-- Please read through the tasks in this role to gain an understanding of what each control is doing. Some of the tasks are disruptive and can have unintended consequences in a live production system. Also familiarize yourself with the variables in the defaults/main.yml file.
-- There are currently no CAT3 STIG controls, that is not a missing section in this role.
-
-## Documentation
+- Please read through the tasks in this role to gain an understanding of what each control is doing. Some of the tasks are disruptive and can have unintended consiquences in a live production system. Also familiarize yourself with the variables in the defaults/main.yml file.
 
-- [Repo GitHub Page](https://ansible-lockdown.github.io/KUBERNETES-STIG/)
-- [Getting Started](https://www.lockdownenterprise.com/docs/getting-started-with-lockdown)
-- [Customizing Roles](https://www.lockdownenterprise.com/docs/customizing-lockdown-enterprise)
-- [Per-Host Configuration](https://www.lockdownenterprise.com/docs/per-host-lockdown-enterprise-configuration)
-- [Getting the Most Out of the Role](https://www.lockdownenterprise.com/docs/get-the-most-out-of-lockdown-enterprise)
+**Technical Dependencies:**
 
-## Dependencies
-
-The following packages must be installed on the controlling host/host where ansible is executed:
-
-- python2-passlib (or just passlib, if using python3)
-- python-lxml
-- python-xmltodict
-- python-jmespath
-
-Package 'python-xmltodict' is required if you enable the OpenSCAP tool installation and run a report. Packages python(2)-passlib and python-jmespath are required for tasks with custom filters or modules. These are all required on the controller host that executes Ansible.
+- Kubernetes 1.16.7 or higher - Other versions are not supported.
+- Running Ansible/Tower setup (this role is tested against Ansible version 2.9.1 and newer)
+- Python3 Ansible run environment
+- python-def (should be included in RHEL/CentOS 7) - First task sets up the prerequisites (Tag pre-reqs)for python3 and python2 (where required)
+  - libselinux-python
+  - python3-rpm (package used by py3 to use the rpm pkg)
 
 ## Role Variables
 
 This role is designed that the end user should not have to edit the tasks themselves. All customizing should be done via the defaults/main.yml file or with extra vars within the project, job, workflow, etc.
 
-### Tags
+## Tags
 
-There are many tags available for added control precision. Each control has it's own set of tags noting the control number as well as what parts of the system that control addresses.
+There are many tags available for added control precision. Each control has it's own set of tags noting what level, if it's scored/notscored, what OS element it relates to, if it's a patch or audit, and the rule number.
 
-Below is an example of the tag section from a control within this role. Using this example if you set your run to skip all controls with the tag ssh, this task will be skipped. The
-opposite can also happen where you run only controls tagged with ssh.
+Below is an example of the tag section from a control within this role. Using this example if you set your run to skip all controls with the tag kernel, this task will be skipped. The opposite can also happen where you run only controls tagged with kernel.
 
 ```sh
 tags:
-    - CNTR-K8-010050
-    - ssh
-    - dod_logon_banner
+      - CNTR-K8-001620
+      - CAT1
+      - CCI-001084
+      - SRG-APP-000233-CTR-000585
+      - SV-242434r864009_rule
+      - V-242434
+      - kubelet
+      - kernel
 ```
 
-## Branches
-
-- **devel** - This is the default branch and the working development branch. Community pull requests will pull into this branch
-- **main** - This is the release branch
-- **reports** - This is a protected branch for our scoring reports, no code should ever go here
-- **gh_pages** - github pages
-- **all other branches** - Individual community member branches
-
 ## Community Contribution
 
 We encourage you (the community) to contribute to this role. Please read the rules below.
 
 - Your work is done in your own individual branch. Make sure to Signed-off and GPG sign all commits you intend to merge.
-- All community Pull Requests are pulled into the devel branch
-- Pull Requests into devel will confirm your commits have a GPG signature, Signed-off, and a functional test before being approved
+- All community Pull Requests are pulled into the devel branch.
+- Pull Requests into devel will confirm your commits have a GPG signature, Signed-off, and a functional test before being approved.
 - Once your changes are merged and a more detailed review is complete, an authorized member will merge your changes into the main branch for a new release.
 
 ## Pipeline Testing
@@ -98,11 +147,3 @@ uses:
 - runs the audit using the devel branch
 - This is an automated test that occurs on pull requests into devel
 
-## Support
-
-This is a community project at its core and will be managed as such.
-
-If you would are interested in dedicated support to assist or provide bespoke setups
-
-- [Ansible Counselor](https://www.mindpointgroup.com/products/ansible-counselor-on-demand-ansible-services-and-consulting/)
-- [Try us out](https://engage.mindpointgroup.com/try-ansible-counselor)