Merge "Remove readme files within the roles"

_skeleton_role_/README.md

@@ -1,29 +0,0 @@
-Role Name
-=========
-
-A brief description of the role goes here.
-
-
-Requirements
-------------
-
-Any pre-requisites that may not be covered by Ansible itself or the role should
-be mentioned here.
-
-
-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
-------------
-
-A list of other roles hosted on Galaxy should go here, plus any details in
-regards to parameters that may need to be set for other roles, or variables
-that are used from other roles.

tripleo_ansible/roles/aide/README.md

@@ -1,4 +0,0 @@
-Aide
-====
-
-Ansible role to install and configure aide

tripleo_ansible/roles/test_json_error_callback/README.md

@@ -1,4 +0,0 @@
-test_json_error_callback
-========================
-
-Role to test the json_error callback plugin.

tripleo_ansible/roles/test_package_action/README.md

@@ -1,6 +0,0 @@
-test_package_action
-===================
-
-This role tests the package action plugin shim used within tripleo.
-
-The role tests will run through a default, negative, and positive scenario.

tripleo_ansible/roles/tripleo-bootstrap/README.md

@@ -1,14 +0,0 @@
-tripleo-bootstrap
-=================
-
-An Ansible role to bootstrap a TripleO deployment.
-
-Dependencies
-------------
-
-This role needs repositories to be deployed as it works now.
-
-Author Information
-------------------
-
-OpenStack TripleO team

tripleo_ansible/roles/tripleo-ceph-fetch-dir/README.md

@@ -1,44 +0,0 @@
-Ansible Role to manage a ceph-ansible fetch directory
-=====================================================
-
-When scaling Ceph monitors, ceph-ansible uses context from the
-fetch_directory to prevent new monitors from trying to bootstrap
-a new Ceph cluster
-
-This role saves the fetch_directory to either Swift or a local
-directory after each ceph-ansible playbook run; and if there is
-a backup of fetch directory in Swift or the specificied local
-directory, restores it before each ceph-ansible playbook run.
-
-The main.yml does not include the backup_and_clean.yml because
-that should be run separately as a post task as needed by a
-separate import using tasks_from.
-
-Requirements
-------------
-
-None
-
-Role Variables
---------------
-
-- ceph_ansible_tarball_name: The name of the file which will contain a
-  tar.gz backup of the ceph-ansible fetch directory. Used for both the
-  local and swift backup methods. (default: 'temporary_dir.tar.gz')
-
-- old_ceph_ansible_tarball_name: The name of the file which will be
-  saved in /tmp when the ceph-ansible fetch directory is downloaded
-  from Swift. Not used for local backups and only used for
-  Swift backups. (default: 'temporary_dir_old.tar.gz')
-
-- new_ceph_ansible_tarball_name: The name of the file which will be
-  saved in /tmp after ceph-ansible runs and then uploaded to Swift.
-  Not used for local backups only only used for Swift backups.
-  (default: 'temporary_dir_new.tar.gz')
-
-
-Dependencies
-------------
-
-- tripleo-ceph-common
-- tripleo-ceph-work-dir

tripleo_ansible/roles/tripleo-ceph-run-ansible/README.md

@@ -1,44 +0,0 @@
-Ansible Role to manage the exectution of ceph-ansible from within TripleO
-=========================================================================
-
-Executes playbooks from ceph-ansible using parameters from TripleO.
-
-After the working directory is created by the tripleo-ceph-work-dir
-role and the working directory has been populated with host_vars
-mapping node specific overrides by the tripleo-ceph-uuid role, and
-after the fetch directory is populated with context from previous
-ceph-ansible runs, by the tripleo-ceph-fetch-dir role, the playbooks
-from ceph-ansible may be executed.
-
-This role creates the shell script ceph_ansible_command.sh within
-the ceph-ansible working directory and then executes the shell script.
-If the shell script's return is non-zero, the deployment fails and an
-error message from ansible is displayed.
-
-After this role is used, the tasks from backup_and_clean.yml from the
-tripleo-ceph-work-dir role should be used to persist the ceph-ansible
-fetch directory and then remove it so that future runs of ceph-ansible
-by this role do not have permissions issues when the role is used by a
-different user.
-
-Requirements
-------------
-
-None
-
-Role Variables
---------------
-
-- ceph_ansible_playbooks_param: the list of ceph-ansible playbooks to
-  be run; e.g. ['/usr/share/ceph-ansible/site-container.yml.sample'])
-  is the default but any item in ceph-ansible/infrastructure-playbooks
-  may be passed. If the list contains more than one item, each
-  playbook is executed sequentially.
-
-Dependencies
-------------
-
-- tripleo-ceph-common
-- tripleo-ceph-work-dir
-- tripleo-ceph-fetch-dir
-- tripleo-ceph-uuid

tripleo_ansible/roles/tripleo-ceph-uuid/README.md

@@ -1,30 +0,0 @@
-Ansible Role to gather node UUIDs for node-specfic overrides
-============================================================
-
-Populates the host_vars of the ceph-ansible working directory,
-as provided by the tripleo-ceph-work-dir role, by mapping each
-hostname to its UUID. The UUID is determined by running the
-`dmidecode -s system-uuid` command on each node with Ansible.
-This role creates and executes its own playbook. This role
-sets up the host_vars directory used by ceph-ansible so
-that TripleO's "node specific overrides" can be used to
-override a particular parameter for only a subset of hosts.
-The most popular usecase for this role is to pass a different
-list of block devices to be used as OSDs for a subset of servers
-which differ from the majority of servers.
-
-Requirements
-------------
-
-None
-
-Role Variables
---------------
-
-None
-
-Dependencies
-------------
-
-- tripleo-ceph-common
-- tripleo-ceph-work-dir

tripleo_ansible/roles/tripleo-ceph-work-dir/README.md

@@ -1,57 +0,0 @@
-Ansible Role to manage a ceph-ansible working directory
-=======================================================
-
-The aim of this role and its supporting roles is to automate steps
-that a ceph-ansible user normally does manually so that TripleO
-may complete these steps for the user before and after ceph-ansible
-runs.
-
-Creates a directory within config-download called "ceph-ansible"
-which contains the following contents, which are prerequisites
-for ceph-ansible to be used:
-
-- group_vars directory
-- host_vars directory
-- an inventory with the host groups ceph-ansible expects
-- an extra_vars.yml file
-
-The group_vars directory will be populated with the file all.yml which
-contains content from the ceph_ansible_group_vars_all variable.
-Additional files in group_vars will be populated by config-download
-external_deploy_tasks Ansible embdeded directly in TripleO Heat
-Templates.
-
-The host_vars directory will be populated for each host based on
-that host's UUID by the tripleo-ceph-uuid role.
-
-The extra_vars.yml file will be populated with content from the
-ceph_ansible_extra_vars variable.
-
-This role also crecates an empty fetch_directory within the work
-directory but the tripleo-ceph-fetch-dir role should be used to
-populate and persist this fecth directory before the tripleo-run-
-ceph-ansible role is used.
-
-Requirements
-------------
-
-None
-
-Role Variables
---------------
-
-- ceph_ansible_group_vars_all: map containing all variables typically
-  found in ceph-ansible/group_vars/all.yml.
-
-- ceph_ansible_extra_vars: map containing all variables the user
-  wishes to pass to the ceph-ansible run using 'ansible-playbook
-  --extra-vars @extra_vars.yml'
-
-- ceph_ansible_private_key_file: The private SSH key that ceph-ansible
-  will use to connect to the nodes it will configure. (defaults to the
-  config-download "{{ playbook_dir }}/ssh_private_key")
-
-Dependencies
-------------
-
-- tripleo-ceph-common

tripleo_ansible/roles/tripleo-clients-install/README.md

@@ -1,30 +0,0 @@
-# tripleo-clients-install
-
-Installs openstack clients packages
-
-
-## Role Variables
-### Common variables
-- tripleo_clients_install_python_prefix: package prefix
-```YAML
-tripleo_clients_install_python_prefix: python3
-```
-
-### main task
-- tripleo_clients_install_dict: hash listing the different client and package
-  state:
-```YAML
-tripleo_clients_install_dict:
-  aodh: present
-  barbican: absent
-```
-
-### install_pkgs task
-- tripleo_clients_install_client: client name you want to manage
-```YAML
-tripleo_clients_install_client: aodh
-```
-- tripleo_clients_install_pkg_state: package state you want
-```YAML
-tripleo_clients_install_pkg_state: present
-```

tripleo_ansible/roles/tripleo-container-tag/README.md

@@ -1,42 +0,0 @@
-tripleo-container-tag
-=====================
-
-An Ansible role to tag Pacemaker-managed containers.
-
-Requirements
-------------
-
-It requires Docker or Podman on the host, depending which container CLI
-is used.
-
-Role variables
---------------
-
-- container_image: -- Name of the container image to tag.
-- container_image_latest: -- Name of the tag.
-- container_cli: -- Name of the Container CLI tool (default to docker).
-- pull_image: -- Pulling or not the image passed in container_image variable ( default to true).
-
-Example Playbook
-----------------
-
-Sample playbook to call the role:
-
-  - name: Tag Pacemaker containers
-    hosts: all
-    roles:
-      - tripleo-container-tag
-    vars:
-      container_image: haproxy
-      container_image_latest: pcmklatest
-      container_cli: docker
-
-License
--------
-
-Free software: Apache License (2.0)
-
-Author Information
-------------------
-
-OpenStack TripleO team

tripleo_ansible/roles/tripleo-create-admin/README.md

@@ -1,15 +0,0 @@
-# TripleO Create Admin #
-
-A role to create an admin user to be later used for running playbooks.
-
-## Role Variables ##
-
-| Name              | Default Value       | Description           |
-|-------------------|---------------------|-----------------------|
-| `tripleo_admin_user` | `tripleo-admin`     | Name of user to create|
-| `tripleo_admin_pubkey` | `[undefined]`     | Public key for authorization|
-
-## Requirements ##
-
- - ansible >= 2.4
- - python >= 2.6

tripleo_ansible/roles/tripleo-image-serve/README.md

@@ -1,4 +0,0 @@
-tripleo-container-tag
-=====================
-
-An Ansible role to deploy an apache based container image serving service.

tripleo_ansible/roles/tripleo-ssh-known-hosts/README.md

@@ -1,35 +0,0 @@
-tripleo-ssh-known-hosts
-=======================
-
-An Ansible role to add all SSH host keys to the host level known hosts file on
-all hosts.
-
-Requirements
-------------
-
-This section needs to be documented.
-
-Dependencies
-------------
-
-None.
-
-Example Playbook
-----------------
-
-Sample playbook to call the role:
-
-  - name: Configure SSH known hosts
-    hosts: all
-    roles:
-      - tripleo-ssh-known-hosts
-
-License
--------
-
-Free software: Apache License (2.0)
-
-Author Information
-------------------
-
-OpenStack TripleO team

tripleo_ansible/roles/tripleo-validations-package/README.md

@@ -1,5 +0,0 @@
-tripleo-validations-package
-===========================
-
-Installs the tripleo-validations package, and create a dedicated "validations"
-user with its home directory.

tripleo_ansible/roles/tuned/README.md

@@ -1,4 +0,0 @@
-Tuned
-=====
-
-Ansible role to install and manage tuned profiles.