Setup Azimuth user metadata (#26)

* Setup Azimuth user metadata

* Update ui-meta documentation

* Update documentation

* Set generic user variables

* Use yes for sudo

* Remove Manila description

* Update usage template

roles/cluster_infra/templates/resources.tf.j2

@@ -125,6 +125,9 @@ locals {
     zenith_fqdn_monitoring = "{{ zenith_fqdn_monitoring }}"
     zenith_sshd_host = "{{ zenith_sshd_host }}"
     zenith_sshd_port = "{{ zenith_sshd_port }}"
+    azimuth_uid = "{{ cluster_user_uid | default('1005') }}"
+    azimuth_gid = "{{ cluster_user_gid | default('1005') }}"
+    azimuth_is_sudo = "{{ cluster_user_is_sudo | default('yes') }}"
     azimuth_cloud_name = "notused"
     azimuth_user_name = "${data.openstack_identity_auth_scope_v3.scope.user_name}"
     azimuth_user_id = "${data.openstack_identity_auth_scope_v3.scope.user_id}"
@@ -174,7 +177,7 @@ resource "openstack_compute_instance_v2" "cluster_server" {
     ssh_authorized_keys:
       - {{ cluster_deploy_ssh_public_key }}
 {% if cluster_user_ssh_public_key is defined and cluster_user_ssh_public_key %}
-  users:
+  azimuth_users:
   - name: azimuth
     ssh_authorized_keys:
       - {{ cluster_user_ssh_public_key }}

ui-meta/workstation-external-ssh-fast-volume-type.yml

@@ -68,15 +68,15 @@ usage_template: |-
   azimuth@{{ cluster.name }}-workstation:~$
   ```
 
-  The data volume is mounted at `/data`, and content stored there will persist for the lifetime
-  of the workstation.
-
-  If configured by the adminstrator, a project filesystem may be mounted at `/project`.
-  Content stored there will be available to all such configured workstations and Slurm
-  clusters, and will persist after deletion of workstations/clusters.
-
-  Other parts of the filesystem may be affected during a patch operation,
-  including any packages that have been installed using `apt`.
+  The home directory for the platform user - `/home/azimuth` - persists for the lifetime of the
+  platform. **Content stored in this directory will be lost when the platform is deleted, but will
+  be retained during a patch operation**. All system-level changes outside of this directory will
+  be lost on a patch, including any packages installed using `apt`.
+
+  If configured by your Azimuth administrator, a project filesystem may be mounted at `/project`.
+  This filesystem is shared between all platforms deployed in the tenancy with `/project` directory
+  support - see the individual platform documentation. **Content stored in this directory will be
+  available to all such platforms, and is retained even when a platform is deleted.*
 
   Monitoring dashboards for the workstation are available using the [Monitoring service]({{ monitoring.url }}).
 

ui-meta/workstation-external-ssh.yml

@@ -57,15 +57,15 @@ usage_template: |-
   azimuth@{{ cluster.name }}-workstation:~$
   ```
 
-  The data volume is mounted at `/data`, and content stored there will persist for the lifetime
-  of the workstation.
-
-  If configured by the adminstrator, a project filesystem may be mounted at `/project`.
-  Content stored there will be available to all such configured workstations and Slurm
-  clusters, and will persist after deletion of workstations/clusters.
-
-  Other parts of the filesystem may be affected during a patch operation,
-  including any packages that have been installed using `apt`.
+  The home directory for the platform user - `/home/azimuth` - persists for the lifetime of the
+  platform. **Content stored in this directory will be lost when the platform is deleted, but will
+  be retained during a patch operation**. All system-level changes outside of this directory will
+  be lost on a patch, including any packages installed using `apt`.
+
+  If configured by your Azimuth administrator, a project filesystem may be mounted at `/project`.
+  This filesystem is shared between all platforms deployed in the tenancy with `/project` directory
+  support - see the individual platform documentation. **Content stored in this directory will be
+  available to all such platforms, and is retained even when a platform is deleted.*
 
   Monitoring dashboards for the workstation are available using the [Monitoring service]({{ monitoring.url }}).
 

ui-meta/workstation-fast-volume-type.yml

@@ -53,15 +53,15 @@ usage_template: |-
   {% set monitoring = cluster | service("monitoring") %}
   This workstation can be accessed using a web browser via the [Web console service]({{ webconsole.url }}).
 
-  The data volume is mounted at `/data`, and content stored there will persist for the lifetime
-  of the workstation.
+  The home directory for the platform user - `/home/azimuth` - persists for the lifetime of the
+  platform. **Content stored in this directory will be lost when the platform is deleted, but will
+  be retained during a patch operation**. All system-level changes outside of this directory will
+  be lost on a patch, including any packages installed using `apt`.
 
-  If configured by the adminstrator, a project filesystem may be mounted at `/project`.
-  Content stored there will be available to all such configured workstations and Slurm
-  clusters, and will persist after deletion of workstations/clusters.
-
-  Other parts of the filesystem may be affected during a patch operation,
-  including any packages that have been installed using `apt`.
+  If configured by your Azimuth administrator, a project filesystem may be mounted at `/project`.
+  This filesystem is shared between all platforms deployed in the tenancy with `/project` directory
+  support - see the individual platform documentation. **Content stored in this directory will be
+  available to all such platforms, and is retained even when a platform is deleted.*
 
   Monitoring dashboards for the workstation are available using the [Monitoring service]({{ monitoring.url }}).
 

ui-meta/workstation.yml

@@ -41,15 +41,15 @@ usage_template: |-
   {% set monitoring = cluster | service("monitoring") %}
   This workstation can be accessed using a web browser via the [Web console service]({{ webconsole.url }}).
 
-  The data volume is mounted at `/data`, and content stored there will persist for the lifetime
-  of the workstation.
+  The home directory for the platform user - `/home/azimuth` - persists for the lifetime of the
+  platform. **Content stored in this directory will be lost when the platform is deleted, but will
+  be retained during a patch operation**. All system-level changes outside of this directory will
+  be lost on a patch, including any packages installed using `apt`.
 
-  If configured by the adminstrator, a project filesystem may be mounted at `/project`.
-  Content stored there will be available to all such configured workstations and Slurm
-  clusters, and will persist after deletion of workstations/clusters.
-
-  Other parts of the filesystem may be affected during a patch operation,
-  including any packages that have been installed using `apt`.
+  If configured by your Azimuth administrator, a project filesystem may be mounted at `/project`.
+  This filesystem is shared between all platforms deployed in the tenancy with `/project` directory
+  support - see the individual platform documentation. **Content stored in this directory will be
+  available to all such platforms, and is retained even when a platform is deleted.*
 
   Monitoring dashboards for the workstation are available using the [Monitoring service]({{ monitoring.url }}).