{"type":"doc","content":[{"type":"paragraph","content":[{"text":"Platform's CLI (command-line interface) is installed by default on the Platform server and supports common administrative tasks.","type":"text"}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"maxLevel":{"value":"2"}},"macroMetadata":{"macroId":{"value":"a83dd169-fa8d-4b4b-aa0c-68ac58d6c6dd"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"b30d29b9-f1f9-4a07-8a50-5979cc2732d1"}},{"type":"heading","attrs":{"level":2},"content":[{"text":"Rebooting a Cluster","type":"text"}]},{"type":"paragraph","content":[{"text":"There are two CLI options for rebooting a cluster: ","type":"text"},{"text":"full","type":"text","marks":[{"type":"em"}]},{"text":" versus ","type":"text"},{"text":"rolling","type":"text","marks":[{"type":"em"}]},{"text":".","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Full reboot","type":"text","marks":[{"type":"strong"}]},{"text":" notifies every chassis in the cluster to reboot itself ","type":"text"},{"text":"at the same time","type":"text","marks":[{"type":"em"}]},{"text":". The entire cluster is temporarily offline as the chassis reboot.","type":"text"}]},{"type":"paragraph","content":[{"text":"Full reboot","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"platform restart storagecluster --full","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Rolling reboot","type":"text","marks":[{"type":"strong"}]},{"text":" is a long-running process that keeps the cluster operational by rebooting the cluster one chassis at a time, until the entire cluster is rebooted. A rolling reboot includes several options, such as to limit the reboot to one or more chassis:","type":"text"}]},{"type":"paragraph","content":[{"text":"Rolling reboot","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"platform restart storagecluster --rolling \t\n\t[--chassis ]\n\t[--skipConnectionTest]\n\t[--skipUptimeTest]\n\t[--continueWithOfflineChassis]\n\t[--stopOnNodeError]","type":"text"}]}]}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Requirements","type":"text"}]},{"type":"paragraph","content":[{"text":"Before a rolling reboot can begin, these conditions must be met:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"All chassis targeted for rebooting must be running and reachable. If chassis are offline, set a flag to have them ignored:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"To skip the connection check altogether, add the flag ","type":"text"},{"text":"--skipConnectionTest","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"To have the reboot process ignore currently offline chassis, add the flag ","type":"text"},{"text":"--continueWithOfflineChassis","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"All chassis must have an uptime greater than 30 minutes. To skip this requirement, add the flag ","type":"text"},{"text":"--skipUptimeTest","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Managing Rolling Reboots","type":"text"}]},{"type":"paragraph","content":[{"text":"10 seconds are allotted to cancel a rolling reboot before it begins. Once a rolling reboot has started, it stops and reports an error the following occur:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"A chassis is offline when it is selected for reboot. To have the reboot process ignore currently offline chassis, add the flag ","type":"text"},{"text":"--continueWithOfflineChassis","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The reboot process continues if the volumes come up but a node goes into an error state. To have the reboot process stop, add the flag ","type":"text"},{"text":"--stopOnNodeError","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If the chassis boots with a number of volumes that does not match the number present before the chassis was rebooted. A volume is considered up if it has a state of: ","type":"text"},{"text":"ok","type":"text","marks":[{"type":"em"}]},{"text":", ","type":"text"},{"text":"retiring","type":"text","marks":[{"type":"em"}]},{"text":", ","type":"text"},{"text":"retired","type":"text","marks":[{"type":"em"}]},{"text":", or ","type":"text"},{"text":"unavailable","type":"text","marks":[{"type":"em"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The chassis does not come back online after 3 hours has passed.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"If a rolling reboot has stopped due to an error, resume the reboot using the ","type":"text"},{"text":"resume","type":"text","marks":[{"type":"code"}]},{"text":" command below after the error is resolved .","type":"text"}]},{"type":"paragraph","content":[{"text":"Status check ","type":"text","marks":[{"type":"strong"}]},{"text":"— To retrieve the status of a rolling reboot task, use the following commands for reboots remaining and reboots completed:","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Rolling reboots remaining","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"platform status rollingreboot","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Rolling reboots completed","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"platform status rollingreboot --completed","type":"text"}]},{"type":"paragraph","content":[{"text":"Global states","type":"text","marks":[{"type":"strong"}]},{"text":" — When viewing the status for a rolling reboot, a rolling reboot task can have the following global states:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"in-progress","type":"text","marks":[{"type":"strong"}]},{"text":": The rolling reboot is currently running.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"paused","type":"text","marks":[{"type":"strong"}]},{"text":": The rolling reboot is paused (using the ","type":"text"},{"text":"pause","type":"text","marks":[{"type":"code"}]},{"text":" command).","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"completed","type":"text","marks":[{"type":"strong"}]},{"text":": The rolling reboot finished successfully.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"cancelled","type":"text","marks":[{"type":"strong"}]},{"text":": The rolling reboot was caused per a user request.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"error","type":"text","marks":[{"type":"strong"}]},{"text":": The reboot is stopped due to an error of some kind.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Chassis states","type":"text","marks":[{"type":"strong"}]},{"text":" — The status listing shows the status for each chassis processed by the rolling reboot task. Each chassis can have one of the following states:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"pending","type":"text","marks":[{"type":"strong"}]},{"text":": The rolling reboot task has not processed the chassis.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"in-progress","type":"text","marks":[{"type":"strong"}]},{"text":": The rolling reboot task is in the process of rebooting the chassis.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"completed","type":"text","marks":[{"type":"strong"}]},{"text":": The chassis was successfully rebooted.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"removed","type":"text","marks":[{"type":"strong"}]},{"text":": The chassis was removed from the list of chassis to process after the rolling reboot was started (using the ","type":"text"},{"text":"delete rolling reboot","type":"text","marks":[{"type":"code"}]},{"text":" command).","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"error","type":"text","marks":[{"type":"strong"}]},{"text":": The chassis encountered an error of some kind.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"abandoned","type":"text","marks":[{"type":"strong"}]},{"text":": The chassis was currently being processed when a user cancelled the rolling reboot.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"dropped","type":"text","marks":[{"type":"strong"}]},{"text":": The rolling reboot was in the process of waiting for the chassis to reboot when a user request was made to move to the next chassis (using the ","type":"text"},{"text":"--skip","type":"text","marks":[{"type":"code"}]},{"text":" flag).","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"offline","type":"text","marks":[{"type":"strong"}]},{"text":": The chassis was already offline when the reboot task attempted to reboot the chassis.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Cancel reboot","type":"text","marks":[{"type":"strong"}]},{"text":" — To cancel (not pause) an active rolling reboot, issue the delete command, which the reboot process at the earliest moment and thus cannot be restarted later.","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"platform delete rollingreboot --cancel","type":"text"}]},{"type":"paragraph","content":[{"text":"Exclude from reboot ","type":"text","marks":[{"type":"strong"}]},{"text":"— To exclude from a ","type":"text"},{"text":"currently running","type":"text","marks":[{"type":"em"}]},{"text":" rolling reboot one or more chassis not rebooted:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"platform delete rollingreboot --chassis ","type":"text"}]},{"type":"paragraph","content":[{"text":"Pause reboot","type":"text","marks":[{"type":"strong"}]},{"text":" — To pause the current rolling reboot process so it can be restarted later:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"platform pause rollingreboot","type":"text"}]},{"type":"paragraph","content":[{"text":"Resume reboot","type":"text","marks":[{"type":"strong"}]},{"text":" — To resume a paused rolling reboot:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"platform resume rollingreboot","type":"text"}]},{"type":"paragraph","content":[{"text":"No-wait reboot ","type":"text","marks":[{"type":"strong"}]},{"text":"— Normally, the rolling reboot process waits up to 3 hours for a rebooted chassis to come back online before proceeds to the next. To force the process to stop waiting and move to the next chassis, use the","type":"text"},{"text":" --skip","type":"text","marks":[{"type":"code"}]},{"text":" flag:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"platform resume rollingreboot --skip","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Adding a Chassis","type":"text"}]},{"type":"paragraph","content":[{"text":"Which version of Swarm a given node uses is set at the time of provisioning.","type":"text"}]},{"type":"paragraph","content":[{"text":"To add a single chassis as a new Swarm node, use the following process:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Create a node.cfg file and add any node-specific Swarm settings to apply, or leave it blank to accept all current settings.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Power on the chassis for the first time.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Wait until the chassis enlists and powers off.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Deploy the new server:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"platform deploy storage -n 1 -v <#.#.#-version-to-deploy>","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Use the following process to deploy an individual chassis by system ID:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Create a node.cfg file and add any node-specific Swarm settings to apply or leave it blank to accept all current settings.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Get a list of chassis that are available for deployment by using the following command:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"platform list nodes --state New","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Choose a System ID to deploy a single chassis using a command like the following:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"platform deploy storage -y 4y3h7p -v 9.2.1","type":"text"}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Service Proxy","type":"text"}]},{"type":"paragraph","content":[{"text":"Restart the service so it picks up the new chassis list if the Service Proxy is running on the Platform Server when adding or removing chassis:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"platform restart proxy","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Reconfiguring the Cluster","type":"text"}]},{"type":"paragraph","content":[{"text":"Modify the cluster-wide Swarm configuration at anytime using the CLI and a configuration file. The reconfiguration process is ","type":"text"},{"text":"additive","type":"text","marks":[{"type":"em"}]},{"text":": all existing settings that are not referenced in the file are preserved. Platform overwrites or adds those two settings if two settings are defined.","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Create a supplemental .cfg file (such as ","type":"text"},{"text":"changes.cfg","type":"text","marks":[{"type":"code"}]},{"text":") and specify any new or changed Swarm settings to apply.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"To upload the configuration changes, use the following CLI command:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"platform upload config -c {Path to .cfg}","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"The CLI parses the uploaded configuration file for changes to make to Platform.","type":"text"}]},{"type":"paragraph","content":[{"text":"Platform Server attempts to communicate the new configuration to Swarm if Swarm was running during the upload. Any settings that cannot be communicated to Swarm requires a reboot of the Swarm cluster to take effect. The CLI indicates if the setting was communicated to the Storage cluster and if a reboot is required for each setting contained in the file. The Swarm UI also indicates which settings require rebooting.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Example: Increase Swarm processes","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Swarm 10","type":"text"}]},{"type":"paragraph","content":[{"text":"Swarm Storage 10 has a single-process architecture, so the configuration setting ","type":"text"},{"text":"chassis.processes","type":"text","marks":[{"type":"code"}]},{"text":" is no longer used and cannot be increased.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"Option 1: Create a configuration file:","type":"text","marks":[{"type":"em"}]}]},{"type":"paragraph","content":[{"text":"To set all chassis throughout the cluster to a higher number of processes, create a configuration file and upload it to Platform Server. ","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Create a text file, such as ","type":"text"},{"text":"update.cfg","type":"text","marks":[{"type":"code"}]},{"text":", containing ","type":"text"},{"text":"only","type":"text","marks":[{"type":"em"}]},{"text":" the setting to be changed.","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"chassis.processes = 6","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"To upload the configuration changes, use the following CLI command:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"platform upload config -c {Path to update.cfg}","type":"text"}]},{"type":"paragraph","content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"__confluenceADFMigrationUnsupportedContentInternalExtension__","text":"","parameters":{"cxhtml":"Note

Include the -m <mac-address> parameter if you want to target the update to specific chassis.

","block-inline":true,"nestedContent":{"type":"doc","content":[{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Note","type":"text"}]},{"type":"paragraph","content":[{"text":"Include the ","type":"text"},{"text":"-m ","type":"text","marks":[{"type":"code"}]},{"text":" parameter if you want to target the update to specific chassis.","type":"text"}]}]}],"version":1},"reason":"An info macro in a list item can't be created or edited in the new editor."}}}]}]}]},{"type":"paragraph","content":[{"text":"Option 2: Use the CLI directly","type":"text","marks":[{"type":"em"}]},{"text":":","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Add the configuration change directly:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"plaintext"},"content":[{"text":"platform add config --name \"chassis.processes\" --value 6","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Reconfiguring a Chassis","type":"text"}]},{"type":"paragraph","content":[{"text":"Modify the node-specific settings for a single chassis by the same process, but the MAC address of any valid NIC on that chassis needs to be specified.","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Create a .cfg file (such as ","type":"text"},{"text":"changes.cfg","type":"text","marks":[{"type":"code"}]},{"text":") and specify any new or changed node-specific settings to apply.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"To upload the configuration changes, use the following CLI command:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"platform upload config -c {Path to .cfg} -m {mac address}","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"The CLI parses the uploaded configuration file for changes to make to that chassis.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Releasing a Chassis","type":"text"}]},{"type":"paragraph","content":[{"text":"There may be times when a chassis needs to be released from the Swarm cluster, either for temporary maintenance or for permanent removal.","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Important","type":"text"}]},{"type":"paragraph","content":[{"text":"To guarantee a clean shut down, power off the chassis through the UI or SNMP before running ","type":"text"},{"text":"release","type":"text","marks":[{"type":"code"}]},{"text":" commands.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"Temporary release","type":"text","marks":[{"type":"strong"}]},{"text":" — Temporary release of a chassis assumes that the chassis is added back into the cluster at a later time. Releasing a chassis allows deallocating the cluster resources, such as IP Addresses, or wipe and reset the configuration.","type":"text"}]},{"type":"paragraph","content":[{"text":"Once the chassis is powered off, release the chassis from the Swarm cluster:","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Temporary removal","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"platform release storagechassis -y ","type":"text"}]},{"type":"paragraph","content":[{"text":"Permanent removal ","type":"text","marks":[{"type":"strong"}]},{"text":"— Permanent removal is for retiring a chassis altogether or changing the chassis' main identifying information, such as changing a NIC. Removing the chassis from management causes the chassis to start the provisioning life cycle as if it is a brand new chassis, if it is powered on again.","type":"text"}]},{"type":"paragraph","content":[{"text":"Remove the chassis from Platform Server management permanently once the chassis is powered off:","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Permanent removal","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"platform release storagechassis -y --remove","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Resetting to Defaults","type":"text"}]},{"type":"paragraph","content":[{"text":"Issue the following commands to clear out all existing setting customizations from a given chassis or the entire cluster.","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Note","type":"text"}]},{"type":"paragraph","content":[{"text":"These commands require a cluster reboot because the reset is not communicated to the Storage network dynamically.","type":"text"}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Delete All Default Chassis Settings","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"platform delete allchassisconfig","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Delete All Cluster Settings","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"platform delete allclusterconfig","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Managing Subclusters","type":"text"}]},{"type":"paragraph","content":[{"text":"Assign chassis to subclusters after all chassis are deployed and are running.","type":"text"}]},{"type":"paragraph","content":[{"text":"Use the ","type":"text"},{"text":"list","type":"text","marks":[{"type":"code"}]},{"text":" command to see the current subcluster assignments:","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"List subclusters","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"platform subcluster list","type":"text"}]},{"type":"paragraph","content":[{"text":"To assign a chassis to a subcluster, use the ","type":"text"},{"text":"assign","type":"text","marks":[{"type":"code"}]},{"text":" command:","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Add to subcluster","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"platform subcluster assign -y --subcluster ","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Note","type":"text"}]},{"type":"paragraph","content":[{"text":"Reassignment is not immediate. Allow time for every node on the chassis to be migrated to the new subcluster.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"Use the ","type":"text"},{"text":"unassign","type":"text","marks":[{"type":"code"}]},{"text":" command to remove a chassis from a subcluster:","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Remove from subcluster","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"platform subcluster unassign -y ","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Important","type":"text"}]},{"type":"paragraph","content":[{"text":"Reboot the chassis for the subcluster removal to take effect.","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Changing the Default Gateway","type":"text"}]},{"type":"paragraph","content":[{"text":"The Platform Server configures Swarm Storage to use the Platform Server as the default gateway by default.","type":"text"}]},{"type":"paragraph","content":[{"text":"Either add a \"network.gateway\" to the cluster configuration file or issue the following command to override this behavior:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"platform add config --name \"network.gateway\" --value \"\"","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Managing Administrators","type":"text"}]},{"type":"paragraph","content":[{"text":"With one exception, modifying the admin users for the Storage cluster requires the Storage cluster to be up and running before the operations can be done. The one exception to this is the \"snmp\" user which can have the password set while the cluster is down or before the cluster is booted for the first time.","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Important","type":"text"}]},{"type":"paragraph","content":[{"text":"Changing the password for the \"snmp\" user requires a full cluster reboot for the change to take effect.","type":"text"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Adding or Updating Users","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Important","type":"text"}]},{"type":"paragraph","content":[{"text":"Modifying passwords for the admin user requires restarting the Service Proxy, if installed. It can also require updates to Gateway configuration.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"Use the following CLI command to add a new admin user:","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Add admin user","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"platform add adminuser \t\n\t[--askpassword]\n\t[--username ]\n\t[--password ]\n\t[--update]","type":"text"}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"--askpassword","type":"text","marks":[{"type":"code"}]},{"text":" flag allows avoiding specifying a password using the command line by providing the password using stdin. When this flag is used, a prompt displays to enter a new/updated password for the user. The Linux pipe functionality can be used:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"cat password.txt | platform add adminuser --askpassword --username admin --update","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Important","type":"text"}]},{"type":"paragraph","content":[{"text":"If updating the password for an existing user use the ","type":"text"},{"text":"--update","type":"text","marks":[{"type":"code"}]},{"text":" flag. ","type":"text"}]}]},{"type":"paragraph","content":[{"text":"Use the following CLI command to delete an admin user from the cluster:","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Delete admin user","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"platform delete adminuser --username ","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Upgrading Swarm Storage","type":"text"}]},{"type":"paragraph","content":[{"text":"Use the CLI to upload the version and take steps to deploy it to running nodes to upgrade Swarm Storage in a live cluster, either by restarting the entire cluster or each chassis in turn.","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Note","type":"text"}]},{"type":"paragraph","content":[{"text":"The ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#172b4d"}}]},{"text":"deploy storage --upgrade","type":"text","marks":[{"type":"code"}]},{"text":" command is used for both upgrades and downgrades of Storage versions.","type":"text","marks":[{"type":"textColor","attrs":{"color":"#172b4d"}}]}]}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Upload the new version of the Swarm Storage software to Platform server, verifying the matches the version of Swarm Storage being uploaded:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"platform upload storageimages -i -v \n\nplatform upload storageimages -i ./storage-9.6.0-x86_64.zip -v 9.6","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"},{"text":"Note: The zip file above is contained within the ","type":"text"},{"text":"Swarm-{version}-{date}.zip","type":"text","marks":[{"type":"code"}]},{"text":" file. Inside this zip, a folder called Storage contains a file called ","type":"text"},{"text":"storage-{version}-x86_64.zip","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Get a full listing of all nodes along with IPs, MAC addresses, and system IDs:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"platform list nodes --state Deployed ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Using the list of system IDs, deploy the upgrade on each of the nodes. Run that command as well if restarting the node immediately after upgrade:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"platform deploy storage --upgrade -v 9.2.1 -y \nplatform restart storagenode -y ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Restart the cluster now if each node is not restarted individually, either full or rolling:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"platform restart storagecluster --full\nor\nplatform restart storagecluster --rolling []","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Managing Service Proxy","type":"text"}]},{"type":"paragraph","content":[{"text":"Status","type":"text","marks":[{"type":"strong"}]},{"text":" — Use this command to check the status of the Service Proxy:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"platform status proxy","type":"text"}]},{"type":"paragraph","content":[{"text":"Upgrade","type":"text","marks":[{"type":"strong"}]},{"text":" — Use the CLI to upload the version and deploy it to upgrade the Service Proxy on the Platform server:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"platform deploy proxy -b --upgrade","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Note","type":"text"}]},{"type":"paragraph","content":[{"text":"After a Service Proxy upgrade, it takes several minutes for the UI to come back up.","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Configuring DNS","type":"text"}]},{"type":"paragraph","content":[{"text":"The Storage nodes may need to resolve names for outside resources, such as Elasticsearch or Syslog. Configure the DNS server on the Platform Server to communicate with outside domains to perform this. ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Option 1: Forwarding","type":"text"}]},{"type":"paragraph","content":[{"text":"A Slave/Backup DNS zone is a read-only copy of the DNS records; it receives updates from the Master zone of the DNS server.","type":"text"}]},{"type":"paragraph","content":[{"text":"Perform forwarding by having the domain managed by the Platform server forward all lookups to outside domains if no DNS master/slave relationships are configured:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Edit ","type":"text"},{"text":"/etc/bind/named.conf.options","type":"text","marks":[{"type":"code"}]},{"text":" and add the following line after the \"","type":"text"},{"text":"listen-on-v6","type":"text","marks":[{"type":"code"}]},{"text":"\" line","type":"text"}]},{"type":"codeBlock","content":[{"text":"forwarders {172.30.0.202;};","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Run the following command to restart ","type":"text"},{"text":"bind9","type":"text","marks":[{"type":"strong"}]},{"text":" on the Platform Server:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"sudo systemctl restart bind9","type":"text"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Option 2: Configuring a Slave DNS Zone","type":"text"}]},{"type":"paragraph","content":[{"text":"Have the Platform Server become a slave DNS of that zone if an external DNS Zone is configured; the reverse can be done to allow other systems to resolve names for servers managed by the Platform server.","type":"text"}]},{"type":"paragraph","content":[{"text":"This process assumes the external DNS server is configured to allow zone transfers to the Platform server. The DNS server on the Platform server is not configured to restrict zone transfers to other DNS slaves.","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Edit ","type":"text"},{"text":"/etc/bind/named.conf.local","type":"text","marks":[{"type":"code"}]},{"text":" and add the following line at this location:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"// slave other local zones\ninclude \"/etc/bind/named.conf.slaves\";","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Create a new file called ","type":"text"},{"text":"/etc/bind/named.conf.slaves","type":"text","marks":[{"type":"code"}]},{"text":" and add the settings in this format:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"// local slave zones\nzone \"example.com\" in {\n type slave;\n masters {172.30.0.100; };\n file \"/var/cache/bind/slave/zone-example.com\";\n};","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Run the following command to restart ","type":"text"},{"text":"bind9","type":"text","marks":[{"type":"strong"}]},{"text":" on the Platform Server:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"sudo systemctl restart bind9","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Configuring Docker Bridge","type":"text"}]},{"type":"paragraph","content":[{"text":"Edit the file ","type":"text"},{"text":"/etc/docker/daemon.json","type":"text","marks":[{"type":"code"}]},{"text":" to configure or modify the network information that is used by the default Docker (docker0) bridge. Add networking properties as properties to the root JSON object in the file:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"{\n \"log-opts\": {\n \"max-size\": \"5m\",\n \"max-file\": \"10\"\n },\n \"bip\": \"10.0.1.1/24\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"bip","type":"text","marks":[{"type":"code"}]},{"text":" property sets the IP address and subnet mask to use for the default docker0 bridge. See the ","type":"text"},{"text":"Docker documentation","type":"text","marks":[{"type":"link","attrs":{"href":"https://docs.docker.com/v1.12/engine/userguide/networking/default_network/custom-docker0/"}}]},{"text":" for details on the different properties.","type":"text"}]}],"version":1}

Browser not supported