From c77ef62962fc65c6f5e3bd9ceaffed44e3667e5a Mon Sep 17 00:00:00 2001 From: XaverStiensmeier Date: Thu, 25 Apr 2024 15:09:34 +0200 Subject: [PATCH] added documentation for other configurations --- .../markdown/bibigrid_feature_list.md | 5 +++-- .../markdown/features/other_configurations.md | 22 +++++++++++++++++++ 2 files changed, 25 insertions(+), 2 deletions(-) create mode 100644 documentation/markdown/features/other_configurations.md diff --git a/documentation/markdown/bibigrid_feature_list.md b/documentation/markdown/bibigrid_feature_list.md index 0ddecab2..96d828d1 100644 --- a/documentation/markdown/bibigrid_feature_list.md +++ b/documentation/markdown/bibigrid_feature_list.md @@ -5,14 +5,15 @@ | [Version](features/version.md) | Returns BiBiGrid's version for opening issues and the like | | [Terminate Cluster](features/terminate_cluster.md) | Terminates the cluster specified by cluster-id i.e. removes key, application credentials, servers and floating-ips. | | [Create](features/create.md) | Creates the cluster specified by the configuration. | - | [List Clusters](features/list_clusters.md) | Shows info of all clusters if no cluster-id is specified. Otherwise the cluster-id's cluster will be shown in great detail. | +| [List Clusters](features/list_clusters.md) | Shows info of all clusters if no cluster-id is specified. Otherwise the cluster-id's cluster will be shown in great detail. | | [Check](features/check.md) | Checks if given configuration is valid and necessary security measures are taken. | | [Web IDE](features/ide.md) | Connects to running IDE of cluster-id's cluster. Requires that given cluster was setup with an ide. | | [Update](features/update.md) | Updates the master's playbook and runs that playbook for the master. Requires that no job is running and no workers up. | | [Cloud Specification Data](features/cloud_specification_data.md) | Contains necessary data to establish a general connection to the provider. | - | [Configuration](features/configuration.md) | Contains all data regarding cluster setup for all providers. | +| [Configuration](features/configuration.md) | Contains all data regarding cluster setup for all providers. | | [Command Line Interface](features/CLI.md) | What command line arguments can be passed into BiBiGrid. | | [Multi Cloud](features/multi_cloud.md) | Explanation how BiBiGrid's multi-cloud approach works | | [BiBiGrid Cluster Commands](features/cluster_commands.md) | Short useful commands to get information on the cluster | +| [Other Configurations](features/other_configurations.md) | Info about custom `ansible.cfg` and `slurm.conf` | ![](../images/actions.jpg) \ No newline at end of file diff --git a/documentation/markdown/features/other_configurations.md b/documentation/markdown/features/other_configurations.md new file mode 100644 index 00000000..0a92faa9 --- /dev/null +++ b/documentation/markdown/features/other_configurations.md @@ -0,0 +1,22 @@ +# Other Configurations +Besides the general BiBiGrid configuration there is also an `ansible.cfg` and a `slurm.conf`. +For 99% of all users those never need to be touched. However, some use cases require changes to those configurations. +For that purpose we store defaults in `resources/defaults` and on the first run copy copies to the actual locations +`resources/playbook/ansible.cfg` and `resources/playbook/bibigrid/templates/slurm/slurm.j2`. +That way you can make changes and if something doesn't work, you can just delete the configuration to go back to our +default one. + +## slurm.cfg +The `slurm.j2` is not a static configuration file, but instead a [jinja](https://jinja.palletsprojects.com/en/3.1.x/) template for the actual configuration that is +generated during runtime. That is necessary because it contains the actual instance names that are only known at runtime. +The jinja template is converted to the actual configuration by ansible in the `042-slurm.yml` task. + +The `slurm.j2` also takes certain information from your BiBiGrid configuration (see [slurmConf](configuration.md#slurmconf-optional)). + +Read more about the `slurm.conf` [here](https://slurm.schedmd.com/slurm.conf.html). + +## ansible.cfg +The `ansible.cfg` defines how ansible behaves during runtime. A key that sometimes need to be adapted is `timeout` which +is the timeout for the connection plugin. If your host answers very slowly, a low timeout might cause issues. + +Read more about the `ansible.cfg` [here](https://docs.ansible.com/ansible/latest/reference_appendices/config.html). \ No newline at end of file