Merge pull request #9 from ansible-lockdown/mrsteve_april_2023_updates

Readme, Ansible-lint, Yamllint, Module Full Names, Updated Workflow Testing
ansible-lockdown · Apr 27, 2023 · 0e94b5d · 0e94b5d
2 parents 6dbf29d + d890f2d
commit 0e94b5d
Show file tree

Hide file tree

Showing 15 changed files with 544 additions and 496 deletions.
diff --git a/.github/workflows/linux_benchmark_testing.yml b/.github/workflows/linux_benchmark_testing.yml
@@ -5,106 +5,104 @@ name: linux_benchmark_pipeline
 # Controls when the action will run.
 # Triggers the workflow on push or pull request
 # events but only for the devel branch
-on:  # yamllint disable-line rule:truthy
-    pull_request_target:
-        types: [opened, reopened, synchronize]
-        branches:
-            - devel
-            - main
-        paths:
-            - '**.yml'
-            - '**.sh'
-            - '**.j2'
-            - '**.ps1'
-            - '**.cfg'
+on:
+  pull_request_target:
+    types: [opened, reopened, synchronize]
+    branches:
+      - devel
+      - main
+    paths:
+      - '**.yml'
+      - '**.sh'
+      - '**.j2'
+      - '**.ps1'
+      - '**.cfg'
 
 # A workflow run is made up of one or more jobs
 # that can run sequentially or in parallel
 jobs:
   # This will create messages for first time contributers and direct them to the Discord server
-    welcome:
-        runs-on: ubuntu-latest
+  welcome:
+      runs-on: ubuntu-latest
 
-        steps:
-            - uses: actions/first-interaction@main
-              with:
-                  repo-token: ${{ secrets.GITHUB_TOKEN }}
-                  pr-message: |-
-                      Congrats on opening your first pull request and thank you for taking the time to help improve Ansible-Lockdown!
-                      Please join in the conversation happening on the [Discord Server](https://discord.io/ansible-lockdown) as well.
-      # This workflow contains a single job called "build"
-    build:
-      # The type of runner that the job will run on
-        runs-on: ubuntu-latest
+      steps:
+          - uses: actions/first-interaction@main
+            with:
+                repo-token: ${{ secrets.GITHUB_TOKEN }}
+                pr-message: |-
+                  Congrats on opening your first pull request and thank you for taking the time to help improve Ansible-Lockdown! 
+                  Please join in the conversation happening on the [Discord Server](https://discord.io/ansible-lockdown) as well.
+  # This workflow contains a single job called "build"
+  build:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
 
-        env:
-            ENABLE_DEBUG: false
+    env: 
+      ENABLE_DEBUG: false
 
-        # Steps represent a sequence of tasks that will be executed as part of the job
-        steps:
-          # Checks-out your repository under $GITHUB_WORKSPACE,
-          # so your job can access it
-            - uses: actions/checkout@v3
-              with:
-                  ref: ${{ github.event.pull_request.head.sha }}
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, 
+      # so your job can access it
+      - uses: actions/checkout@v3
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
 
-            - name: Add_ssh_key
-              working-directory: .github/workflows
-              env:
-                  SSH_AUTH_SOCK: /tmp/ssh_agent.sock
-                  PRIVATE_KEY: "${{ secrets.SSH_PRV_KEY }}"
-              run: |
-                mkdir .ssh
-                chmod 700 .ssh
-                echo $PRIVATE_KEY > .ssh/github_actions.pem
-                chmod 600 .ssh/github_actions.pem
+      - name: Add_ssh_key
+        working-directory: .github/workflows
+        env:
+          SSH_AUTH_SOCK: /tmp/ssh_agent.sock
+          PRIVATE_KEY: "${{ secrets.SSH_PRV_KEY }}"
+        run: |
+          mkdir .ssh
+          chmod 700 .ssh
+          echo $PRIVATE_KEY > .ssh/github_actions.pem
+          chmod 600 .ssh/github_actions.pem
 ### Build out the server
-            - name: Terraform_Init
-              working-directory: .github/workflows
-              run: terraform init
-
-            - name: Terraform_Validate
-              working-directory: .github/workflows
-              run: terraform validate
-
-            - name: Terraform_Apply
-              working-directory: .github/workflows
-              env:
-                  AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
-                  AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
-              run: terraform apply -var-file "github_vars.tfvars" -var-file "OS.tfvars" --auto-approve -input=false
+      - name: Terraform_Init
+        working-directory: .github/workflows
+        run: terraform init
 
-      ## Debug Section
-            - name: DEBUG - Show Ansible hostfile
-              if: env.ENABLE_DEBUG == 'true'
-              working-directory: .github/workflows
-              run: cat hosts.yml
+      - name: Terraform_Validate
+        working-directory: .github/workflows
+        run: terraform validate
 
-      # Aws deployments taking a while to come up insert sleep or playbook fails
-
-            - name: Sleep for 60 seconds
-              run: sleep 60s
-              shell: bash
+      - name: Terraform_Apply
+        working-directory: .github/workflows
+        env:
+          AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+        run: terraform apply -var-file "github_vars.tfvars" -var-file "OS.tfvars" --auto-approve -input=false
 
-      # Run the ansible playbook
-            - name: Run_Ansible_Playbook
-              uses: arillso/action.playbook@master
-              with:
-                  playbook: site.yml
-                  inventory: .github/workflows/hosts.yml
-                  galaxy_file: collections/requirements.yml
-                  private_key: ${{ secrets.SSH_PRV_KEY }}
-        #          verbose: 3
-              env:
-                  ANSIBLE_HOST_KEY_CHECKING: "false"
-                  ANSIBLE_DEPRECATION_WARNINGS: "false"
+## Debug Section
+      - name: DEBUG - Show Ansible hostfile
+        if: env.ENABLE_DEBUG == 'true'
+        working-directory: .github/workflows
+        run: cat hosts.yml
 
-      # Remove test system - User secrets to keep if necessary
+# Aws deployments taking a while to come up insert sleep or playbook fails
+      - name: Sleep for 60 seconds
+        run: sleep 60s
+        shell: bash
+
+# Run the ansible playbook
+      - name: Run_Ansible_Playbook
+        uses: arillso/action.playbook@master
+        with:
+          playbook: site.yml
+          inventory: .github/workflows/hosts.yml
+          galaxy_file: collections/requirements.yml
+          private_key: ${{ secrets.SSH_PRV_KEY }}
+#          verbose: 3
+        env:
+          ANSIBLE_HOST_KEY_CHECKING: "false"
+          ANSIBLE_DEPRECATION_WARNINGS: "false"
 
-            - name: Terraform_Destroy
-              working-directory: .github/workflows
-              if: always() && env.ENABLE_DEBUG == 'false'
-              env:
-                  AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
-                  AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
-              run: terraform destroy -var-file "github_vars.tfvars" -var-file "OS.tfvars" --auto-approve -input=false
+# Remove test system - User secrets to keep if necessary
+      - name: Terraform_Destroy
+        working-directory: .github/workflows
+        if: always() && env.ENABLE_DEBUG == 'false'
+        env:
+          AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+        run: terraform destroy -var-file "github_vars.tfvars" -var-file "OS.tfvars" --auto-approve -input=false
diff --git a/.github/workflows/main.tf b/.github/workflows/main.tf
@@ -81,4 +81,3 @@ resource "local_file" "inventory" {
         skip_reboot: false
     EOF
 }
-
diff --git a/.yamllint b/.yamllint
@@ -1,28 +1,33 @@
 ---
-# Based on ansible-lint config
 extends: default
 
+ignore: |
+    tests/
+    molecule/
+    .github/
+    .gitlab-ci.yml
+    *molecule.yml
+
 rules:
-    braces: {max-spaces-inside: 1, level: error}
-    brackets: {max-spaces-inside: 1, level: error}
-    colons: {max-spaces-after: -1, level: error}
-    commas: {max-spaces-after: -1, level: error}
-    comments: disable
-    comments-indentation: disable
-    document-start: disable
-    empty-lines: {max: 3, level: error}
-    hyphens: {level: error}
     indentation:
         # Requiring 4 space indentation
         spaces: 4
         # Requiring consistent indentation within a file, either indented or not
         indent-sequences: consistent
-    key-duplicates: enable
+    braces:
+        max-spaces-inside: 1
+        level: error
+    brackets:
+        max-spaces-inside: 1
+        level: error
+    empty-lines:
+        max: 1
     line-length: disable
+    key-duplicates: enable
     new-line-at-end-of-file: enable
     new-lines:
         type: unix
     trailing-spaces: enable
     truthy:
         allowed-values: ['true', 'false']
-        check-keys: true
+        check-keys: false
diff --git a/ChangeLog.md b/ChangeLog.md
@@ -1,5 +1,14 @@
 # Changelog
 
 ## Release 0.9.0
-- Initial Release
+
+## April 2023 Updates
+  - Ansible-lint Check
+  - Yamllint Updated File
+  - Yamllint Check
+  - Updated Module Names To Full
+  - Updated License
+  - Updated Readme To New Format
+
+## Initial Release
 - Updated to release V1R7
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Ansible Lockdown
+Copyright (c) 2023 Mindpoint Group / Lockdown Enterprise / Lockdown Enterprise Releases
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal