Skip to content

Commit 821d224

Browse files
dminnear-rhdminnear-rh
authored
Merge pull request #57 from dminnear-rh/update-readme
Update readme
2 parents 8c648ef + 367b102 commit 821d224

1 file changed

Lines changed: 84 additions & 24 deletions

File tree

‎README.md‎

Lines changed: 84 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,49 @@
11
# Validated Pattern Utility Container
22

3-
utility container for simplified execution of imperative commands in each of the patterns.
3+
[![Quay Repository](https://img.shields.io/badge/Quay.io-utility--container-blue?logo=quay)](https://quay.io/repository/hybridcloudpatterns/utility-container)
44

5+
A utility container for simplified execution of imperative commands in each of the Validated Patterns.
6+
7+
## Overview
8+
9+
This container provides a pre-configured environment with all the necessary tools and dependencies for working with Validated Patterns. It includes Ansible, Kubernetes tools, cloud CLIs, and other utilities commonly needed for pattern deployment and management.
510

611
## Installed Software
712

813
| name | type | version |
914
|:---------------------------------:|:--------:|:------------:|
1015
|ansible |pip |2.16.14 |
11-
|ansible.posix |collection|2.0.0 |
12-
|ansible-runner |pip |2.4.0 |
13-
|ansible.utils |collection|5.1.2 |
16+
|ansible.posix |collection|2.1.0 |
17+
|ansible-runner |pip |2.4.1 |
18+
|ansible.utils |collection|6.0.0 |
1419
|argocd |binary |v2.9.7+fbb6b20|
15-
|awscli |pip |1.36.34 |
20+
|awscli |pip |1.42.1 |
1621
|awx.awx |collection|24.6.1 |
1722
|awxkit |pip |24.6.1 |
18-
|azure-cli |pip |2.67.0 |
19-
|boto3 |pip |1.35.93 |
20-
|botocore |pip |1.35.93 |
21-
|community.general |collection|10.2.0 |
22-
|community.okd |collection|4.0.1 |
23+
|azure-cli |pip |2.75.0 |
24+
|boto3 |pip |1.40.1 |
25+
|botocore |pip |1.40.1 |
26+
|community.general |collection|11.1.1 |
27+
|community.okd |collection|5.0.0 |
2328
|gcloud |pip |0.18.3 |
24-
|git-core |package |2.43.5 |
29+
|git-core |package |2.47.3 |
2530
|hcp |binary |4.17.0 |
2631
|helm |binary |v3.13.3 |
2732
|infra.ah_configuration |collection|2.1.0 |
28-
|infra.controller_configuration |collection|2.11.0 |
33+
|infra.controller_configuration |collection|3.1.2 |
2934
|infra.eda_configuration |collection|1.1.0 |
3035
|jmespath |pip |1.0.1 |
3136
|jq |package |1.6 |
32-
|kubernetes.core |collection|5.0.0 |
33-
|kubernetes |pip |31.0.0 |
37+
|kubernetes.core |collection|6.0.0 |
38+
|kubernetes |pip |33.1.0 |
3439
|kustomize |binary |v5.0.1 |
3540
|make |package |4.3 |
3641
|openshift |binary |4.14.20 |
37-
|pytest |pip |8.3.4 |
42+
|pytest |pip |8.4.1 |
3843
|python3-pip |package |21.3.1 |
39-
|python |package |3.11.9 |
44+
|python |package |3.11.11 |
4045
|redhat_cop.controller_configuration|collection|2.3.1 |
41-
|rhvp.cluster_utils |collection|1.0.2 |
46+
|rhvp.cluster_utils |collection|1.1.0 |
4247
|sshpass |package |1.09 |
4348
|tar |package |1.34 |
4449
|tea |binary |0.9.2 |
@@ -47,19 +52,74 @@ utility container for simplified execution of imperative commands in each of the
4752
|vp-qe-test-common |pip |0.1.0 |
4853

4954
## Usage
50-
**Pull the image**
55+
56+
### Pull the Image
57+
5158
```bash
5259
podman pull quay.io/hybridcloudpatterns/utility-container:latest
5360
```
5461

55-
**Use image to execute a playbook**
62+
### Examples
63+
64+
**Interactive shell**
65+
66+
```bash
67+
podman run --rm -it --net=host \
68+
--security-opt label=disable \
69+
-v ${HOME}:/pattern \
70+
-v ${HOME}:${HOME} \
71+
-w $(pwd) \
72+
quay.io/hybridcloudpatterns/utility-container:latest sh
73+
```
74+
75+
**Execute an Ansible playbook**
76+
77+
```bash
78+
podman run --rm -it --net=host \
79+
--security-opt label=disable \
80+
-v ${HOME}:/pattern \
81+
-v ${HOME}:${HOME} \
82+
-w $(pwd) \
83+
quay.io/hybridcloudpatterns/utility-container:latest \
84+
ansible-playbook <playbook>.yml
85+
```
86+
87+
**Run OpenShift commands**
88+
5689
```bash
57-
podman run -it --rm --net=host quay.io/hybridcloudpatterns/utility-container:latest ansible-playbook <playbook>.yml
90+
podman run --rm -it --net=host \
91+
--security-opt label=disable \
92+
-v ${HOME}:/pattern \
93+
-v ${HOME}:${HOME} \
94+
-w $(pwd) \
95+
quay.io/hybridcloudpatterns/utility-container:latest \
96+
oc get nodes
5897
```
5998

60-
## Build the image
61-
Just run: `make build` and both amd64 and arm64 will be built locally (you will need the qemu-user-static package installed)
99+
## Troubleshooting
100+
101+
**Permission issues with volume mounts**
102+
- Ensure the `--security-opt label=disable` flag is used when running the container.
103+
- Check that your user has read/write access to the mounted directories.
104+
105+
**Network connectivity issues**
106+
- Use `--net=host` for full network access.
107+
- For restricted environments, configure appropriate network policies.
108+
109+
**Missing tools or outdated versions**
110+
- Check the installed software table above for current versions.
111+
- Consider building a custom image if you need different tool versions.
112+
113+
## Development
114+
115+
### Build the Image
116+
117+
Run `make build` to build both amd64 and arm64 architectures locally (requires qemu-user-static package).
118+
119+
### Upload to Registry
120+
121+
Run `make upload` to push the image to the official repository.
62122

63-
To upload the image to the official repository, run: `make UPLOADREGISTRY=quay.io/hybridcloudpatterns upload` (by default it uploads somewhere else
64-
to try and avoid accidental uploads)
123+
### Contributing
65124

125+
To update software versions or add new tools, modify the Containerfile and update the software table in this readme. Use `make versions` to generate the software versions table from the container after building locally.

0 commit comments

Comments
 (0)