Skip to content

Commit

Permalink
📚 Extends documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
bdsoha committed Nov 18, 2024
1 parent 258f1f0 commit 49485dd
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 4 deletions.
4 changes: 2 additions & 2 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -60,10 +60,10 @@ ARG TARGETARCH
# renovate: source=github-releases dep=google/go-containerregistry
ARG crane_version=0.20.2

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

Expand Down
23 changes: 21 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,14 @@
[![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)

## Documentation
[![Latest](https://img.shields.io/github/v/release/kloudkit/ansible-controller?style=flat-square)](https://github.com/kloudkit/ansible-controller/releases)

The *Ansible Controller* is a lightweight, containerized solution for managing your
Ansible playbooks.
Simplify your configuration management with a pre-configured, ready-to-use Ansible
environment that runs seamlessly in Docker.

## Usage

The image includes a default inventory *(`/etc/ansible/hosts`)* named `controller` that
runs on `localhost` without root privileges.
Expand All @@ -26,13 +33,25 @@ To use it, copy the following example playbook:
```sh
docker run --rm \
# Mount local playbooks directory
-v ./playbooks:/workspace \
ghcr.io/kloudkit/ansible-controller \
# Set playbook variables
-e FOO=bar \
/workspace/play.yaml
# Specify the playbook to run
play.yaml
```

## Contribute

Want to help make this project even better?

Contribute to *Ansible Controller* by reporting [issues][] or submitting [pull requests][].

## License

This project is licensed under the
[**MIT License**](https://github.com/kloudkit/ansible-controller?tab=MIT-1-ov-file#MIT-1-ov-file)

[issues]: https://github.com/kloudkit/ansible-controller/issues/new/choose
[pull requests]: https://github.com/kloudkit/ansible-controller/compare

0 comments on commit 49485dd

Please sign in to comment.