Variables documentation

[stoeps13]

Thanks for the new documentation about the used variables.

It looks like the last lines are duplicates, or not sorted into the right topic:

connections-automation/documentation/VARIABLES.md

Lines 360 to 393 in 42b7ad0

	persistentVolumePath | pv-connections | Persistent volume location to be created
	helm_install_dir | /opt/helm | Helm install directory
	ansible_cache | /tmp/k8s_ansible | Ansible cache location
	kube_dir | /root/.kube | Kubernetes directory path
	docker_registry_dir | /etc/docker/registry | Docker registry directory path
	kubernetes_etc_dir | /etc/kubernetes | Kubernetes directory path
	etcd_dir | /var/lib/etcd | etcd directory
	db2_instance_fenced_homedir | /home/db2fenc1 | Fenced user home directory
	db2_instance_homedir | /home/db2inst1 | DB2 Instance owner home directory
	db_installation_folder_dir | /opt/IBM/db2 | DB2 installation directory
	ihs_install_location | /opt/IBM/HTTPServer | IHS installation directory
	iim_install_location | /opt/IBM/InstallationManager | IIM program folder
	var_ibm_base_location | /var/ibm | var IBM base location
	websphere_base_location | /opt/IBM/WebSphere | Websphere base location
	imshared_location | /opt/IBM/IMShared | IIM config folder
	ora_rsp_oracle_base | /opt/oracle | Oracle database base location
	oraclfmap_oracle_base | /opt/ORCLfmap | Oracle database ORCLfmap location
	oracltab_oracle_base | /etc/oratab | Oracle database oracltab base location
	orainst_oracle_base | /etc/oraInst.loc | Oracle database orainst base location
	oracle_temp | /tmp/.oracle | Oracle temp folder path
	nfs_master_source | /pv-connections | Persistent volume location to be deleted
	cnx_message_store | /opt/HCL/MessageStore | Connections bus SIB location mount point
	cnx_message_store_nfs | /nfs/data/messageStores | Connections bus SIB NFS share
	cnx_shared_area | /opt/IBM/SharedArea | Connections shared data location mount point
	cnx_shared_area_nfs | /nfs/data/shared | Connections shared data NFS share
	customizer_js_files_mount | /mnt/customizations | Customization files mount point folder in Component Pack
	viewer_data_local_path | /mnt/viewer_data | path of local location to Docs Viewer data dir, if {{ viewer_shared_storage_type }} is nfs, {{ viewer_data_remote_path }} will mount to this directory
	viewer_data_remote_path | /nfs/viewer_data | NFS share of Docs Viewer data dir, {{ viewer_shared_storage_type }} must be nfs to use it
	docs_data_remote_path | /nfs/docs_data | NFS share of Docs data dir, {{ docs_shared_storage_type }} must be nfs to use it
	docs_data_local_path | /mnt/docs_data | path of local location to Docs data dir, if {{ docs_shared_storage_type }} is nfs, {{ docs_data_remote_path }} will mount to this directory
	cnx_data_remote_path | /nfs/data/shared | NFS share of Connections data dir, {{ cnx_shared_storage_type }} must be nfs to use it
	cnx_data_local_path | /mnt/cnx_data | path of local location to Connections data dir, if {{ cnx_shared_storage_type }} is nfs, {{ cnx_data_remote_path }} will mount to this directory
	nfs_master_files_mount | /mnt/pv-connections | Persistent volume mount point folder in Component Pack
	cnx_install_base_dir | /opt/HCL/ | Base directory of connections installation

Regards
Christoph

[nitinjagjivan]

Hi @stoeps13,
Highlighted variables are needed in the 'cleanup variables' section as we are using it while running cleanup playbooks.

For e.g. db2_instance_fenced_homedir
This variable is used while running 'playbooks/hcl/cleanup/cleanup-db2.yml' playbook. We need this path to understand what is the fenced user home directory. So that this path can be used to clean up IBM db2 as a part of db2 cleanup job.
You can see this variable listed in 'DB2 Variables' section as well as it is used while installing IBM DB2. We need to duplicate it as it will be handy for the users who just want to run cleanup job.

[stoeps13]

Thanks @nitinjagjivan for the heads up,
I don't like the idea to edit the variables file to uninstall and then switch it back. I do similar operations with the usage of tags. So calling ansible-playbook --tags uninstall is uninstalling and tags=install is set to default. Then the variables file can stay the same.
I would only document the variables which are necessary for uninstallation, in my workflow I would install first, then add the 4 or 5 uninstall vars and uninstall. So reading about more variables (which should be set earlier for installation) can be overwhelming and lead to errors.
If you install without setting these variables, they use the defaults. If not you have already set them.

[nitinjagjivan]

Thanks for the suggestion. Our team will think about this approach and will decide considering all other priority items.