Skip to content

Commit

Permalink
Add note about Collection Metadata usage and update callout formatting
Browse files Browse the repository at this point in the history
Signed-off-by: Webster Mudge <[email protected]>
  • Loading branch information
wmudge committed Sep 26, 2023
1 parent 9b85c79 commit 2024ad7
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 7 deletions.
1 change: 0 additions & 1 deletion .github/workflows/validate_pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ on:
branches:
- 'release/**'
- 'devel'
- 'devel-pvc-base'

jobs:
validate:
Expand Down
6 changes: 4 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ As a _best practice_, you can prefix your branches with:
|`fix/`|A non-urgent bug fix|`fix/refactor-module-output-params`|
|`hotfix/`|An urgent bug fix|`hotfix/patch-insecure-module`|

:fire_extinguisher: **NOTE:** a **hotfix** should branch from `main`. It will then be committed to both the `main` and `devel` branches.
> [!NOTE]
> :fire_extinguisher: A **hotfix** should branch from `main`. It will then be committed to both the `main` and `devel` branches.
## Signing your commits

Expand Down Expand Up @@ -73,7 +74,8 @@ To agree, make sure to add line at the end of every git commit message, like thi
Signed-off-by: John Doe <[email protected]>
```

:rocket: TIP! Add the sign-off automatically when creating the commit via the `-s` flag, e.g. `git commit -s`.
> [!NOTE]
> :rocket: Add the sign-off automatically when creating the commit via the `-s` flag, e.g. `git commit -s`.
## Still have questions? Opinions? Comments?

Expand Down
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,8 @@ See [Building the Collection](#building-the-collection) for details on creating

`cloudera.cluster` expects `ansible-core>=2.10,<2.13`.

> **WARNING:** The current `import_template` functionality does not yet work with Ansible version `2.13` and later.
> [!WARNING]
> The current `import_template` functionality does not yet work with Ansible version `2.13` and later.
The collection has the following _required_ dependencies:

Expand Down Expand Up @@ -108,6 +109,8 @@ All collection dependencies, required and optional, can be found in `requirement

`ansible-builder` can discover and install all Python dependencies - current collection and dependencies - if you wish to use that application to construct your environment. Otherwise, you will need to read each collection and role dependency and follow its installation instructions.

See the [Collection Metadata](https://ansible.readthedocs.io/projects/builder/en/latest/collection_metadata/) section for further details on how to install (and manage) collection dependencies.

You may wish to use a _virtual environment_ to manage the Python dependencies.

See the `base` *Execution Environment* configuration in [`cloudera-labs/cldr-runner`](https://github.com/cloudera-labs/cldr-runner) as an example of how you can install the optional dependencies to suit your specific needs.
Expand Down Expand Up @@ -179,6 +182,9 @@ Your local documentation will be found at `docsbuild/build/html`.

Active development is focused on **CDP Private Cloud** deployments and their respective platform compatibility matrices.

> [!NOTE]
> While the collection's plugins and roles can be used to deploy CDH 5.x and CDH 6.x environments, it is only possible to install a subset of their supported platform components (i.e JDK and database versions) using this tooling.
### Cloudera Distributions

- Cloudera Manager / CDP Private Cloud Base 7.1.x
Expand All @@ -193,11 +199,10 @@ Active development is focused on **CDP Private Cloud** deployments and their res
- Ubuntu 18.04 LTS (Bionic Beaver)
- Ubuntu 20.04 LTS (Focal Fossa)

> While the collection's plugins and roles can be used to deploy CDH 5.x and CDH 6.x environments, it is only possible to install a subset of their supported platform components (i.e JDK and database versions) using this tooling.
## Operational Features

> **NOTE:** These operational features are deprecated as of version 4.x. If you want to use or build similar features and functions, head over to the [Discussions](https://github.com/cloudera-labs/cloudera.cluster/discussions) to learn more about using the collection to achieve your platform operations needs.
> [!WARNING]
> These operational features are deprecated as of version 4.x. If you want to use or build similar features and functions, head over to the [Discussions](https://github.com/cloudera-labs/cloudera.cluster/discussions) to learn more about using the collection to achieve your platform operations needs.
This collection includes support for:

Expand Down

0 comments on commit 2024ad7

Please sign in to comment.