M:Arthur Documentation – Getting Started

Docs: How to Start Using M:Arthur

Mon, 01 Jan 0001 00:00:00 +0000

This is a brief explanation of the process of using M:Arthur.
M:Arthur uses an agent to submit jobs from the calendar.

Steps to Start Using M:Arthur

Please follow the steps below to prepare for use.

Please refer to the following for the environment in which M:Arthur is executed. Appendix: Assumed Settings

Please provide the following information to our staff
- Administrator’s email address
- Host name of login node

After the above, we will provide you with the information of the login node.

Please install the agent on the login node according to Appendix: Agent Installation Instructions .
- Please share the instance-id and hostname issued after installation with us

After your work in step 2 is complete, Morgenrot will perform the following main registration processes

Internal setup of the agent

Registration of the login node with M:Arthur

Creation of the administrator account

Log in from the following URL based on the account information notified by M:Arthur
- M:Arthur login URL: https://dashboard.m-arthur.com/login

Instructions after Starting to Use M:Arthur

Please follow the steps below to start using M:Arthur. For more information, please refer to User Guide for details.

Register Server Groups and Servers
After registration, the login server is registered. Please register compute nodes if necessary.
Register Users (Administrators and Users)
After registration, the administrator is registered. Please add users as needed.
Please enter the user name on the login server for each user in the alias field.
(The above refers to the User Guide/How to Operate the Administrator)
Register a Job
Execute the Job
View Job Execution Status
(The above refers to the User Guide/User Instructions )

Docs: Appendix: Agent Installation Instructions

Mon, 01 Jan 0001 00:00:00 +0000

Here are the steps to install the agent on the login node of M:Arthur.

1. Introduction

This procedure is for installing the agent used for M:Arthur in your environment.
This procedure is to be performed only on the login node (administrative node).

OpenPBS or Slurm must already be installed to perform this procedure.
For other prerequisites, please refer to Appendix: Assumed Settings.

Please install the agent by following the procedure from 2. below.
If you are using Proxy, please follow steps 2.~4. and then 5. after our work.

2. (Customer Work) Confirmation of Prior Information

After you provide us with the administrator’s email address and other information, our representative will send you the login node information. Please make sure you have the following information on hand. ID will be issued for each login server.

Information we will send you
- ActivationCode
- ActivationId

3. (Customer Work) Agent Installation

Please install the agent according to the procedure of 3.1.~3.2.

3.1. Agent Installation

(In the case of Ubuntu)

$ mkdir -p /tmp/ssm
$ curl https://s3.amazonaws.com/ec2-downloads-windows/SSMAgent/latest/debian_amd64/amazon-ssm-agent.deb -o /tmp/ssm/amazon-ssm-agent.deb
$ sudo dpkg -i /tmp/ssm/amazon-ssm-agent.deb

(In the case of AlmaLinux / Rocky Linux 8)

$ sudo dnf install -y https://s3.amazonaws.com/ec2-downloads-windows/SSMAgent/latest/linux_amd64/amazon-ssm-agent.rpm
$ sudo dnf install -y https://amazoncloudwatch-agent.s3.amazonaws.com/redhat/amd64/latest/amazon-cloudwatch-agent.rpm

Tips

If you are using a Proxy, please execute the following command to register the Proxy settings.

sudo systemctl edit amazon-ssm-agent

After executing the above command, please enter the following information: In the hostname, port section, please enter the information of your proxy. If your proxy does not support https, the https_proxy field should be http://. There is no need to change the no_proxy field.

[Service]
Environment="http_proxy=http://hostname:port"
Environment="https_proxy=https://hostname:port"
Environment="no_proxy=169.254.169.254"

3.2. amazon-ssm-agent activation

Execute the following command. Enter the information we have given you in the optional -code and -id fields.

$ sudo service amazon-ssm-agent stop
$ sudo service amazon-ssm-agent status ## Confirm stop
$ sudo -E amazon-ssm-agent -register -code "xxxxx" -id "xxxxx" -region "ap-northeast-1"
$ sudo service amazon-ssm-agent start
$ sudo service amazon-ssm-agent status ## Confirm startup

(Example of Execution Result)

After execution, please check if the service is started.

$ sudo service amazon-ssm-agent status
● amazon-ssm-agent.service - amazon-ssm-agent
 Loaded: loaded (/lib/systemd/system/amazon-ssm-agent.service; enabled; vendor preset: enabled)
 Active: active (running) since Mon 2024-04-01 05:40:58 UTC; 1 weeks 4 days ago

Please note the instance-id in the output result of running amazon-ssm-agent, mi-07767277e768bb6ca in the above sample.

When you have completed the above work, please provide the following information to Morgenrot.

We will contact you after our work is complete.

The instance-id (mi-xxxx) issued at the time of activation
Host name (contents of /etc/hostname)
Your preferred job scheduler (OpenPBS/Slurm)

5. (For Proxy Customers Only) Add Proxy Settings

Tips

If you are using a proxy, please remove the commented-out part in the following file and enter the proxy settings after our work.

File to be edited

/opt/aws/amazon-cloudwatch-agent/etc/common-config.toml

Before common-config.toml change (initial state)

## Configuration for proxy.
## System-wide environment-variable will be read if it is absent here.
## i.e. HTTP_PROXY/http_proxy; HTTPS_PROXY/https_proxy; NO_PROXY/no_proxy
## Note: system-wide environment-variable is not accessible when using ssm run-command.
## Absent in both here and environment-variable means no proxy will be used.
# [proxy]
# http_proxy = "{http_url}"
# https_proxy = "{https_url}"
# no_proxy = "{domain}"

After modifying common-config.toml

## Configuration for proxy.
## System-wide environment-variable will be read if it is absent here.
## i.e. HTTP_PROXY/http_proxy; HTTPS_PROXY/https_proxy; NO_PROXY/no_proxy
## Note: system-wide environment-variable is not accessible when using ssm run-command.
## Absent in both here and environment-variable means no proxy will be used.
[proxy]
http_proxy = "http://hostname:port"
https_proxy = "https://hostname:port"
no_proxy = "169.254.169.254"

After making the change, restart the service with the following command.

sudo systemctl restart amazon-cloudwatch-agent

This completes the installation process.
You can now begin operations in accordance with the User Guide.

Docs: Appendix: Assumed Settings

Mon, 01 Jan 0001 00:00:00 +0000

The following is a description of M:Arthur’s execution environment and the settings assumed when using each job scheduler.
M:Arthur supports OpenPBS and Slurm.

1. M:Arthur Execution Environment

Our confirmed environment is as follows.

CPU: x64-based processor
OS:
- Ubuntu 20.04
- Ubuntu 22.04
- Alma Linux 9
- Rocky Linux 8

Browser (client)

Windows OS:
- Edge(v123.0.2420.81 or higher)
- Chrome(v123.0.6312.106 or higher)
Mac OS:
- Chrome(v123.0.6312.87 or higher)

2. Job Scheduler Settings

The prerequisite job scheduler settings are as follows

2.1. OpenPBS

Install OpenPBS in the following directory
- /opt/pbs : OpenPBS main body
- /var/spool/pbs : Various logs
Enable Job History. qmgr -c "set server job_history_enable = True"

2.2. Slurm

M:Arthur monitors the following logs. When performing log rotation, etc., please use a file name according to the following rules
- /var/log/slurmctld.log*
Please enable the Slurmdbd service

M:Arthur Documentation – Getting Started

Docs: How to Start Using M:Arthur

Steps to Start Using M:Arthur

Instructions after Starting to Use M:Arthur

Docs: Appendix: Agent Installation Instructions

1. Introduction

2. (Customer Work) Confirmation of Prior Information

3. (Customer Work) Agent Installation

3.1. Agent Installation

Tips

3.2. amazon-ssm-agent activation

4. (Customer Work) Share Your Registration Information with Us

5. (For Proxy Customers Only) Add Proxy Settings

Tips

Docs: Appendix: Assumed Settings

1. M:Arthur Execution Environment

Login node

Browser (client)

2. Job Scheduler Settings

2.1. OpenPBS

2.2. Slurm