Merge pull request #4 from madorn/md-ee

add execution environment file for ansible-builder

README.md

@@ -2,6 +2,8 @@
 Contains Ansible playbooks for installing operators and checking status of the install.
 
 ## Usage
+
+### Setup
 Set the following env vars:
 
 ```
@@ -14,8 +16,38 @@ or if you prefer set:
 K8S_AUTH_KUBECONFIG=<path to your kubeconfig file>
 ```
 
-Copy var.yaml.example to vars.yaml and modify accordingly. If packages is empty, it will pull ALL packages
-from the catalog source.
+Copy `var.yaml.example` to `vars.yaml` and modify accordingly. If `packages` value is empty, it will pull ALL packages from the catalog source.
+
+### Run playbooks with Ansible Navigator
+
+The fastest way to get started is to run the playbooks via `ansible-navigator` with an Ansible execution environment container image:
+
+```
+ansible-navigator run audits.yaml --container-engine podman --eei quay.io/opdev/opcap-ansible-ee:latest -e @vars.yaml --penv K8S_AUTH_VERIFY_SSL --penv K8S_AUTH_API_KEY --penv K8S_AUTH_HOST -m stdout
+````
+
+or if you prefer to provide a kubeconfig:
+
+```
+ansible-navigator run audits.yaml --container-engine podman --eei quay.io/opdev/opcap-ansible-ee:latest -e @vars.yaml --senv K8S_AUTH_KUBECONFIG=/dir/kubeconfig --eev /dir:/dir -m stdout
+```
+
+### Run playbooks with Ansible Playbook
+
+
+You may prefer to run playbooks via `ansible-playbook` although this method requires proper dependencies installed on localhost:
+
+```
+ansible-playbook -e @vars.yaml audits.yaml
+```
+
+### Misc
+
+Build your own execution environment image with `ansible-builder`:
+
+```
+ansible-builder build  --container-runtime=podman --tag=opcap-ansible-ee --prune-images --verbosity 3
+```
+
 
-`ansible-playbook -e @vars.yaml audits.yaml`
 

execution-environment.yml

@@ -0,0 +1,12 @@
+---
+version: 3
+
+build_arg_defaults:
+  ANSIBLE_GALAXY_CLI_COLLECTION_OPTS: '--force --verbose'
+
+dependencies:
+  ansible_core:
+    package_pip: ansible-core==2.13.10
+  ansible_runner:
+    package_pip: ansible-runner==2.3.2
+  galaxy: requirements.yml

requirements.yml

@@ -0,0 +1,3 @@
+---
+collections:
+  - name: kubernetes.core