Skip to content

Commit 49485dd

Browse files
committed
📚 Extends documentation
1 parent 258f1f0 commit 49485dd

File tree

2 files changed

+23
-4
lines changed

2 files changed

+23
-4
lines changed

‎Dockerfile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,10 +60,10 @@ ARG TARGETARCH
6060
# renovate: source=github-releases dep=google/go-containerregistry
6161
ARG crane_version=0.20.2
6262

63-
RUN case ${TARGETARCH} in "arm64") amr64 ;; "amd64") file=x86_64 ;; esac \
63+
RUN case ${TARGETARCH} in "arm64") file=amr64 ;; "amd64") file=x86_64 ;; esac \
6464
&& curl -fsSL "https://github.com/google/go-containerregistry/releases/download/v${crane_version}/go-containerregistry_Linux_${file}.tar.gz" \
6565
| tar -xzf - \
66-
&& curl -fsSL https://mirror.openshift.com/pub/openshift-v4/x86_64/clients/ocp/4.9.9/openshift-client-linux.tar.gz \
66+
&& curl -fsSL "https://mirror.openshift.com/pub/openshift-v4/${file}/clients/ocp/4.17.5/openshift-client-linux.tar.gz" \
6767
| tar -xzf - -C /tmp \
6868
&& cp /tmp/oc .
6969

‎README.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,14 @@
44
55
[![License](https://img.shields.io/badge/License-MIT-blue?style=flat-square&link=https://github.com/kloudkit/ansible-controller?tab=MIT-1-ov-file#MIT-1-ov-file)](https://github.com/kloudkit/ansible-controller?tab=MIT-1-ov-file#MIT-1-ov-file)
66

7-
## Documentation
7+
[![Latest](https://img.shields.io/github/v/release/kloudkit/ansible-controller?style=flat-square)](https://github.com/kloudkit/ansible-controller/releases)
8+
9+
The *Ansible Controller* is a lightweight, containerized solution for managing your
10+
Ansible playbooks.
11+
Simplify your configuration management with a pre-configured, ready-to-use Ansible
12+
environment that runs seamlessly in Docker.
13+
14+
## Usage
815

916
The image includes a default inventory *(`/etc/ansible/hosts`)* named `controller` that
1017
runs on `localhost` without root privileges.
@@ -26,13 +33,25 @@ To use it, copy the following example playbook:
2633
2734
```sh
2835
docker run --rm \
36+
# Mount local playbooks directory
2937
-v ./playbooks:/workspace \
3038
ghcr.io/kloudkit/ansible-controller \
39+
# Set playbook variables
3140
-e FOO=bar \
32-
/workspace/play.yaml
41+
# Specify the playbook to run
42+
play.yaml
3343
```
3444

45+
## Contribute
46+
47+
Want to help make this project even better?
48+
49+
Contribute to *Ansible Controller* by reporting [issues][] or submitting [pull requests][].
50+
3551
## License
3652

3753
This project is licensed under the
3854
[**MIT License**](https://github.com/kloudkit/ansible-controller?tab=MIT-1-ov-file#MIT-1-ov-file)
55+
56+
[issues]: https://github.com/kloudkit/ansible-controller/issues/new/choose
57+
[pull requests]: https://github.com/kloudkit/ansible-controller/compare

0 commit comments

Comments
 (0)