Skip to content

Commit d4d7da8

Browse files
authored
Merge pull request #88 from NetAppDocs/gh_mnode_migration_collect_nodes_api_release
Gh mnode migration collect nodes api release
2 parents 9c15e90 + 995dae9 commit d4d7da8

23 files changed

Lines changed: 1415 additions & 13 deletions

_data/sidebars/docs_sidebar.yml

Lines changed: 57 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,10 @@ entries:
2222
url: /concept_hci_clusters.html
2323
- title: Nodes
2424
url: /concept_hci_nodes.html
25-
#- title: Storage
25+
- title: Storage
26+
entries:
27+
- title: Volumes
28+
url: /concept_hci_volumes.html
2629
# url: /concept_hci_storage.html
2730
- title: Security
2831
url: /concept_cg_hci_security.html
@@ -61,16 +64,60 @@ entries:
6164
- title: Install H-series hardware
6265
url: /task_hci_installhw.html
6366
# For 20.2 consider putting multiple access topics or URLs
64-
- title: Monitor your NetApp HCI system
67+
- title: Manage NetApp HCI
6568
entries:
66-
- title: View resources on the HCC Dashboard
67-
url: /task_hcc_dashboard.html
68-
- title: View your inventory in the Nodes page
69-
url: /task_hcc_nodes.html
70-
- title: Monitor performance, capacity, and cluster health with Active IQ
71-
url: /task_hcc_activeiq.html
72-
- title: Collect NetApp HCI logs
73-
url: /task_hcc_collectlogs.html
69+
- title: Monitor your NetApp HCI system
70+
entries:
71+
- title: View resources on the HCC Dashboard
72+
url: /task_hcc_dashboard.html
73+
- title: View your inventory in the Nodes page
74+
url: /task_hcc_nodes.html
75+
- title: Monitor performance, capacity, and cluster health with Active IQ
76+
url: /task_hcc_activeiq.html
77+
- title: Collect NetApp HCI logs
78+
url: /task_hcc_collectlogs.html
79+
- title: Work with the management node
80+
entries:
81+
- title: Management node overview
82+
url: /task_mnode_work_overview.html
83+
- title: Install or recover a management node
84+
entries:
85+
- title: Install a management node
86+
url: /task_mnode_install.html
87+
- title: Configure a storage Network Interface Controller (NIC)
88+
url: /task_mnode_install_add_storage_NIC.html
89+
- title: Recover a management node
90+
url: /task_mnode_recover.html
91+
- title: Access the management node
92+
url: /task_mnode_access_ui.html
93+
- title: Work with the management node UI
94+
entries:
95+
- title: Management node UI overview
96+
url: /task_mnode_work_overview_UI.html
97+
- title: Configure alert monitoring on NetApp HCI
98+
url: /task_mnode_enable_alerts.html
99+
- title: Modify and test the management node network, cluster, and system settings
100+
url: task_mnode_settings.html
101+
- title: Run system utilities from the management node
102+
url: task_mnode_run_system_utilities.html
103+
- title: Work with the management node REST API
104+
entries:
105+
- title: Management node REST API UI overview
106+
url: /task_mnode_work_overview_API.html
107+
- title: Get authorization to use REST APIs
108+
url: /task_mnode_api_get_authorizationtouse.html
109+
- title: Enable Active IQ and NetApp HCI monitoring
110+
url: task_mnode_enable_activeIQ.html
111+
- title: Add compute and controller assets to the management node
112+
url: task_mnode_add_assets.html
113+
- title: Change the storage cluster administrator password
114+
url: task_mnode_change_storage_cluster_admin_password.html
115+
- title: Configure a proxy server for the management node
116+
url: /task_mnode_configure_proxy_server.html
117+
- title: Get logs from management services
118+
url: /task_mnode_get_logs_from_management_services.html
119+
- title: Enable remote NetApp Support connections
120+
url: /task_mnode_enable_remote_support_connections.html
74121
- title: Upgrade your NetApp HCI or SolidFire system
75122
entries:
76123
- title: Upgrades overview

docs/concept_hci_volumes.adoc

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
sidebar: docs_sidebar
3+
permalink: docs/concept_hci_volumes.html
4+
summary: A volume
5+
keywords: netapp, hci, storage volume, solidfire volume, element volume, persistent volume
6+
---
7+
8+
= Volumes
9+
:hardbreaks:
10+
:nofooter:
11+
:icons: font
12+
:linkattrs:
13+
:imagesdir: ../media/
14+
15+
[.lead]
16+
Storage is provisioned in the NetApp Element system as volumes. Volumes are block devices accessed over the network using iSCSI or Fibre Channel clients.
17+
18+
The NetApp Element Plug-in for vCenter Server enables you to create, view, edit, delete, clone, backup or restore volumes for user accounts. You can also manage each volume on a cluster, and add or remove volumes in volume access groups.
19+
20+
== Persistent volumes
21+
22+
Persistent volumes allow management node configuration data to be stored on a specified storage cluster, rather than locally with a VM, so that data can be preserved in the event of management node loss or removal. Persistent volumes are an optional yet recommended management node configuration.
23+
24+
If you are deploying a management node for NetApp HCI using the NetApp Deployment Engine, persistent volumes are enabled and configured automatically.
25+
26+
An option to enable persistent volumes is included in the installation and upgrade scripts when deploying a new management node. Persistent volumes are volumes on an Element software-based storage cluster that contain management node configuration information for the host management node VM that persists beyond the life of the VM. If the management node is lost, a replacement management node VM can reconnect to and recover configuration data for the lost VM.
27+
28+
Persistent volumes functionality, if enabled during installation or upgrade, automatically creates multiple volumes with NetApp-HCI- pre-pended to the name on the assigned cluster. These volumes, like any Element software-based volume, can be viewed using the Element software web UI, NetApp Element Plug-in for vCenter Server, or API, depending on your preference and installation. Persistent volumes must be up and running with an iSCSI connection to the management node to maintain current configuration data that can be used for recovery.
29+
30+
NOTE: Persistent volumes that are associated with management services are created and assigned to a new account during installation or upgrade. If you are using persistent volumes, do not modify or delete the volumes or their associated account
31+
32+
33+
== Find more information
34+
* http://docs.netapp.com/hci/index.jsp[NetApp HCI Documentation Center^]
35+
* http://docs.netapp.com/sfe-120/index.jsp[SolidFire and Element Software Documentation Center^]

docs/task_hcc_collectlogs.adoc

Lines changed: 63 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,13 @@ keywords: netapp, hci, logs, collection, troubleshooting, monitor
1414
:imagesdir: ../media/
1515

1616
[.lead]
17-
If you have trouble with your NetApp HCI installation, you can collect logs to send to NetApp Support to help with diagnosis. You can access the log collection area from the NetApp Hybrid Control Dashboard.
17+
If you have trouble with your NetApp HCI installation, you can collect logs to send to NetApp Support to help with diagnosis. You can either use NetApp Hybrid Cloud Control or the REST API to collect logs.
18+
19+
* <<Use NetApp Hybrid Cloud Control to collect NetApp HCI logs>>
20+
* <<Use the REST API to collect NetApp HCI logs>>
21+
22+
== Use NetApp Hybrid Cloud Control to collect NetApp HCI logs
23+
You can access the log collection area from the NetApp Hybrid Cloud Control Dashboard.
1824

1925
.Steps
2026
. Open a web browser and browse to the IP address of the management node. For example:
@@ -29,7 +35,7 @@ https://[management node IP address]
2935
The *Collect Logs* page appears. If you have collected logs before, you can download the existing log package, or begin a new log collection.
3036
. Select a date range in the *Date Range* drop-down menu to specify what dates the logs should include.
3137
+
32-
If you specify a custom start date, you can select the date to begin the date range. The logs will cover from that date up to the present time.
38+
If you specify a custom start date, you can select the date to begin the date range. Logs will be collected from that date up to the present time.
3339
. In the *Log Collection* section, select the types of log files the log package should include.
3440
+
3541
For storage and compute logs, you can expand the list of storage or compute nodes and select individual nodes to collect logs from (or all nodes in the list).
@@ -43,6 +49,61 @@ NOTE: Depending on the logs you collect, the progress bar might remain at a cert
4349
+
4450
The log package is in a compressed UNIX .tgz file format.
4551

52+
== Use the REST API to collect NetApp HCI logs
53+
You can use REST API to collect NetApp HCI logs.
54+
55+
.Steps
56+
. Locate the storage cluster ID:
57+
.. Open the management node REST API UI on the management node:
58+
+
59+
----
60+
https://[management node IP]/logs/1
61+
----
62+
.. Click *Authorize* and complete the following:
63+
... Enter the cluster user name and password.
64+
... Enter the client ID as `mnode-client` if the value is not already populated.
65+
... Click *Authorize* to begin a session.
66+
. Collect logs from NetApp HCI:
67+
.. Click *POST /bundle*.
68+
.. Click *Try it out*.
69+
.. Change the values of the following parameters in the *Request body* field to true or false depending on which type of logs you need to collect:
70+
... `computeLogs`
71+
... `mnodeLogs`
72+
... `storageCrashDumps`
73+
... `storageLogs`
74+
.. Click *Execute* to begin log collection.
75+
The response should return a response similar to the following:
76+
+
77+
----
78+
{
79+
"_links": {
80+
"self": "https://10.1.1.5/logs/1/bundle"
81+
},
82+
"taskId": "4157881b-z889-45ce-adb4-92b1843c53ee",
83+
"taskLink": "https://10.1.1.5/logs/1/bundle"
84+
}
85+
----
86+
. Check on the status of the log collection task:
87+
.. Click *GET /bundle*.
88+
.. Click *Try it out*.
89+
.. Click *Execute* to return a status of the collection task.
90+
.. Scroll to the bottom of the response body.
91+
+
92+
You should see a `percentComplete` attribute detailing the progress of the collection. If the collection is complete, the `downloadLink` attribute contains the full download link including the file name of the log package.
93+
94+
.. Copy the file name at the end of the `downloadLink` attribute.
95+
. Download the collected log package:
96+
.. Click *GET /bundle/{filename}*.
97+
.. Click *Try it out*.
98+
.. Paste the file name you copied earlier into the `filename` parameter text field.
99+
.. Click *Execute*.
100+
+
101+
After execution, a download link appears in the response body area.
102+
103+
.. Click *Download file* and save the resulting file to your computer.
104+
+
105+
The log package is in a compressed UNIX .tgz file format.
106+
46107
[discrete]
47108
== Find more information
48109
* https://docs.netapp.com/hci/index.jsp[NetApp HCI Documentation Center^]

docs/task_hcc_upgrade_element_software.adoc

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ https://<ManagementNodeIP>
6363
. Click *Upgrade* near the top right of the interface.
6464
. On the *Upgrades* page, select *Storage*.
6565
+
66-
The *Storage* tab lists the storage clusters that are part of your installation.
66+
The *Storage* tab lists the storage clusters that are part of your installation. If a cluster is inaccessible by NetApp Hybrid Cloud Control, it will not be displayed on the *Upgrades* page.
6767
. Choose from the following options and perform the set of steps that are applicable to your cluster:
6868
+
6969
[%header,cols=2*]
@@ -351,6 +351,17 @@ During the upgrade, the `status` indicates `running` if no errors are encountere
351351
+
352352
The upgrade has finished successfully when the `percent` value is `100` and the `state` indicates `finished`.
353353

354+
== What happens if an upgrade fails using NetApp Hybrid Cloud Control
355+
If a drive or node fails during an upgrade, the Element UI will show cluster faults. The upgrade process does not proceed to the next node, and waits for the cluster faults to resolve. The progress bar in the UI shows that the upgrade is waiting for the cluster faults to resolve. At this stage, clicking *Pause* in the UI will not work, because the upgrade waits for the cluster to be healthy. You will need to engage NetApp Support to assist with the failure investigation.
356+
357+
NetApp Hybrid Cloud Control has a pre-set three-hour waiting period, during which one of the following scenarios can happen:
358+
359+
* The cluster faults get resolved within the three-hour window, and upgrade resumes. You do not need to take any action in this scenario.
360+
* The problem persists after three hours, and the upgrade status shows *Error* with a red banner. You can resume the upgrade by clicking *Resume* after the problem is resolved.
361+
* NetApp Support has determined that the upgrade needs to be temporarily aborted to take corrective action before the three-hour window. Support will use the API to abort the upgrade.
362+
363+
CAUTION: Aborting the cluster upgrade while a node is being updated might result in the drives being ungracefully removed from the node. If the drives are ungracefully removed, adding the drives back during an upgrade will require manual intervention by NetApp Support. The node might be taking longer to do firmware updates or post update syncing activities. If the upgrade progress seems stalled, contact NetApp Support for assistance.
364+
354365
== Upgrade Element software at connected sites using HealthTools
355366

356367
.Steps

docs/task_mnode_access_ui.adoc

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
sidebar: docs_sidebar
3+
permalink: docs/task_mnode_access_ui.html
4+
summary: You can access the management UI or the REST API UI.
5+
keywords: netapp, mnode, management node, api, hci
6+
---
7+
8+
= Access the management node
9+
10+
:hardbreaks:
11+
:nofooter:
12+
:icons: font
13+
:linkattrs:
14+
:imagesdir: ../media/
15+
16+
[.lead]
17+
Beginning with NetApp Element software version 11.3, the management node contains two UIs: a UI for managing REST-based services and a per-node UI for managing network and cluster settings and operating system tests and utilities.
18+
19+
For clusters running Element software version 11.3 or later, you can make use one of two interfaces:
20+
21+
* By using the management node UI (`https:// [mNode IP}:442`), you can make changes to network and cluster settings, run system tests, or use system utilities.
22+
* By using the built-in REST API UI (`https://[mNode IP}/mnode`), you can run or understand APIs relating to the management node services, including proxy server configuration, service level updates, or asset management.
23+
24+
25+
== Access the management node per-node UI
26+
27+
From the per-node UI, you can access network and cluster settings and utilize system tests and
28+
utilities.
29+
30+
.Steps
31+
32+
. Access the per-node UI for the management node by entering the management node IP address followed by :442
33+
+
34+
----
35+
https://[IP address]:442
36+
----
37+
+
38+
image::mnode_per_node_442_ui.png[management node per-node UI]
39+
40+
. Enter the management node user name and password when prompted.
41+
42+
== Access the management node REST API UI
43+
44+
From the REST API UI, you can access a menu of service-related APIs that control management services on the management node.
45+
46+
.Steps
47+
48+
. To access the REST API UI for management services, enter the management node IP address
49+
followed by `/mnode`:
50+
+
51+
----
52+
https://[IP address]/mnode
53+
----
54+
+
55+
image::mnode_swagger_ui.png[management node REST API UI]
56+
57+
. Click *Authorize* or any lock icon and enter cluster admin credentials for permissions to use APIs.
58+
59+
[discrete]
60+
== Find more Information
61+
* link:task_hci_mnode_enable_activeIQ.html[Enable the Active IQ collector service for SolidFire all-flash storage]
62+
* https://docs.netapp.com/hci/index.jsp[NetApp HCI Documentation Center^]
63+
* https://docs.netapp.com/us-en/documentation/hci.aspx[NetApp HCI Resources Page^]

docs/task_mnode_add_assets.adoc

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
---
2+
sidebar: docs_sidebar
3+
permalink: docs/task_mnode_add_assets.html
4+
summary: You can add compute and controller assets to the management node configuration using the REST API UI.
5+
keywords: netapp, mnode, management node, rest api, hci
6+
---
7+
8+
= Add an asset to the management node
9+
10+
:hardbreaks:
11+
:nofooter:
12+
:icons: font
13+
:linkattrs:
14+
:imagesdir: ../media/
15+
16+
[.lead]
17+
You can add compute and controller assets to the management node configuration using the REST API UI.
18+
19+
You might need to add an asset if you recently scaled your installation and new assets were not added automatically to your configuration. Use these APIs to add assets that are recent additions to your installation.
20+
21+
22+
.Before you begin
23+
* Ensure that your cluster version is running NetApp Element software 11.3 or later.
24+
* Ensure that you have deployed a management node running version 11.3 or later.
25+
26+
.About this task
27+
(NetApp HCI only) If you do not see compute nodes in Hybrid Cloud Control (HCC) after scaling your NetApp HCI system, you can add a compute node using the `POST /assets/{asset_id}/compute-nodes` described in this procedure.
28+
29+
.Steps
30+
. Access the REST API UI for management services by entering the management node IP address
31+
followed by `/mnode`:
32+
+
33+
----
34+
https://[IP address]/mnode
35+
----
36+
37+
. Click *Authorize* or any lock icon and complete the following:
38+
+
39+
.. Enter the cluster user name and password.
40+
.. Enter the client ID as `mnode-client`.
41+
.. Click *Authorize* to begin a session.
42+
.. Close the window.
43+
. To add a compute node or controller sub-asset to an existing base asset, click one of the following.
44+
+
45+
Your installation has a base asset configuration that was created during installation or upgrade.
46+
+
47+
[cols=2*,options="header",cols="40,60"]
48+
|===
49+
| Option
50+
| Description
51+
| POST /assets/{asset_id}/
52+
controllers | Run this command to create a controller sub-asset.
53+
| POST /assets/{asset_id}/
54+
compute-nodes | Run this command to create a compute node sub-asset.
55+
|===
56+
57+
. Click *Try it out*.
58+
. Enter the required payload values as defined in the *Model* tab.
59+
+
60+
IMPORTANT: For compute node assets, remove the `hardware_tag` parameter suggested in the
61+
payload example.
62+
63+
. Enter the parent base asset ID in the *asset_id* field.
64+
. Click *Execute*.
65+
66+
[discrete]
67+
== Find more information
68+
* https://docs.netapp.com/hci/index.jsp[NetApp HCI Documentation Center^]
69+
* https://docs.netapp.com/us-en/documentation/hci.aspx[NetApp HCI Resources Page^]

0 commit comments

Comments
 (0)