ansible/roles/docker/README.md
2025-01-12 11:32:20 -06:00

59 lines
1.5 KiB
Markdown

<!--
Copyright 2025 Code Fox
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
Docker
=========
Sets up Docker on Ubuntu
- Installation
- Uninstallation
- Updates
Requirements
------------
- Ubuntu 24.04 (or newer)
Role Variables
--------------
A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well.
Dependencies
------------
- [ubuntu](../ubuntu/README.md)
Example Playbook
----------------
Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
- hosts: servers
roles:
- { role: username.rolename, x: 42 }
License
-------
[Apache 2.0](../../LICENSE.md)
Author Information
------------------
- [Code Fox](https://c0de.dev)