Skip to content

Commit

Permalink
Update README, galaxy.yml, and requirements.yml for optional dependen…
Browse files Browse the repository at this point in the history
…cies

Signed-off-by: Webster Mudge <wmudge@cloudera.com>
  • Loading branch information
wmudge committed Aug 24, 2023
1 parent b0b9098 commit 983927e
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 8 deletions.
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,29 @@
# Ansible Collection for Cloudera Private Cloud
# Ansible Collection for Cloudera (CDP) Private Cloud

## Requirements

- Python 2.x or 3.x
- [Ansible](http://docs.ansible.com/ansible/intro_installation.html)
- [JMESPath](https://jmespath.org/)

### Dependencies

| Name | Type | Version |
| `ansible.posix` | collection | `1.3.0` |
| `community.crypto` | collection | `2.2.1` |
| `community.general` | collection | `4.5.0` |

### Optional Dependencies

| Name | Type | Version |
| `community.mysql` | collection | `3.1.0` |
| `community.postgresql` | collection | `1.6.1` |
| `freeipa.ansible_freeipa` | collection | `1.6.2` |
| `geerlingguy.postgresql` | role | `2.2.0` |
| `geerlingguy.mysql` (patched) | role | `master` |

All dependencies, required and optional, are found in `requirements.yml`. Only the required dependencies are in `galaxy.yml` and thus installed by `ansible-builder` when creating an Environment Execution container.

**Do not use Ansible 2.9.0**. This version has an [issue with templating](https://github.com/ansible/ansible/issues/64745) which causes the playbook execution to fail. Instead, use any 2.8.x version or a later 2.9.x version as these are not affected.

## Usage
Expand Down
7 changes: 3 additions & 4 deletions galaxy.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
---

# Copyright 2023 Cloudera, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
Expand All @@ -14,7 +16,7 @@

namespace: cloudera
name: cluster
version: 3.4.2
version: 4.0.0-rc1

authors: []
readme: README.md
Expand All @@ -26,9 +28,6 @@ dependencies:
'ansible.posix': '1.3.0'
'community.crypto': '2.2.1'
'community.general': '4.5.0'
#'community.mysql': '3.1.0'
#'community.postgresql': '1.6.1'
#'freeipa.ansible_freeipa': '1.6.2'

repository: https://github.com/cloudera-labs/cloudera.cluster
documentation: https://github.com/cloudera-labs/cloudera.cluster
Expand Down
6 changes: 3 additions & 3 deletions requirements.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Copyright 2021 Cloudera, Inc.
---

# Copyright 2023 Cloudera, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand All @@ -12,8 +14,6 @@
# See the License for the specific language governing permissions and
# limitations under the License.

---

roles:
- name: geerlingguy.postgresql
version: 2.2.0
Expand Down

0 comments on commit 983927e

Please sign in to comment.