Merge pull request #117 from nocturnalastro/add_cucible_roles_to_readme

Add crucible roles to README
redhatci · Jan 10, 2024 · bcb1477 · bcb1477
2 parents 6fba174 + 58581e4
commit bcb1477
Show file tree

Hide file tree

Showing 45 changed files with 188 additions and 46 deletions.
diff --git a/README.md b/README.md
diff --git a/roles/add_day2_node/README.md b/roles/add_day2_node/README.md
@@ -1 +1,3 @@
-# add_day2_node
+# add_day2_node
+
+Adds as nodes to a pre-existing cluster using a pre-existing on-prem assisted installer instance.
diff --git a/roles/apply_nmstate/README.md b/roles/apply_nmstate/README.md
@@ -1 +1,11 @@
-# apply_nmstate
+# apply_nmstate
+
+Applies nmstate network configuration to a host.
+
+## Variables
+
+| Variable                 | Default  | Required             | Description                        |
+| ------------------------ | -------- | -------------------- | ---------------------------------- |
+| rendered_nmstate_yml     | -        | Yes                  | The nmstate to apply               |
+| vm_nmstate_config_path   | -        | Yes                  | The path to place the nmstate file |
+| vm_network_test_ip       | -        | Depends on the host  | An IP to check outbound connectivity post application. This is required host is the ansible control node. |
diff --git a/roles/approve_csrs/README.md b/roles/approve_csrs/README.md
@@ -1 +1,3 @@
-# approve_csrs
+# approve_csrs
+
+Checks for Cert Signing Requests in the pending state and approves them until nodes in the day2_workers group are present in the oc nodes output.
diff --git a/roles/boot_disk/README.md b/roles/boot_disk/README.md
@@ -1 +1,3 @@
-# boot_disk
+# boot_disk
+
+Reboots nodes to the disk based on its vendor. 
diff --git a/roles/boot_iso/README.md b/roles/boot_iso/README.md
@@ -1 +1,3 @@
-# boot_iso
+# boot_iso
+
+Boots nodes to the provided iso on its vendor.
diff --git a/roles/create_cluster/README.md b/roles/create_cluster/README.md
@@ -1 +1,3 @@
-# create_cluster
+# create_cluster
+
+Creates a cluster definition in an on-prem assisted installer instance.
diff --git a/roles/create_day2_cluster/README.md b/roles/create_day2_cluster/README.md
@@ -1 +1,3 @@
-# create_day2_cluster
+# create_day2_cluster
+
+Creates an add-hosts cluster definition in an on-prem assisted installer instance which can be used to add day2 nodes to the cluster
diff --git a/roles/create_vms/README.md b/roles/create_vms/README.md
@@ -1 +1,3 @@
-# create_vms
+# create_vms
+
+Provisions libvirt network, storage pools and the KVM Nodes.
diff --git a/roles/destroy_vms/README.md b/roles/destroy_vms/README.md
@@ -1 +1,3 @@
-# destroy_vms
+# destroy_vms
+
+Destroys libvirt network, storage pools and the KVM Nodes and the network bridge connection.
diff --git a/roles/display_deployment_plan/README.md b/roles/display_deployment_plan/README.md
@@ -1 +1,3 @@
-# display_deployment_plan
+# display_deployment_plan
+
+Displays the crucible deployment plan and waits for user confirmation.
diff --git a/roles/extract_openshift_installer/README.md b/roles/extract_openshift_installer/README.md
@@ -1 +1,3 @@
-# extract_openshift_installer
+# extract_openshift_installer
+
+Extracts openshift_installer binary from the release image.
diff --git a/roles/generate_agent_iso/README.md b/roles/generate_agent_iso/README.md
@@ -1 +1,3 @@
-# generate_agent_iso
+# generate_agent_iso
+
+Creates the boot iso using openshift_installer's agent subcommand
diff --git a/roles/generate_discovery_iso/README.md b/roles/generate_discovery_iso/README.md
@@ -1 +1,3 @@
-# generate_discovery_iso
+# generate_discovery_iso
+
+Creates the discovery iso for a pre-existing cluster definition using a pre-existing on-prem assisted installer
diff --git a/roles/generate_manifests/README.md b/roles/generate_manifests/README.md
@@ -1 +1,3 @@
-# generate_manifests
+# generate_manifests
+
+Generates the manifests required for openshift_installer's agent subcommand
diff --git a/roles/generate_ssh_key_pair/README.md b/roles/generate_ssh_key_pair/README.md
@@ -1 +1,3 @@
-# generate_ssh_key_pair
+# generate_ssh_key_pair
+
+Generates an ssh key pair
diff --git a/roles/install_cluster/README.md b/roles/install_cluster/README.md
@@ -1 +1,3 @@
-# install_cluster
+# install_cluster
+
+ Waits for nodes to be discovered by the on-prem assisted installer then then patches cluster networkings and triggeres the install process
diff --git a/roles/monitor_agent_based_installer/README.md b/roles/monitor_agent_based_installer/README.md
@@ -1 +1,3 @@
-# monitor_agent_based_installer
+# monitor_agent_based_installer
+
+Tracks the progress of the agent based installation via openshift_installer
diff --git a/roles/monitor_cluster/README.md b/roles/monitor_cluster/README.md
@@ -1 +1,3 @@
-# monitor_cluster
+# monitor_cluster
+
+Tracks the progress of the cluster installation via an on-prem assisted installer
diff --git a/roles/monitor_host/README.md b/roles/monitor_host/README.md
@@ -1 +1,3 @@
-# monitor_host
+# monitor_host
+
+Tracks host status dusing the installation via an on-prem assisted installer and triggers a reboot to disk if needed
diff --git a/roles/mount_discovery_iso_for_pxe/README.md b/roles/mount_discovery_iso_for_pxe/README.md
@@ -1 +1,3 @@
-# mount_discovery_iso_for_pxe
+# mount_discovery_iso_for_pxe
+
+Extracts the required artifacts for a pxe boot from a discovery iso
diff --git a/roles/patch_cluster/README.md b/roles/patch_cluster/README.md
@@ -1 +1,5 @@
-# patch_cluster
+# patch_cluster
+
+Patches definition of a cluster in an on-prem assisted installer.
+
+Configures network type, image source redirects for disconnected deployments and adds custom manifests.
diff --git a/roles/patch_host_config/README.md b/roles/patch_host_config/README.md
@@ -1 +1,3 @@
-# patch_host_config
+# patch_host_config
+
+Patches host definition in pre-existing on-prem assisted installer
diff --git a/roles/populate_mirror_registry/README.md b/roles/populate_mirror_registry/README.md
@@ -1 +1,3 @@
-# populate_mirror_registry
+# populate_mirror_registry
+
+Copies the images required for installation to a local registry
diff --git a/roles/post_install/README.md b/roles/post_install/README.md
@@ -1 +1,3 @@
-# post_install
+# post_install
+
+Waits for the cluster to become operational then copies the kubeconfig and kubeadmin
diff --git a/roles/process_kvm_nodes/README.md b/roles/process_kvm_nodes/README.md
@@ -1 +1,3 @@
-# process_kvm_nodes
+# process_kvm_nodes
+
+Creates and distributes kvm node specifications to vm hosts
diff --git a/roles/process_kvm_nodes/tasks/create_node.yml b/roles/process_kvm_nodes/tasks/create_node.yml
@@ -1,6 +1,6 @@
 - name: Set spec and role
   set_fact:
-    kvm_node_spec:  "{{ hostvars[kvm_node_hostname]['vm_spec'] | default({}) }}"
+    kvm_node_spec: "{{ hostvars[kvm_node_hostname]['vm_spec'] | default({}) }}"
     kvm_node_defaults: "{{ vm_group_params[hostvars[kvm_node_hostname]['role']] }}"
 
 - name: Set default main disk
@@ -31,7 +31,7 @@
     kvm_node:
       name: "{{ kvm_node_hostname.startswith(vm_node_prefix) | ternary(kvm_node_hostname, (vm_node_prefix + kvm_node_hostname)) }}"
       uuid: "{{ hostvars[kvm_node_hostname]['uuid'] | default('') }}"
-      mac:  "{{ vm_mac }}"
+      mac: "{{ vm_mac }}"
       vm_host: "{{ vm_hostname }}"
       memory: "{{ kvm_node_spec['ram_mib'] | default(kvm_node_defaults['memory']) }}"
       vcpu: "{{ kvm_node_spec['cpu_cores'] | default(kvm_node_defaults['vcpu']) }}"

diff --git a/roles/process_nmstate/README.md b/roles/process_nmstate/README.md
@@ -1 +1,3 @@
-# process_nmstate
+# process_nmstate
+
+Renders nmstate from crucible network_config
diff --git a/roles/setup_assisted_installer/README.md b/roles/setup_assisted_installer/README.md
@@ -1 +1,3 @@
-# setup_assisted_installer
+# setup_assisted_installer
+
+Deploys an on-prem assisted installer
diff --git a/roles/setup_mirror_registry/README.md b/roles/setup_mirror_registry/README.md
@@ -1 +1,3 @@
-# setup_mirror_registry
+# setup_mirror_registry
+
+Deploys a local container registry
diff --git a/roles/setup_ntp/README.md b/roles/setup_ntp/README.md
@@ -1 +1,3 @@
-# setup_ntp
+# setup_ntp
+
+Deploys chrony
diff --git a/roles/setup_selfsigned_cert/README.md b/roles/setup_selfsigned_cert/README.md
@@ -1 +1,3 @@
-# setup_selfsigned_cert
+# setup_selfsigned_cert
+
+Generates self signed SSL certs
diff --git a/roles/setup_sushy_tools/README.md b/roles/setup_sushy_tools/README.md
@@ -1 +1,3 @@
-# setup_sushy_tools
+# setup_sushy_tools
+
+deploys virtual redfish for kvm
diff --git a/roles/setup_tftp/README.md b/roles/setup_tftp/README.md
@@ -1 +1,3 @@
-# setup_tftp
+# setup_tftp
+
+Deploys a TFTP server
diff --git a/roles/setup_vm_host_network/README.md b/roles/setup_vm_host_network/README.md
@@ -1 +1,3 @@
-# setup_vm_host_network
+# setup_vm_host_network
+
+Configures the network for vm hosts
diff --git a/roles/validate_dns_records/README.md b/roles/validate_dns_records/README.md
@@ -1 +1,3 @@
-# validate_dns_records
+# validate_dns_records
+
+Checks for the required dns entries for ingress and api VIPs
diff --git a/roles/validate_http_store/README.md b/roles/validate_http_store/README.md
@@ -1 +1,3 @@
-# validate_http_store
+# validate_http_store
+
+Checks via a round trip that http store is functional
diff --git a/roles/validate_inventory/README.md b/roles/validate_inventory/README.md
@@ -1 +1,3 @@
-# validate_inventory
+# validate_inventory
+
+Validates a crucible inventory
diff --git a/roles/vendors/dell/README.md b/roles/vendors/dell/README.md
@@ -1 +1,3 @@
-# dell
+# dell
+
+Boots a dell iDRAC machine to iso or disk via redfish
diff --git a/roles/vendors/hpe/README.md b/roles/vendors/hpe/README.md
@@ -1 +1,3 @@
-# hpe
+# hpe
+
+Boots a hpe ilo machine to iso or disk via redfish
diff --git a/roles/vendors/kvm/README.md b/roles/vendors/kvm/README.md
@@ -1 +1,3 @@
-# kvm
+# kvm
+
+Boots a vm to iso or disk via redfish (sushy tools)
diff --git a/roles/vendors/lenovo/README.md b/roles/vendors/lenovo/README.md
@@ -1 +1,3 @@
-# lenovo
+# lenovo
+
+Boots a lenovo machine to iso or disk via redfish
diff --git a/roles/vendors/pxe/README.md b/roles/vendors/pxe/README.md
@@ -1 +1,3 @@
-# pxe
+# pxe
+
+Boots a machine to pxe or disk via ipmi
diff --git a/roles/vendors/supermicro/README.md b/roles/vendors/supermicro/README.md
@@ -1 +1,3 @@
-# supermicro
+# supermicro
+
+Boots a supermicro machine to iso or disk via redfish
diff --git a/roles/vendors/zt/README.md b/roles/vendors/zt/README.md
@@ -1 +1,3 @@
-# zt
+# zt
+
+Boots a zt machine to iso or disk via redfish