From 737d5b2255c2a4235db53d17b8e35015259e83fb Mon Sep 17 00:00:00 2001 From: Jake Hutchinson <39007539+assumptionsandg@users.noreply.github.com> Date: Wed, 13 Nov 2024 10:10:10 +0000 Subject: [PATCH] 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 | 5 ++++- ...rkstation-external-ssh-fast-volume-type.yml | 18 +++++++++--------- ui-meta/workstation-external-ssh.yml | 18 +++++++++--------- ui-meta/workstation-fast-volume-type.yml | 16 ++++++++-------- ui-meta/workstation.yml | 16 ++++++++-------- 5 files changed, 38 insertions(+), 35 deletions(-) diff --git a/roles/cluster_infra/templates/resources.tf.j2 b/roles/cluster_infra/templates/resources.tf.j2 index 312a3ea..e474f43 100644 --- a/roles/cluster_infra/templates/resources.tf.j2 +++ b/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 }} diff --git a/ui-meta/workstation-external-ssh-fast-volume-type.yml b/ui-meta/workstation-external-ssh-fast-volume-type.yml index 66b6924..f66d37e 100644 --- a/ui-meta/workstation-external-ssh-fast-volume-type.yml +++ b/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 }}). diff --git a/ui-meta/workstation-external-ssh.yml b/ui-meta/workstation-external-ssh.yml index b5769ca..5458851 100644 --- a/ui-meta/workstation-external-ssh.yml +++ b/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 }}). diff --git a/ui-meta/workstation-fast-volume-type.yml b/ui-meta/workstation-fast-volume-type.yml index 8582e9e..be1b741 100644 --- a/ui-meta/workstation-fast-volume-type.yml +++ b/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 }}). diff --git a/ui-meta/workstation.yml b/ui-meta/workstation.yml index 69853af..8a54526 100644 --- a/ui-meta/workstation.yml +++ b/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 }}).