IBM · jacobemery · Jun 26, 2022 · Jun 27, 2022 · Jun 27, 2022 · Jun 27, 2022
diff --git a/.ansible-lint b/.ansible-lint
@@ -0,0 +1,20 @@
+---
+# .ansible-lint
+
+profile: null # min, basic, moderate, safety, shared, production
+
+# exclude_paths included in this file are parsed relative to this file's location
+# and not relative to the CWD of execution. CLI arguments passed to the --exclude
+# option are parsed relative to the CWD of execution.
+exclude_paths:
+  - .github/
+  - docs/
+# parseable: true
+# quiet: true
+# strict: true
+verbosity: 1
+
+skip_list:
+  - no-changed-when
+  - name[casing]
+  - var-naming[no-role-prefix]
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,31 @@
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = true
+
+[Dockerfile]
+indent_size = 4
+
+# Tab indentation (no size specified)
+[Makefile]
+indent_style = tab
+
+# Don't mess with markdown files
+[*.md]
+trim_trailing_whitespace = false
+
+[*.py]
+indent_size = 4
+
+[*.sh]
+indent_size = 4
+
+[*.{yml,yaml}]
+indent_size = 2
diff --git a/.gitattributes b/.gitattributes
@@ -1,2 +1,4 @@
 # Auto detect text files and perform LF normalization
 * text=auto
+*.yaml linguist-detectable=true
+*.yaml linguist-language=YAML
diff --git a/.github/dco.yml b/.github/dco.yml
@@ -0,0 +1,4 @@
+# This enables DCO bot for you, please take a look https://github.com/probot/dco
+# for more details.
+require:
+  members: false
diff --git a/.github/workflows/main.yaml b/.github/workflows/main.yaml
@@ -0,0 +1,41 @@
+name: Publish docs via GitHub Pages
+on:
+  workflow_dispatch:
+
+  push:
+    branches:
+      - main
+    paths:
+      - 'mkdocs.yaml'
+      - 'docs/**'
+
+jobs:
+  build:
+    name: Deploy docs
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout main
+        uses: actions/checkout@v4
+        with:
+          ref: main
+          fetch-depth: 0
+
+      - name: Setup Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.x'
+
+      - name: Fetch Latest gh-pages Branch
+        run: |
+          git fetch origin gh-pages
+          git checkout gh-pages
+          git pull origin gh-pages
+          git checkout main
+
+      - name: Install mkdocs
+        run: pip install mkdocs
+
+      - name: Deploy docs
+        run: python3 -m mkdocs gh-deploy
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.gitignore b/.gitignore
@@ -1 +1,4 @@
 .DS_Store
+.iso
+.vscode
+site
diff --git a/.releaserc.json b/.releaserc.json
@@ -0,0 +1,30 @@
+{
+  "branches": [
+    {"name": "main"}
+  ],
+  "plugins": [
+    ["@semantic-release/commit-analyzer", {
+      "preset": "conventionalcommits",
+      "releaseRules": [
+        {"type": "chore", "release": "patch"},
+        {"type": "docs", "release": "patch"},
+        {"type": "test", "release": "patch"},
+        {"type": "perf", "release": "patch"}
+      ]
+    }],
+    ["@semantic-release/release-notes-generator", {
+      "preset": "conventionalcommits",
+      "presetConfig": {
+        "types": [
+          {"type": "feat", "section": "Features"},
+          {"type": "fix", "section": "Bug Fixes"},
+          {"type": "chore", "section": "Miscellaneous"},
+          {"type": "docs", "section": "Documentation"},
+          {"type": "perf", "section": "Performance"},
+          {"type": "test", "section": "Tests", "hidden": false}
+        ]
+      }
+    }],
+    "@semantic-release/github"
+  ]
+}
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021, 2023 IBM Corporation. All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE
diff --git a/README.md b/README.md
@@ -1,4 +1,2 @@
-# Ansible-OpenShift-Provisioning
-
-Phillip adding comment via lesson 3
-
+# Ansible-Automated OpenShift Provisioning on KVM on IBM zSystems / LinuxONE
+The documentation for this project can be found [here](https://ibm.github.io/Ansible-OpenShift-Provisioning/).
diff --git a/ansible.cfg b/ansible.cfg
@@ -1,5 +1,11 @@
 [defaults]
-inventory = inventory
-private_key_file = ~/.ssh/ansible
-
+private_key_file=~/.ssh/ansible-ocpz
+inventory=inventories/default/
+roles_path=roles
+#collections_path=collections
+interpreter_python=auto
+host_key_checking=False
+deprecation_warnings=False
 
+[inventory]
+cache=True
diff --git a/bootstrap.yml b/bootstrap.yml
diff --git a/build_script.sh b/build_script.sh
diff --git a/collections/ansible/posix/ansible-posix-1.4.0.tar.gz b/collections/ansible/posix/ansible-posix-1.4.0.tar.gz
diff --git a/collections/community/crypto/community-crypto-2.3.4.tar.gz b/collections/community/crypto/community-crypto-2.3.4.tar.gz
diff --git a/collections/community/general/community-general-5.2.0.tar.gz b/collections/community/general/community-general-5.2.0.tar.gz
diff --git a/collections/community/libvirt/community-libvirt-1.1.0.tar.gz b/collections/community/libvirt/community-libvirt-1.1.0.tar.gz
diff --git a/collections/ibm/ibm_zhmc/ibm-ibm_zhmc-1.1.0.tar.gz b/collections/ibm/ibm_zhmc/ibm-ibm_zhmc-1.1.0.tar.gz
diff --git a/copy-image.yml b/copy-image.yml
diff --git a/docs/acknowledgements.md b/docs/acknowledgements.md
@@ -0,0 +1,13 @@
+Phillip Wilson  
+Filipe Miranda  
+Patrick Fruth  
+Wasif Mohammad  
+Stuart Tener  
+Fred Bader  
+Ken Morse  
+Nico Boehr  
+Trevor Vardeman  
+Matt Mondics  
+Klaus Smolin  
+Amadeus Podvratnik  
+Miao Zhang-Cohen  
diff --git a/docs/before-you-begin.md b/docs/before-you-begin.md
@@ -0,0 +1,30 @@
+# Before You Begin
+## Description
+* This project automates the User-Provisioned Infrastructure (UPI) method for deploying Red Hat OpenShift Container Platform (RHOCP) on IBM zSystems / LinuxONE using Kernel-based Virtual Machine (KVM) as the hypervisor.
+## Support
+* This is an unofficial project created by IBMers.
+* This installation method is not officially supported by either Red Hat or IBM.
+* However, once installation is complete, the resulting cluster is supported by Red Hat. UPI is the only supported method for RHOCP on IBM zSystems.
+## Difficulty
+* This process is much easier than doing so manually, but still not an easy task. You will likely encounter errors, but you will reach those errors quicker and understand the problem faster than if you were doing this process manually. After using these playbooks once, successive deployments will be much easier.
+    * A very basic understanding of what Ansible does is recommended. Advanced understanding is helpful for further customization of the playbooks. 
+    * A basic understanding of the command-line is required.
+    * A basic understanding of git is recommended, especially for creating your organization's own fork of the repository for further customization.
+    * An advanced understanding of your computing environment is required for setting the environment variables.
+* These Ansible Playbooks automate a User-Provisioned Infrastructure (UPI) deployment of Red Hat OpenShift Container Platform (RHOCP). This process, when done manually, is extremely tedious, time-consuming, and requires high levels of Linux AND IBM zSystems expertise. 
+* UPI is currently the only supported method for deploying RHOCP on IBM zSystems.
+## Why Free and Open-Source?
+* <u>Trust</u>:
+    * IBM zSystems run some of the most highly-secure workloads in the world. Trust is paramount. 
+    * Developing and using code transparently builds trust between developers and users, so that users feel safe using it on their highly sensitive systems. 
+* <u>Customization</u>:
+    * IBM zSystems exist in environments that can be highly complex and vary drastically from one datacenter to another.
+    * Using code that isn't in a proprietary black box allows you to see exactly what is being done so that you can change any part of it to meet your specific needs.
+* <u>Collaboration</u>:
+    * If users encounter a problem, or have a feature request, they can get in contact with the developers directly.
+    * Submit an issue or pull request on GitHub or email jacob.emery@ibm.com. 
+    * Collaboration is highly encouraged!
+* <u>Lower Barriers to Entry</u>:
+    * The easier it is to get RHOCP on IBM zSystems up and running, the better - for you, IBM and Red Hat!
+    * It is free because RHOCP is an incredible product that should have the least amount of barriers to entry as possible. 
+    * The world needs open-source, private, and hybrid cloud.
diff --git a/docs/get-info.md b/docs/get-info.md
@@ -0,0 +1,42 @@
+# Step 1: Get Info
+## Get Repository
+* Open the terminal  
+* Navigate to a folder (AKA directory) where you would like to store this project. 
+    * Either do so graphically, or use the command-line. 
+    * Here are some helpful commands for doing so:
+        * `pwd` to see what directory you're currently in
+        * `ls` to list child directories
+        * `cd <folder-name>` to change directories (`cd ..` to go up to the parent directory)
+        * `mkdir <new-folder-name>` to create a new directory
+* Copy/paste the following and hit enter:  
+`git clone https://github.com/IBM/Ansible-OpenShift-Provisioning.git`
+* Change into the newly created directory
+* The commands and output should resemble the following example:  
+```
+$ pwd
+/Users/example-user
+$ mkdir ansible-project
+$ cd ansible-project/
+$ git clone https://github.com/IBM/Ansible-OpenShift-Provisioning.git
+Cloning into 'Ansible-OpenShift-Provisioning'...
+remote: Enumerating objects: 3472, done.
+remote: Counting objects: 100% (200/200), done.
+remote: Compressing objects: 100% (57/57), done.
+remote: Total 3472 (delta 152), reused 143 (delta 143), pack-reused 3272
+Receiving objects: 100% (3472/3472), 506.29 KiB | 1.27 MiB/s, done.
+Resolving deltas: 100% (1699/1699), done.
+$ ls
+Ansible-OpenShift-Provisioning
+$ cd Ansible-OpenShift-Provisioning/
+$ ls
+CHANGELOG.md	README.md	docs		mkdocs.yaml	roles
+LICENSE		ansible.cfg	inventories	playbooks	
+```
+## Get Pull Secret
+* In a web browser, navigate to Red Hat's [Hybrid Cloud Console](https://console.redhat.com/openshift/install/ibmz/user-provisioned), click the text that says 'Copy pull secret' and save it for the next step.
+## Gather Environment Information
+* You will need a lot of information about the environment this cluster will be set-up in. 
+* You will need the help of at least your IBM zSystems infrastructure team so they can provision you a storage group. You'll also need them to provide you with
+* IP address range, hostnames, subnet, gateway, how much disk space you have to work with, etc.
+* A full list of variables needed are found on the next page. Many of them are filled in with defaults or are optional.
+* Please take your time. I would recommend having someone on stand-by in case you need more information or need to ask a question about the environment.
diff --git a/docs/images/ansible-logo.png b/docs/images/ansible-logo.png
diff --git a/docs/images/overview.png b/docs/images/overview.png
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,8 @@
+# Ansible-Automated OpenShift Provisioning on KVM on IBM zSystems / LinuxONE
+## Overview
+These Ansible Playbooks automate the setup and deployment of a Red Hat OpenShift Container Platform (RHOCP) cluster on IBM zSystems / LinuxONE with Kernel Virtual Machine (KVM) as the hypervisor.  
+<img src="images/overview.png" width="75%"/>
+## Ready to Start?
+Use the left-hand panel to navigate the site. Start with the [Before You Begin](before-you-begin.md) page.
+## Need Help?
+Contact Jacob Emery at jacob.emery@ibm.com