Deployed fec7df4 with MkDocs version: 1.5.3

Author: cartalla

config/index.html

@@ -191,6 +191,10 @@
             <li class="nav-item" data-level="4"><a href="#database" class="nav-link">Database</a>
               <ul class="nav flex-column">
               </ul>
+            </li>
+            <li class="nav-item" data-level="4"><a href="#slurmdbd" class="nav-link">Slurmdbd</a>
+              <ul class="nav flex-column">
+              </ul>
             </li>
               </ul>
             </li>
@@ -350,11 +354,16 @@ <h1 id="configuraton-file-format">Configuraton File Format</h1>
         <a href="#database">Database</a>:
             <a href="#databasestackname">DatabaseStackName</a>: str
             <a href="#fqdn">FQDN</a>: str
-            <a href="#port">Port</a>: str
+            <a href="#database-port">Port</a>: str
             <a href="#adminusername">AdminUserName</a>: str
             <a href="#adminpasswordsecretarn">AdminPasswordSecretArn</a>: str
-            <a href="#clientsecuritygroup">ClientSecurityGroup</a>:
+            <a href="#database-clientsecuritygroup">ClientSecurityGroup</a>:
                 SecurityGroupName: SecurityGroupId
+        <a href="#slurmdbd">Slurmdbd</a>:
+            <a href="#slurmdbdstackname">SlurmdbdStackName</a>: str
+            <a href="#slurmdbd-host">Host</a>: str
+            <a href="#slurmdbd-port">Port</a>: str
+            <a href="#slurmdbd-clientsecuritygroup">ClientSecurityGroup</a>: str
         <a href="https://docs.aws.amazon.com/parallelcluster/latest/ug/HeadNode-v3.html#HeadNode-v3-Dcv">Dcv:</a>
             <a href="https://docs.aws.amazon.com/parallelcluster/latest/ug/HeadNode-v3.html#yaml-HeadNode-Dcv-Enabled">Enabled</a>: bool
             <a href="https://docs.aws.amazon.com/parallelcluster/latest/ug/HeadNode-v3.html#yaml-HeadNode-Dcv-Port">Port</a>: int
@@ -548,11 +557,14 @@ <h4 id="enableefa">EnableEfa</h4>
 <p>See <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html#placement-groups-cluster">https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html#placement-groups-cluster</a></p>
 <h4 id="database">Database</h4>
 <p>Optional</p>
+<p><strong>Note</strong>: Starting with ParallelCluster 3.10.0, you should use slurm/ParallelClusterConfig/<a href="#slurmdbd">Slurmdbd</a> instead of slurm/ParallelClusterConfig/Database.
+You cannot have both parameters.</p>
 <p>Configure the Slurm database to use with the cluster.</p>
 <p>This is created independently of the cluster so that the same database can be used with multiple clusters.</p>
-<p>The easiest way to do this is to use the <a href="https://docs.aws.amazon.com/parallelcluster/latest/ug/tutorials_07_slurm-accounting-v3.html#slurm-accounting-db-stack-v3">CloudFormation template provided by ParallelCluster</a> and then to just pass
-the name of the stack in <a href="#databasestackname">DatabaseStackName</a>.
-All of the other parameters will be pulled from the stack.</p>
+<p>See <a href="../deployment-prerequisites#create-parallelcluster-slurm-database">Create ParallelCluster Slurm Database</a> on the deployment prerequisites page.</p>
+<p>If you used the <a href="https://docs.aws.amazon.com/parallelcluster/latest/ug/tutorials_07_slurm-accounting-v3.html#slurm-accounting-db-stack-v3">CloudFormation template provided by ParallelCluster</a>, then the easiest way to configure it is to pass
+the name of the stack in slurm/ParallelClusterConfig/Database/<a href="#databasestackname">DatabaseStackName</a>.
+All of the other parameters will be pulled from the outputs of the stack.</p>
 <p>See the <a href="https://docs.aws.amazon.com/parallelcluster/latest/ug/Scheduling-v3.html#Scheduling-v3-SlurmSettings-Database">ParallelCluster documentation</a>.</p>
 <h5 id="databasestackname">DatabaseStackName</h5>
 <p>Name of the ParallelCluster CloudFormation stack that created the database.</p>
@@ -566,7 +578,7 @@ <h5 id="databasestackname">DatabaseStackName</h5>
 </ul>
 <h5 id="fqdn">FQDN</h5>
 <p>Used with the Port to set the <a href="https://docs.aws.amazon.com/parallelcluster/latest/ug/Scheduling-v3.html#yaml-Scheduling-SlurmSettings-Database-Uri">Uri</a> of the database.</p>
-<h5 id="port">Port</h5>
+<h5 id="database-port">Database: Port</h5>
 <p>type: int</p>
 <p>Database's port.</p>
 <h5 id="adminusername">AdminUserName</h5>
@@ -578,9 +590,37 @@ <h5 id="adminpasswordsecretarn">AdminPasswordSecretArn</h5>
 <p>The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the AdminUserName plaintext password.
 This password is used together with AdminUserName and Slurm accounting to authenticate on the database server.</p>
 <p>Sets the <a href="https://docs.aws.amazon.com/parallelcluster/latest/ug/Scheduling-v3.html#yaml-Scheduling-SlurmSettings-Database-PasswordSecretArn">PasswordSecretArn</a> parameter in ParallelCluster.</p>
-<h5 id="clientsecuritygroup">ClientSecurityGroup</h5>
+<h5 id="database-clientsecuritygroup">Database: ClientSecurityGroup</h5>
 <p>Security group that has permissions to connect to the database.</p>
-<p>Required to be attached to the head node that is running slurmdbd so that the port connection to the database is allows.</p>
+<p>Required to be attached to the head node that is running slurmdbd so that the port connection to the database is allowed.</p>
+<h4 id="slurmdbd">Slurmdbd</h4>
+<p><strong>Note</strong>: This is not supported before ParallelCluster 3.10.0. If you specify this parameter then you cannot specify slurm/ParallelClusterConfig/<a href="#database">Database</a>.</p>
+<p>Optional</p>
+<p>Configure an external Slurmdbd instance to use with the cluster.
+The Slurmdbd instance provides access to the shared Slurm database.
+This is created independently of the cluster so that the same database can be used with multiple clusters.</p>
+<p>This is created independently of the cluster so that the same slurmdbd instance can be used with multiple clusters.</p>
+<p>See <a href="../deployment-prerequisites#create-slurmdbd-instance">Create Slurmdbd instance</a> on the deployment prerequisites page.</p>
+<p>If you used the <a href="https://docs.aws.amazon.com/parallelcluster/latest/ug/external-slurmdb-accounting.html#external-slurmdb-accounting-step1">CloudFormation template provided by ParallelCluster</a>, then the easiest way to configure it is to pass
+the name of the stack in slurm/ParallelClusterConfig/Database/<a href="#slurmdbdstackname">SlurmdbdStackName</a>.
+All of the other parameters will be pulled from the parameters and outputs of the stack.</p>
+<p>See the <a href="https://docs.aws.amazon.com/parallelcluster/latest/ug/Scheduling-v3.html#Scheduling-v3-SlurmSettings-ExternalSlurmdbd">ParallelCluster documentation for ExternalSlurmdbd</a>.</p>
+<h5 id="slurmdbdstackname">SlurmdbdStackName</h5>
+<p>Name of the ParallelCluster CloudFormation stack that created the Slurmdbd instance.</p>
+<p>The following parameters will be set using the outputs of the stack:</p>
+<ul>
+<li>Host</li>
+<li>Port</li>
+<li>ClientSecurityGroup</li>
+</ul>
+<h5 id="slurmdbd-host">Slurmdbd: Host</h5>
+<p>IP address or DNS name of the Slurmdbd instance.</p>
+<h5 id="slurmdbd-port">Slurmdbd: Port</h5>
+<p>Default: 6819</p>
+<p>Port used by the slurmdbd daemon on the Slurmdbd instance.</p>
+<h5 id="slurmdbd-clientsecuritygroup">Slurmdbd: ClientSecurityGroup</h5>
+<p>Security group that has access to use the Slurmdbd instance.
+This will be added as an extra security group to the head node.</p>
 <h3 id="clustername">ClusterName</h3>
 <p>Name of the ParallelCluster cluster.</p>
 <p>Default: If StackName ends with "-config" then ClusterName is StackName with "-config" stripped off.
@@ -590,6 +630,7 @@ <h3 id="mungekeysecret">MungeKeySecret</h3>
 For an existing secret can be the secret name or the ARN.
 If the secret doesn't exist one will be created, but won't be part of the cloudformation stack so that it won't be deleted when the stack is deleted.
 Required if your submitters need to use more than 1 cluster.</p>
+<p>See <a href="../deployment-prerequisites#create-munge-key">Create Munge Key</a> for more details.</p>
 <h3 id="slurmctl">SlurmCtl</h3>
 <p>Configure the Slurm head node or controller.</p>
 <p>Required, but can be an empty dict to accept all of the defaults.</p>
@@ -875,7 +916,7 @@ <h5 id="count">Count</h5>
 <h5 id="server">Server</h5>
 <p>The license server hosting the licenses.</p>
 <p>Not currently used.</p>
-<h5 id="port_1">Port</h5>
+<h5 id="port">Port</h5>
 <p>The port on the license server used to request licenses.</p>
 <p>Not currently used.</p>
 <h5 id="servertype">ServerType</h5>

deploy-parallel-cluster/index.html

@@ -114,14 +114,6 @@
               <ul class="nav flex-column">
             <li class="nav-item" data-level="2"><a href="#prerequisites" class="nav-link">Prerequisites</a>
               <ul class="nav flex-column">
-            <li class="nav-item" data-level="3"><a href="#create-parallelcluster-ui-optional-but-recommended" class="nav-link">Create ParallelCluster UI (optional but recommended)</a>
-              <ul class="nav flex-column">
-              </ul>
-            </li>
-            <li class="nav-item" data-level="3"><a href="#create-parallelcluster-slurm-database" class="nav-link">Create ParallelCluster Slurm Database</a>
-              <ul class="nav flex-column">
-              </ul>
-            </li>
               </ul>
             </li>
             <li class="nav-item" data-level="2"><a href="#create-the-cluster" class="nav-link">Create the Cluster</a>
@@ -163,19 +155,6 @@ <h1 id="deploy-aws-parallelcluster">Deploy AWS ParallelCluster</h1>
 The current latest version is 3.9.1.</p>
 <h2 id="prerequisites">Prerequisites</h2>
 <p>See <a href="../deployment-prerequisites/">Deployment Prerequisites</a> page.</p>
-<h3 id="create-parallelcluster-ui-optional-but-recommended">Create ParallelCluster UI (optional but recommended)</h3>
-<p>It is highly recommended to create a ParallelCluster UI to manage your ParallelCluster clusters.
-A different UI is required for each version of ParallelCluster that you are using.
-The versions are list in the <a href="https://docs.aws.amazon.com/parallelcluster/latest/ug/document_history.html">ParallelCluster Release Notes</a>.
-The minimum required version is 3.6.0 which adds support for RHEL 8 and increases the number of allows queues and compute resources.
-The suggested version is at least 3.7.0 because it adds configurable compute node weights which we use to prioritize the selection of
-compute nodes by their cost.</p>
-<p>The instructions are in the <a href="https://docs.aws.amazon.com/parallelcluster/latest/ug/install-pcui-v3.html">ParallelCluster User Guide</a>.</p>
-<h3 id="create-parallelcluster-slurm-database">Create ParallelCluster Slurm Database</h3>
-<p>The Slurm Database is required for configuring Slurm accounts, users, groups, and fair share scheduling.
-It you need these and other features then you will need to create a ParallelCluster Slurm Database.
-You do not need to create a new database for each cluster; multiple clusters can share the same database.
-Follow the directions in this <a href="https://docs.aws.amazon.com/parallelcluster/latest/ug/tutorials_07_slurm-accounting-v3.html#slurm-accounting-db-stack-v3">ParallelCluster tutorial to configure slurm accounting</a>.</p>
 <h2 id="create-the-cluster">Create the Cluster</h2>
 <p>To install the cluster run the install script. You can override some parameters in the config file
 with command line arguments, however it is better to specify all of the parameters in the config file.</p>