Merge pull request #516 from jpodivin/playbook-docs

Stub documentation for all playbooks
openstack-k8s-operators · Jan 2, 2024 · 5ead703 · 5ead703
2 parents c1344d9 + 83c46b7
commit 5ead703
Show file tree

Hide file tree

Showing 30 changed files with 90 additions and 0 deletions.
diff --git a/docs/source/playbooks/bootstrap.rst b/docs/source/playbooks/bootstrap.rst
@@ -0,0 +1,3 @@
+====================
+Playbook - bootstrap
+====================
diff --git a/docs/source/playbooks/ceph_client.rst b/docs/source/playbooks/ceph_client.rst
@@ -0,0 +1,3 @@
+======================
+Playbook - ceph_client
+======================
diff --git a/docs/source/playbooks/ceph_hci_pre.rst b/docs/source/playbooks/ceph_hci_pre.rst
@@ -0,0 +1,3 @@
+=======================
+Playbook - ceph_hci_pre
+=======================
diff --git a/docs/source/playbooks/configure_network.rst b/docs/source/playbooks/configure_network.rst
@@ -0,0 +1,3 @@
+============================
+Playbook - configure_network
+============================
diff --git a/docs/source/playbooks/configure_os.rst b/docs/source/playbooks/configure_os.rst
@@ -0,0 +1,3 @@
+=======================
+Playbook - configure_os
+=======================
diff --git a/docs/source/playbooks/configure_ovs_dpdk.rst b/docs/source/playbooks/configure_ovs_dpdk.rst
@@ -0,0 +1,3 @@
+=============================
+Playbook - configure_ovs_dpkg
+=============================
diff --git a/docs/source/playbooks/download_cache.rst b/docs/source/playbooks/download_cache.rst
@@ -0,0 +1,3 @@
+=========================
+Playbook - download_cache
+=========================
diff --git a/docs/source/playbooks/frr.rst b/docs/source/playbooks/frr.rst
@@ -0,0 +1,3 @@
+==============
+Playbook - frr
+==============
diff --git a/docs/source/playbooks/libvirt.rst b/docs/source/playbooks/libvirt.rst
@@ -0,0 +1,3 @@
+==================
+Playbook - libvirt
+==================
diff --git a/docs/source/playbooks/neutron_dhcp.rst b/docs/source/playbooks/neutron_dhcp.rst
@@ -0,0 +1,3 @@
+=======================
+Playbook - neutron_dhcp
+=======================
diff --git a/docs/source/playbooks/neutron_metadata.rst b/docs/source/playbooks/neutron_metadata.rst
@@ -0,0 +1,3 @@
+===========================
+Playbook - neutron_metadata
+===========================
diff --git a/docs/source/playbooks/neutron_ovn.rst b/docs/source/playbooks/neutron_ovn.rst
@@ -0,0 +1,3 @@
+======================
+Playbook - neutron_ovn
+======================
diff --git a/docs/source/playbooks/neutron_sriov.rst b/docs/source/playbooks/neutron_sriov.rst
@@ -0,0 +1,3 @@
+========================
+Playbook - neutron_sriov
+========================
diff --git a/docs/source/playbooks/nova.rst b/docs/source/playbooks/nova.rst
@@ -0,0 +1,3 @@
+===============
+Playbook - nova
+===============
diff --git a/docs/source/playbooks/ovn.rst b/docs/source/playbooks/ovn.rst
@@ -0,0 +1,3 @@
+==============
+Playbook - ovn
+==============
diff --git a/docs/source/playbooks/ovn_bgp_agent.rst b/docs/source/playbooks/ovn_bgp_agent.rst
@@ -0,0 +1,3 @@
+============================
+Playbook - install_bgp_agent
+============================
diff --git a/docs/source/playbooks/run_os.rst b/docs/source/playbooks/run_os.rst
@@ -0,0 +1,6 @@
+=================
+Playbook - run_os
+=================
+
+Starts ssh, time, nftables, cron, iscsid and multipathd services, using their respective roles.
+The :doc:`install_os` and :doc:`configure_os` are required prerequisites.
diff --git a/docs/source/playbooks/select_kernel_ddp_package.rst b/docs/source/playbooks/select_kernel_ddp_package.rst
@@ -0,0 +1,8 @@
+====================================
+Playbook - select_kernel_ddp_package
+====================================
+
+Installs ddp package using edpm_ddp_package role.
+
+The package must be specified before playbook execution using the `edpm_ddp_package` variable.
+Otherwise the default value "ddp" is used.
diff --git a/docs/source/playbooks/telemetry.rst b/docs/source/playbooks/telemetry.rst
@@ -0,0 +1,5 @@
+====================
+Playbook - telemetry
+====================
+
+Deploys Ceilometer and node_exporter telemetry using the edpm_telemetry role.
diff --git a/docs/source/playbooks/telemetry_logging.rst b/docs/source/playbooks/telemetry_logging.rst
@@ -0,0 +1,5 @@
+============================
+Playbook - telemetry_logging
+============================
+
+Enables telemetry logging via rsyslog, using the edpm_telemetry role.
diff --git a/docs/source/playbooks/validate_network.rst b/docs/source/playbooks/validate_network.rst
@@ -0,0 +1,5 @@
+===========================
+Playbook - validate_network
+===========================
+
+Uses edpm_nodes_validation role to ensure full network connectivity between them.
diff --git a/playbooks/bootstrap.yml b/playbooks/bootstrap.yml
@@ -12,6 +12,7 @@
         name: osp.edpm.edpm_growvols
       tags:
         - edpm_growvols
+    # Installs multiple packages, sets up selinux and openvswitch
     - name: Install edpm_bootstrap
       ansible.builtin.import_role:
         name: osp.edpm.edpm_bootstrap
@@ -27,6 +28,7 @@
         name: edpm_users
       tags:
         - edpm_users
+    # Install packages and set up modules, reboot as needed
     - name: Install edpm_kernel
       ansible.builtin.import_role:
         name: osp.edpm.edpm_kernel

diff --git a/playbooks/ceph_client.yml b/playbooks/ceph_client.yml
@@ -7,6 +7,7 @@
   any_errors_fatal: "{{ edpm_any_errors_fatal | default(true) }}"
   max_fail_percentage: "{{ edpm_max_fail_percentage | default(0) }}"
   tasks:
+    # Copy files from localhost, path specified in `edpm_ceph_client_files_source`
     - name: Configure EDPM as client of Ceph
       ansible.builtin.import_role:
         name: osp.edpm.edpm_ceph_client_files

diff --git a/playbooks/ceph_hci_pre.yml b/playbooks/ceph_hci_pre.yml
@@ -6,6 +6,7 @@
   any_errors_fatal: "{{ edpm_any_errors_fatal | default(true) }}"
   max_fail_percentage: "{{ edpm_max_fail_percentage | default(0) }}"
   tasks:
+    # Sets up firewall for ceph
     - name: Prepare EDPM to Host Ceph
       ansible.builtin.import_role:
         name: osp.edpm.edpm_ceph_hci_pre

diff --git a/playbooks/configure_network.yml b/playbooks/configure_network.yml
@@ -7,6 +7,7 @@
   any_errors_fatal: "{{ edpm_any_errors_fatal | default(true) }}"
   max_fail_percentage: "{{ edpm_max_fail_percentage | default(0) }}"
   tasks:
+    # Sets up network using OVS
     - name: Import edpm_network_config
       ansible.builtin.import_role:
         name: osp.edpm.edpm_network_config

diff --git a/playbooks/configure_os.yml b/playbooks/configure_os.yml
@@ -13,6 +13,7 @@
         tasks_from: configure.yml
       tags:
         - edpm_podman
+    # Configures systemd services including `edpm-container-shutdown`
     - name: Manage edpm container services
       ansible.builtin.import_role:
         name: osp.edpm.edpm_container_manage
@@ -31,6 +32,7 @@
         tasks_from: configure.yml
       tags:
         - edpm_sshd
+    # Restart time services on change
     - name: Configure edpm_timezone
       ansible.builtin.import_role:
         name: osp.edpm.edpm_timezone

diff --git a/playbooks/install_os.yml b/playbooks/install_os.yml
@@ -19,6 +19,9 @@
         tasks_from: install.yml
       tags:
         - edpm_sshd
+    # Depending on the environment we may have system roles under different name space
+    # However, code executed is the same. The difference is only
+    # in the mode of distribution.
     - name: Install and configure time service using timesync system role
       ansible.builtin.include_role:
         name: "{{ lookup('ansible.builtin.env', 'EDPM_SYSTEMROLES', default='fedora.linux_system_roles') + '.timesync' }}"

diff --git a/playbooks/telemetry.yml b/playbooks/telemetry.yml
@@ -21,6 +21,7 @@
   gather_facts: true
   any_errors_fatal: "{{ edpm_any_errors_fatal | default(true) }}"
   max_fail_percentage: "{{ edpm_max_fail_percentage | default(0) }}"
+  # Doesn't handle rsyslog
   tasks:
     - name: Deploy ceilometer
       ansible.builtin.import_role:

diff --git a/playbooks/telemetry_logging.yml b/playbooks/telemetry_logging.yml
@@ -20,6 +20,7 @@
   strategy: linear
   gather_facts: true
   any_errors_fatal: true
+  # Only enables rsyslog
   tasks:
     - name: Enable logging
       ansible.builtin.import_role:

diff --git a/playbooks/validate_network.yml b/playbooks/validate_network.yml
@@ -6,6 +6,7 @@
   any_errors_fatal: "{{ edpm_any_errors_fatal | default(true) }}"
   max_fail_percentage: "{{ edpm_max_fail_percentage | default(0) }}"
   tasks:
+    # Pings only IPv4
     - name: Import edpm_nodes_validation
       ansible.builtin.import_role:
         name: osp.edpm.edpm_nodes_validation