Skip to content

Commit

Permalink
Update documentation to show 2.4- and 2.5+ example playbooks
Browse files Browse the repository at this point in the history
  • Loading branch information
derekwaters committed Dec 14, 2024
1 parent 7dc5c47 commit 17fd35c
Showing 1 changed file with 35 additions and 1 deletion.
36 changes: 35 additions & 1 deletion roles/aap_ocp_install/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,9 @@ This role depends on the redhat.openshift and kubernetes.core collections.

## Example Playbook

Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too.

The following playbook will install AAP versions 2.4 and earlier:

```yml
---
Expand Down Expand Up @@ -147,6 +149,38 @@ Including an example of how to use your role (for instance, with variables passe
...
```

The following playbook will install AAP versions 2.5 and later:

```yml
---
- name: Install AAP on OCP playbook 2.5+
hosts: localhost
gather_facts: false

vars:
aap_ocp_install_connection:
host: "https://api.crc.testing:6443"
username: kubeadmin
password: <PASSWORD>
validate_certs: false
aap_ocp_install_namespace: aap-test
aap_ocp_install_operator:
channel: "stable-2.5-cluster-scoped"
aap_ocp_install_platform:
instance_name: automationcontroller
namespace: aap-platform
aap_ocp_install_controller: true
aap_ocp_install_eda: true
aap_ocp_install_hub:
storage_type: file
file_storage_storage_class: my-filestore-rwx
file_storage_size: 30Gi

roles:
- infra.aap_utilities.aap_ocp_install
...
```

## License

[GPLv3+0](https://github.com/redhat-cop/aap_utilities#licensing)
Expand Down

0 comments on commit 17fd35c

Please sign in to comment.