diff --git a/README.md b/README.md new file mode 100644 index 0000000..16f7d40 --- /dev/null +++ b/README.md @@ -0,0 +1,3 @@ +# Terraform Libvirt module + +There are some libvirt terarform modules diff --git a/build_docs.sh b/build_docs.sh deleted file mode 100755 index a23df22..0000000 --- a/build_docs.sh +++ /dev/null @@ -1,11 +0,0 @@ -#!/bin/bash - - -for i in $(ls -1 | grep -E "virt_|cloud_"); do - - echo terraform-docs markdown "$i > $i/README.md" - terraform-docs markdown "$i" > "$i/README.md" - -done - - diff --git a/gen_docs.sh b/gen_docs.sh new file mode 100755 index 0000000..060758e --- /dev/null +++ b/gen_docs.sh @@ -0,0 +1,63 @@ +#!/bin/bash +# + + +list_mods () +{ + for f in $(find modules/ -name '*.tf' ); do echo "${f%/*}"; done | sort | uniq +} + +gen_mod_doc () +{ + local dir=$1 + local mode=$2 + local dest=${dir}/REFERENCE.md + + terraform-docs --output-file "REFERENCE.md" ${mode//_/ } "$mod" +# terraform-docs ${mode//_/ } "$mod" > "$dest" + + +} + +move_reference_in_doc_dir () +{ + local doc_dir='docs' + + + for file in $(find modules -name REFERENCE.md); do + new_name=${file#modules/} + new_name=${new_name%/REFERENCE.md} + new_name=${new_name//\//__} + + + final_name=$doc_dir/$new_name.md + final_dir=$(dirname "$final_name") + + + if [[ ! -d "$final_dir" ]] ; then + mkdir -p "$final_dir" + fi + mv "$file" "$final_name" + done +} + +gen_docs () +{ + local modules=$(list_mods) + local fmt="yaml" + local fmt="pretty" + local fmt="markdown_document" + local fmt="markdown_table" + + for mod in $modules; do + mod=${mod#./} + echo "INFO: Generate documentation for: $mod" + gen_mod_doc "$mod" "$fmt" + done + move_reference_in_doc_dir + + echo "INFO: Done" +} + +gen_docs + diff --git a/cloud_project/main.tf b/modules/cloud_project/main.tf similarity index 100% rename from cloud_project/main.tf rename to modules/cloud_project/main.tf diff --git a/cloud_project/provider.tf b/modules/cloud_project/provider.tf similarity index 100% rename from cloud_project/provider.tf rename to modules/cloud_project/provider.tf diff --git a/iaas_inv_ansible/_OLD/example.inv.yml b/modules/iaas_inv_ansible/_OLD/example.inv.yml similarity index 100% rename from iaas_inv_ansible/_OLD/example.inv.yml rename to modules/iaas_inv_ansible/_OLD/example.inv.yml diff --git a/iaas_inv_ansible/_OLD/inventory.tmpl b/modules/iaas_inv_ansible/_OLD/inventory.tmpl similarity index 100% rename from iaas_inv_ansible/_OLD/inventory.tmpl rename to modules/iaas_inv_ansible/_OLD/inventory.tmpl diff --git a/iaas_inv_ansible/_OLD/main.tf b/modules/iaas_inv_ansible/_OLD/main.tf similarity index 100% rename from iaas_inv_ansible/_OLD/main.tf rename to modules/iaas_inv_ansible/_OLD/main.tf diff --git a/iaas_inv_ansible/_OLD/tpl_example.tpl b/modules/iaas_inv_ansible/_OLD/tpl_example.tpl similarity index 100% rename from iaas_inv_ansible/_OLD/tpl_example.tpl rename to modules/iaas_inv_ansible/_OLD/tpl_example.tpl diff --git a/iaas_inv_ansible/ansible_host/main.tf b/modules/iaas_inv_ansible/ansible_host/main.tf similarity index 100% rename from iaas_inv_ansible/ansible_host/main.tf rename to modules/iaas_inv_ansible/ansible_host/main.tf diff --git a/iaas_inv_ansible/ansible_host/provider.tf b/modules/iaas_inv_ansible/ansible_host/provider.tf similarity index 100% rename from iaas_inv_ansible/ansible_host/provider.tf rename to modules/iaas_inv_ansible/ansible_host/provider.tf diff --git a/iaas_inv_ansible/main.tf b/modules/iaas_inv_ansible/main.tf similarity index 100% rename from iaas_inv_ansible/main.tf rename to modules/iaas_inv_ansible/main.tf diff --git a/iaas_inv_ansible/provider.tf b/modules/iaas_inv_ansible/provider.tf similarity index 100% rename from iaas_inv_ansible/provider.tf rename to modules/iaas_inv_ansible/provider.tf diff --git a/virt_cloudinit/main.tf b/modules/virt_cloudinit/main.tf similarity index 100% rename from virt_cloudinit/main.tf rename to modules/virt_cloudinit/main.tf diff --git a/virt_cloudinit/provider.tf b/modules/virt_cloudinit/provider.tf similarity index 100% rename from virt_cloudinit/provider.tf rename to modules/virt_cloudinit/provider.tf diff --git a/virt_flavor/main.tf b/modules/virt_flavor/main.tf similarity index 100% rename from virt_flavor/main.tf rename to modules/virt_flavor/main.tf diff --git a/virt_flavor/provider.tf b/modules/virt_flavor/provider.tf similarity index 100% rename from virt_flavor/provider.tf rename to modules/virt_flavor/provider.tf diff --git a/virt_images/main.tf b/modules/virt_images/main.tf similarity index 100% rename from virt_images/main.tf rename to modules/virt_images/main.tf diff --git a/virt_images/provider.tf b/modules/virt_images/provider.tf similarity index 100% rename from virt_images/provider.tf rename to modules/virt_images/provider.tf diff --git a/virt_instance/main.tf b/modules/virt_instance/main.tf similarity index 100% rename from virt_instance/main.tf rename to modules/virt_instance/main.tf diff --git a/virt_instance/provider.tf b/modules/virt_instance/provider.tf similarity index 100% rename from virt_instance/provider.tf rename to modules/virt_instance/provider.tf diff --git a/virt_instances/main.tf b/modules/virt_instances/main.tf similarity index 100% rename from virt_instances/main.tf rename to modules/virt_instances/main.tf diff --git a/virt_instances/provider.tf b/modules/virt_instances/provider.tf similarity index 100% rename from virt_instances/provider.tf rename to modules/virt_instances/provider.tf diff --git a/virt_namespace/main.tf b/modules/virt_namespace/main.tf similarity index 100% rename from virt_namespace/main.tf rename to modules/virt_namespace/main.tf diff --git a/virt_namespace/provider.tf b/modules/virt_namespace/provider.tf similarity index 100% rename from virt_namespace/provider.tf rename to modules/virt_namespace/provider.tf diff --git a/virt_network/main.tf b/modules/virt_network/main.tf similarity index 100% rename from virt_network/main.tf rename to modules/virt_network/main.tf diff --git a/virt_network/provider.tf b/modules/virt_network/provider.tf similarity index 100% rename from virt_network/provider.tf rename to modules/virt_network/provider.tf diff --git a/virt_network/templates/ferm_nat.tpl b/modules/virt_network/templates/ferm_nat.tpl similarity index 100% rename from virt_network/templates/ferm_nat.tpl rename to modules/virt_network/templates/ferm_nat.tpl diff --git a/virt_network/templates/ipvs_config.tpl b/modules/virt_network/templates/ipvs_config.tpl similarity index 100% rename from virt_network/templates/ipvs_config.tpl rename to modules/virt_network/templates/ipvs_config.tpl diff --git a/virt_networks/main.tf b/modules/virt_networks/main.tf similarity index 100% rename from virt_networks/main.tf rename to modules/virt_networks/main.tf diff --git a/virt_networks/provider.tf b/modules/virt_networks/provider.tf similarity index 100% rename from virt_networks/provider.tf rename to modules/virt_networks/provider.tf diff --git a/virt_os/main.tf b/modules/virt_os/main.tf similarity index 100% rename from virt_os/main.tf rename to modules/virt_os/main.tf diff --git a/virt_os/provider.tf b/modules/virt_os/provider.tf similarity index 100% rename from virt_os/provider.tf rename to modules/virt_os/provider.tf diff --git a/virt_os/templates/cloud_debian_generic.yml b/modules/virt_os/templates/cloud_debian_generic.yml similarity index 100% rename from virt_os/templates/cloud_debian_generic.yml rename to modules/virt_os/templates/cloud_debian_generic.yml diff --git a/virt_pools/main.tf b/modules/virt_pools/main.tf similarity index 100% rename from virt_pools/main.tf rename to modules/virt_pools/main.tf diff --git a/virt_pools/provider.tf b/modules/virt_pools/provider.tf similarity index 100% rename from virt_pools/provider.tf rename to modules/virt_pools/provider.tf diff --git a/virt_volume/main.tf b/modules/virt_volume/main.tf similarity index 100% rename from virt_volume/main.tf rename to modules/virt_volume/main.tf diff --git a/virt_volume/provider.tf b/modules/virt_volume/provider.tf similarity index 100% rename from virt_volume/provider.tf rename to modules/virt_volume/provider.tf diff --git a/virt_volumes/main.tf b/modules/virt_volumes/main.tf similarity index 100% rename from virt_volumes/main.tf rename to modules/virt_volumes/main.tf diff --git a/virt_volumes/provider.tf b/modules/virt_volumes/provider.tf similarity index 100% rename from virt_volumes/provider.tf rename to modules/virt_volumes/provider.tf diff --git a/virt_volume/README.md b/virt_volume/README.md deleted file mode 100644 index 5f25ec8..0000000 --- a/virt_volume/README.md +++ /dev/null @@ -1,22 +0,0 @@ -# Virt Volume - -Create a single libvirt volume. - -This module helps to create a single volume. As dmarcvicar/terraform-libvirt does not support persistant volumes, the persistant volume support is quite limited. The only case where persistants volumes are supported is in the case of new volume creation, which in turn become idempotent and will be never destroyed ever. - -* Created: - * Desc: Created as new disk - * Ephemeral: True - * Persistant: True -* Backed: - * Desc: Backed image from source volume - * Ephemeral: True - * Persistant: False -* Sourced: - * Desc: Downloaded image from url - * Ephemeral: True - * Persistant: False - - - -