toc.yml 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386
  1. - title: Welcome
  2. url: /readme
  3. not_numbered: true
  4. - title: Search
  5. search: true
  6. - title: Troubleshooters
  7. url: /troubleshooters/readme
  8. not_numbered: true
  9. expand_sections: true
  10. sections:
  11. - title: TSG100 - The Big Data Cluster troubleshooter
  12. url: troubleshooters/tsg100-troubleshoot-bdc
  13. - title: TSG101 - SQL Server troubleshooter
  14. url: troubleshooters/tsg101-troubleshoot-sql-server
  15. - title: TSG102 - HDFS troubleshooter
  16. url: troubleshooters/tsg102-troubleshoot-hdfs
  17. - title: TSG103 - Spark troubleshooter
  18. url: troubleshooters/tsg103-troubleshoot-spark
  19. - title: TSG104 - Control troubleshooter
  20. url: troubleshooters/tsg104-troubleshoot-control
  21. - title: TSG105 - Gateway troubleshooter
  22. url: troubleshooters/tsg105-troubleshoot-gateway
  23. - title: TSG106 - App troubleshooter
  24. url: troubleshooters/tsg106-troubleshoot-app
  25. - title: Log Analyzers
  26. url: /log-analyzers/readme
  27. not_numbered: true
  28. expand_sections: true
  29. sections:
  30. - title: TSG046 - Knox gateway logs
  31. url: log-analyzers/tsg046-get-knox-logs
  32. - title: TSG036 - Controller logs
  33. url: log-analyzers/tsg036-get-controller-logs
  34. - title: TSG034 - Livy logs
  35. url: log-analyzers/tsg034-get-livy-logs
  36. - title: TSG035 - Spark History logs
  37. url: log-analyzers/tsg035-get-sparkhistory-logs
  38. - title: TSG030 - SQL Server errorlog files
  39. url: log-analyzers/tsg030-get-errorlog-from-all-pods
  40. - title: TSG031 - SQL Server PolyBase logs
  41. url: log-analyzers/tsg031-get-polybase-logs-for-all-pods
  42. - title: TSG095 - Hadoop namenode logs
  43. url: log-analyzers/tsg095-get-namenode-logs
  44. - title: TSG090 - Yarn nodemanager logs
  45. url: log-analyzers/tsg090-get-nodemanager-logs
  46. - title: TSG088 - Hadoop datanode logs
  47. url: log-analyzers/tsg088-get-datanode-logs
  48. - title: TSG096 - Zookeeper logs
  49. url: log-analyzers/tsg096-get-zookeeper-logs
  50. - title: TSG073 - InfluxDB logs
  51. url: log-analyzers/tsg073-get-influxdb-logs
  52. - title: TSG076 - Elastic Search logs
  53. url: log-analyzers/tsg076-get-elastic-search-logs
  54. - title: TSG077 - Kibana logs
  55. url: log-analyzers/tsg077-get-kibana-logs
  56. - title: TSG092 - Supervisord log tail for all containers in BDC
  57. url: log-analyzers/tsg092-get-all-supervisord-log-tails
  58. - title: TSG093 - Agent log tail for all containers in BDC
  59. url: log-analyzers/tsg093-get-all-agent-log-tails
  60. - title: TSG094 - Grafana logs
  61. url: log-analyzers/tsg094-get-grafana-logs
  62. - title: Diagnose
  63. url: /diagnose/readme
  64. not_numbered: true
  65. expand_sections: true
  66. sections:
  67. - title: TSG027 - Observe cluster deployment
  68. url: diagnose/tsg027-observe-bdc-create
  69. - title: TSG078 - Is cluster healthy
  70. url: diagnose/tsg078-is-cluster-healthy
  71. - title: TSG029 - Find dumps in the cluster
  72. url: diagnose/tsg029-find-dumps-in-the-cluster
  73. - title: TSG032 - CPU and Memory usage for all containers
  74. url: diagnose/tsg032-get-cpu-and-memory-for-all-containers
  75. - title: TSG060 - Persistent Volume disk space for all BDC PVCs
  76. url: diagnose/tsg060-get-disk-space-for-all-pvcs
  77. - title: TSG087 - Use hadoop fs CLI on nmnode pod
  78. url: diagnose/tsg087-use-hadoop-fs
  79. - title: TSG037 - Determine master pool pod hosting primary replica
  80. url: diagnose/tsg037-determine-primary-master-replica
  81. - title: TSG055 - Time Curl to Sparkhead
  82. url: diagnose/tsg055-time-curl-to-sparkhead
  83. - title: TSG079 - Generate `controller` core dump
  84. url: diagnose/tsg079-generate-controller-core-dump
  85. - title: TSG086 - Run `top` in all containers
  86. url: diagnose/tsg086-run-top-for-all-containers
  87. - title: TSG108 - View the controller upgrade config map
  88. url: diagnose/tsg108-controller-failed-to-upgrade
  89. - title: Repair
  90. url: /repair/readme
  91. not_numbered: true
  92. expand_sections: false
  93. sections:
  94. - title: TSG024 - Namenode is in safe mode
  95. url: repair/tsg024-name-node-is-in-safe-mode
  96. - title: TSG041 - Unable to create a new asynchronous I/O context (increase sysctl fs.aio-max-nr)
  97. url: repair/tsg041-increase-fs-aio-max-nr
  98. - title: TSG048 - Deployment stuck at "Waiting for controller pod to be up"
  99. url: repair/tsg048-create-stuck-waiting-for-controller
  100. - title: TSG038 - BDC create failures due to - doc is missing key
  101. url: repair/tsg038-doc-is-missing-key-error
  102. - title: TSG047 - ConfigException - Expected only one object with name
  103. url: repair/tsg047-expected-only-one-object-with-name
  104. - title: TSG050 - Cluster create hangs with "timeout expired waiting for volumes to attach or mount for pod"
  105. url: repair/tsg050-timeout-expired-waiting-for-volumes
  106. - title: TSG057 - Failed when starting controller service. System.TimeoutException
  107. url: repair/tsg057-failed-when-starting-controller
  108. - title: TSG067 - Failed to complete kube config setup
  109. url: repair/tsg067-failed-to-complete-kube-config-setup
  110. - title: TSG075 - FailedCreatePodSandBox due to NetworkPlugin cni failed to set up pod
  111. url: repair/tsg075-networkplugin-cni-failed-to-setup-pod
  112. - title: TSG110 - Azdata returns ApiError
  113. url: repair/tsg110-azdata-returns-apierror
  114. - title: TSG028 - Restart node manager on all storage pool nodes
  115. url: repair/tsg028-restart-nodemanager-in-storage-pool
  116. - title: TSG045 - The maximum number of data disks allowed to be attached to a VM of this size (AKS)
  117. url: repair/tsg045-max-number-data-disks-allowed
  118. - title: TSG109 - Set upgrade timeouts
  119. url: repair/tsg109-upgrade-stalled
  120. - title: Notebook Runner
  121. url: /notebook-runner/readme
  122. not_numbered: true
  123. expand_sections: false
  124. sections:
  125. - title: RUN000 - Setup Master Pool runner infrastructure
  126. url: notebook-runner/run000-setup-infrastructure
  127. - title: RUN001 - Run a notebook
  128. url: notebook-runner/run001-run-notebook
  129. - title: RUN002 - Save result in Big Data Cluster
  130. url: notebook-runner/run002-save-result-in-bdc
  131. - title: RUN003 - Run expert rules
  132. url: notebook-runner/run003-run-expert-rules
  133. - title: RUN505a - Sample - Demo expert rules
  134. url: notebook-runner/run505a-sample-notebook
  135. - title: RUN505b - Sample - Expert rule (called by 505a)
  136. url: notebook-runner/run505b-expert-rule
  137. - title: RUN505c - Sample - Expert rule (called by 505b)
  138. url: notebook-runner/run505c-expert-rule
  139. - title: RUN600 - Monitor infrastructure (SQL)
  140. url: notebook-runner/run600-monitor-infrastructure-sql
  141. - title: RUN999 - Cleanup Master Pool runner infrastructure
  142. url: notebook-runner/run999-cleanup-infrastructure
  143. - title: Notebook Operationalization
  144. url: /notebook-o16n/readme
  145. not_numbered: true
  146. expand_sections: false
  147. sections:
  148. - title: OPR001 - Create app-deploy
  149. url: notebook-o16n/opr001-create-app-deploy
  150. - title: OPR002 - Run app-deploy
  151. url: notebook-o16n/opr002-run-app-deploy
  152. - title: OPR003 - Create cronjob
  153. url: notebook-o16n/opr003-create-cronjob
  154. - title: OPR004 - Suspend cronjob
  155. url: notebook-o16n/opr004-suspend-cronjob
  156. - title: OPR005 - Resume cronjob
  157. url: notebook-o16n/opr005-resume-cronjob
  158. - title: OPR006 - Delete cronjob
  159. url: notebook-o16n/opr006-delete-cronjob
  160. - title: OPR007 - Delete app-deploy
  161. url: notebook-o16n/opr007-delete-app-deploy
  162. - title: OPR100 - Deploy and Schedule notebook(s)
  163. url: notebook-o16n/opr100-deploy-and-schedule-notebook
  164. - title: OPR600 - Monitor infrastructure (Kubernetes)
  165. url: notebook-o16n/opr600-monitor-infrastructure-k8s
  166. - title: OPR700 - Create Grafana Dashboard for App-Deploy Applications
  167. url: notebook-o16n/opr700-create-app-dashboard
  168. - title: OPR900 - Troubleshoot run app-deploy
  169. url: notebook-o16n/opr900-troubleshoot-run-app-deploy
  170. - title: OPR901 - Troubleshoot cronjob
  171. url: notebook-o16n/opr901-troubleshoot-cronjob-run
  172. - title: Monitor - Big Data Cluster
  173. url: /monitor-bdc/readme
  174. not_numbered: true
  175. expand_sections: true
  176. sections:
  177. - title: TSG014 - Show BDC endpoints
  178. url: monitor-bdc/tsg014-azdata-bdc-endpoint-list
  179. - title: TSG012 - Show BDC Status
  180. url: monitor-bdc/tsg012-azdata-bdc-status
  181. - title: TSG069 - Show Big Data Cluster Gateway status
  182. url: monitor-bdc/tsg069-azdata-bdc-gateway-status
  183. - title: TSG049 - Show BDC Controller status
  184. url: monitor-bdc/tsg049-azdata-bdc-control-status
  185. - title: TSG033 - Show BDC SQL status
  186. url: monitor-bdc/tsg033-azdata-bdc-sql-status
  187. - title: TSG068 - Show BDC HDFS status
  188. url: monitor-bdc/tsg068-azdata-bdc-hdfs-status
  189. - title: TSG017 - Show BDC Configuration
  190. url: monitor-bdc/tsg017-azdata-bdc-config-show
  191. - title: TSG004 - Show BDC Apps
  192. url: monitor-bdc/tsg004-show-app-list
  193. - title: TSG003 - Show BDC Spark sessions
  194. url: monitor-bdc/tsg003-show-spark-sessions
  195. - title: TSG013 - Show file list in Storage Pool (HDFS)
  196. url: monitor-bdc/tsg013-azdata-bdc-hdfs-ls
  197. - title: TSG070 - Query SQL master pool
  198. url: monitor-bdc/tsg070-use-azdata-sql-query
  199. - title: Monitor - Kubernetes
  200. url: /monitor-k8s/readme
  201. not_numbered: true
  202. expand_sections: false
  203. sections:
  204. - title: TSG021 - Get cluster info (Kubernetes)
  205. url: monitor-k8s/tsg021-get-k8s-cluster-info
  206. - title: TSG008 - Get version information (Kubernetes)
  207. url: monitor-k8s/tsg008-get-k8s-version-info
  208. - title: TSG081 - Get namespaces (Kubernetes)
  209. url: monitor-k8s/tsg081-get-kubernetes-namespaces
  210. - title: TSG009 - Get nodes (Kubernetes)
  211. url: monitor-k8s/tsg009-get-nodes
  212. - title: TSG006 - Get system pod status
  213. url: monitor-k8s/tsg006-view-system-pod-status
  214. - title: TSG007 - Get BDC pod status
  215. url: monitor-k8s/tsg007-view-bdc-pod-status
  216. - title: TSG015 - View BDC services (Kubernetes)
  217. url: monitor-k8s/tsg015-view-k8s-services-for-bdc
  218. - title: TSG097 - Get BDC stateful sets (Kubernetes)
  219. url: monitor-k8s/tsg097-get-statefulsets
  220. - title: TSG098 - Get BDC replicasets (Kubernetes)
  221. url: monitor-k8s/tsg098-get-replicasets
  222. - title: TSG099 - Get BDC daemonsets (Kubernetes)
  223. url: monitor-k8s/tsg099-get-daemonsets
  224. - title: TSG023 - Get all BDC objects (Kubernetes)
  225. url: monitor-k8s/tsg023-run-kubectl-get-all
  226. - title: TSG063 - Get storage classes (Kubernetes)
  227. url: monitor-k8s/tsg063-get-storage-classes
  228. - title: TSG072 - Get Persistent Volumes (Kubernetes)
  229. url: monitor-k8s/tsg072-get-persistent-volumes
  230. - title: TSG064 - Get BDC Persistent Volume Claims
  231. url: monitor-k8s/tsg064-get-persistent-volume-claims
  232. - title: TSG065 - Get BDC secrets (Kubernetes)
  233. url: monitor-k8s/tsg065-get-secrets-for-bdc-namespace
  234. - title: TSG066 - Get BDC event (Kubernetes)
  235. url: monitor-k8s/tsg066-get-kubernetes-events
  236. - title: TSG020- Describe nodes (Kubernetes)
  237. url: monitor-k8s/tsg020-describe-all-nodes
  238. - title: TSG016- Describe BDC pods
  239. url: monitor-k8s/tsg016-describe-all-pods-in-bdc-namespace
  240. - title: TSG089 - Describe BDC non-running pods
  241. url: monitor-k8s/tsg089-describe-non-running-pods-in-bdc
  242. - title: TSG010 - Get configuration contexts
  243. url: monitor-k8s/tsg010-get-kubernetes-contexts
  244. - title: TSG022 - Get external IP address for kubeadm host
  245. url: monitor-k8s/tsg022-get-external-ip-of-kubeadm-host
  246. - title: TSG042 - Get `node name` and external mounts for `Data` and `Logs` `PVCs`
  247. url: monitor-k8s/tsg042-get-hosting-node-and-data-log-mount
  248. - title: Logs
  249. url: /log-files/readme
  250. not_numbered: true
  251. expand_sections: false
  252. sections:
  253. - title: TSG001 - Run azdata copy-logs
  254. url: log-files/tsg001-copy-logs
  255. - title: TSG091 - Get the azdata CLI logs
  256. url: log-files/tsg091-get-azdata-logs
  257. - title: TSG083 - Run kubectl cluster-info dump
  258. url: log-files/tsg083-run-kubectl-cluster-info-dump
  259. - title: TSG061 - Get tail of all container logs for pods in BDC namespace
  260. url: log-files/tsg061-tail-bdc-container-logs
  261. - title: TSG062 - Get tail of all previous container logs for pods in BDC namespace
  262. url: log-files/tsg062-tail-bdc-previous-container-logs
  263. - title: TSG084 - Internal Query Processor Error
  264. url: log-files/tsg084-internal-query-process-error
  265. - title: Samples
  266. url: /sample/readme
  267. not_numbered: true
  268. expand_sections: false
  269. sections:
  270. - title: SAM001a - Query Storage Pool from SQL Server Master Pool (1 of 3) - Load sample data
  271. url: sample/sam001a-load-sample-data-into-bdc
  272. - title: SAM001b - Query Storage Pool from SQL Server Master Pool (2 of 3) - Convert data to parquet
  273. url: sample/sam001b-convert-csv-to-parquet
  274. - title: SAM001c - Query Storage Pool from SQL Server Master Pool (3 of 3) - Query HDFS from SQL Server
  275. url: sample/sam001c-query-hdfs-in-sql-server
  276. - title: SAM002 - Storage Pool (2 of 2) - Query HDFS
  277. url: sample/sam002-query-hdfs-in-sql-server
  278. - title: SAM003 - Data Pool Example
  279. url: sample/sam003-data-pool
  280. - title: SAM008 - Spark using azdata
  281. url: sample/sam008-spark-using-azdata
  282. - title: SAM009 - HDFS using azdata
  283. url: sample/sam009-hdfs-using-azdata
  284. - title: SAM010 - App using azdata
  285. url: sample/sam010-app-using-azdata
  286. - title: Install
  287. url: /install/readme
  288. not_numbered: true
  289. expand_sections: false
  290. sections:
  291. - title: SOP036 - Install kubectl command line interface
  292. url: install/sop036-install-kubectl
  293. - title: SOP037 - Uninstall kubectl command line interface
  294. url: install/sop037-uninstall-kubectl
  295. - title: SOP059 - Install Kubernetes Python module
  296. url: install/sop059-install-kubernetes-module
  297. - title: SOP060 - Uninstall kubernetes module
  298. url: install/sop060-uninstall-kubernetes-module
  299. - title: SOP062 - Install ipython-sql and pyodbc modules
  300. url: install/sop062-install-ipython-sql-module
  301. - title: SOP063 - Install azdata CLI (using package manager)
  302. url: install/sop063-packman-install-azdata
  303. - title: SOP064 - Uninstall azdata CLI (using package manager)
  304. url: install/sop064-packman-uninstall-azdata
  305. - title: SOP054 - Install azdata CLI (using pip)
  306. url: install/sop054-install-azdata
  307. - title: SOP055 - Uninstall azdata CLI (using pip)
  308. url: install/sop055-uninstall-azdata
  309. - title: SOP038 - Install azure command line interface
  310. url: install/sop038-install-az
  311. - title: SOP039 - Uninstall azure command line interface
  312. url: install/sop039-uninstall-az
  313. - title: SOP040 - Upgrade pip in ADS Python sandbox
  314. url: install/sop040-upgrade-pip
  315. - title: SOP069 - Install ODBC for SQL Server
  316. url: install/sop069-install-odbc-driver-for-sql-server
  317. - title: SOP012 - Install unixodbc for Mac
  318. url: install/sop012-brew-install-odbc-for-sql-server
  319. - title: SOP010 - Upgrade a big data cluster
  320. url: install/sop010-upgrade-bdc
  321. - title: Certificate Management
  322. url: /cert-management/readme
  323. not_numbered: true
  324. expand_sections: false
  325. sections:
  326. - title: CER001 - Generate a Root CA certificate
  327. url: cert-management/cer001-create-root-ca
  328. - title: CER002 - Download existing Root CA certificate
  329. url: cert-management/cer002-download-existing-root-ca
  330. - title: CER003 - Upload existing Root CA certificate
  331. url: cert-management/cer003-upload-existing-root-ca
  332. - title: CER004 - Download and Upload existing Root CA certificate
  333. url: cert-management/cer004-download-upload-existing-root-ca
  334. - title: CER010 - Install generated Root CA locally
  335. url: cert-management/cer010-install-generated-root-ca-locally
  336. - title: CER020 - Create Management Proxy certificate
  337. url: cert-management/cer020-create-management-service-proxy-cert
  338. - title: CER021 - Create Knox certificate
  339. url: cert-management/cer021-create-knox-cert
  340. - title: CER022 - Create App Proxy certificate
  341. url: cert-management/cer022-create-app-proxy-cert
  342. - title: CER023 - Create Controller certificate
  343. url: cert-management/cer023-create-controller-cert
  344. - title: CER030 - Sign Management Proxy certificate with generated CA
  345. url: cert-management/cer030-sign-service-proxy-generated-cert
  346. - title: CER031 - Sign Knox certificate with generated CA
  347. url: cert-management/cer031-sign-knox-generated-cert
  348. - title: CER032 - Sign App-Proxy certificate with generated CA
  349. url: cert-management/cer032-sign-app-proxy-generated-cert
  350. - title: CER033 - Sign Controller certificate with cluster Root CA
  351. url: cert-management/cer033-sign-controller-generated-cert
  352. - title: CER040 - Install signed Management Proxy certificate
  353. url: cert-management/cer040-install-service-proxy-cert
  354. - title: CER041 - Install signed Knox certificate
  355. url: cert-management/cer041-install-knox-cert
  356. - title: CER042 - Install signed App-Proxy certificate
  357. url: cert-management/cer042-install-app-proxy-cert
  358. - title: CER043 - Install signed Controller certificate
  359. url: cert-management/cer043-install-controller-cert
  360. - title: CER050 - Wait for BDC to be Healthy
  361. url: cert-management/cer050-wait-cluster-healthly
  362. - title: CER100 - Configure Cluster with Self Signed Certificates
  363. url: cert-management/cer100-create-root-ca-install-certs
  364. - title: CER101 - Configure Cluster with Self Signed Certificates using existing Root CA
  365. url: cert-management/cer101-use-root-ca-install-certs
  366. - title: Common
  367. url: /common/readme
  368. not_numbered: true
  369. expand_sections: false
  370. sections:
  371. - title: SOP028 - azdata login
  372. url: common/sop028-azdata-login
  373. - title: SOP033 - azdata logout
  374. url: common/sop033-azdata-logout
  375. - title: SOP005 - az login
  376. url: common/sop005-az-login
  377. - title: SOP006 - az logout
  378. url: common/sop006-az-logout
  379. - title: SOP007 - Version information (azdata, bdc, kubernetes)
  380. url: common/sop007-get-key-version-information
  381. - title: SOP011 - Set kubernetes configuration context
  382. url: common/sop011-set-kubernetes-context
  383. - title: SOP034 - Wait for BDC to be Healthy
  384. url: common/sop034-wait-cluster-healthly