FilesExpand file tree

 main

/

mkdocs.yml

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

263 lines (252 loc) · 8.58 KB

 main

/

mkdocs.yml

Top

File metadata and controls

• Code
• Blame

263 lines (252 loc) · 8.58 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

---

site_name: UnderStack

site_description: |-

UnderStack is a collection of open-source tools and technologies that provides

flexible, scalable, and cost-effective infrastructure management solution. The

focus is on deploying bare metal in data centers with functional DCIM and IPAM.

theme:

name: material

logo: assets/logo.png

favicon: assets/favicon.png

palette:

- media: "(prefers-color-scheme: light)"

scheme: rackspace-light

toggle:

icon: material/brightness-7

name: Switch to dark mode

- media: "(prefers-color-scheme: dark)"

scheme: rackspace-dark

toggle:

icon: material/brightness-4

name: Switch to light mode

features:

- content.action.edit

- content.action.view

- content.code.annotate

- content.code.copy

- content.tooltips

- navigation.expand

- navigation.indexes

- navigation.instant

- navigation.instant.progress

- navigation.prune

- navigation.sections

- navigation.tabs

- navigation.tabs.sticky

- navigation.top

- navigation.tracking

- search.highlight

- search.share

- search.suggest

- toc.follow

repo_name: rackerlabs/understack

repo_url: https://github.com/rackerlabs/understack

dev_addr: "127.0.0.1:8001"

edit_uri: "edit/main/docs"

copyright: Copyright © 2024 Rackspace Technology, Inc.

markdown_extensions:

- admonition

- attr_list

- def_list

- md_in_html

- pymdownx.caret

- pymdownx.tasklist:

custom_checkbox: true

- pymdownx.superfences:

custom_fences:

- name: python

class: python

validator: !!python/name:markdown_exec.validator

format: !!python/name:markdown_exec.formatter

- name: mermaid

class: mermaid

format: !!python/name:pymdownx.superfences.fence_div_format

- pymdownx.emoji:

emoji_index: !!python/name:material.extensions.emoji.twemoji

emoji_generator: !!python/name:material.extensions.emoji.to_svg

- pymdownx.highlight:

anchor_linenums: true

line_spans: __span

pygments_lang_class: true

- pymdownx.inlinehilite

- pymdownx.mark

- pymdownx.snippets

- nl2br

- admonition

- pymdownx.details

- pymdownx.tabbed:

alternate_style: true

extra_css:

- stylesheets/rackspace-theme.css

extra_javascript:

- assets/mermaid.min.js

- assets/mermaid-init.js

plugins:

- search

- include_dir_to_nav:

sort_file: true

sort_directory: true

- macros:

module_name: docs/macros

- callouts

- mermaid-zoom

validation:

omitted_files: warn

absolute_links: warn

unrecognized_links: warn

anchors: warn

extra:

auth_url: !ENV [OS_AUTH_URL, "https://your.endpoint.url/v3"]

region_name: !ENV [OS_REGION_NAME, "my-site"]

nav:

- Home: index.md

- Overview:

- vision.md

- 'Prerequisites':

- kubernetes.md

- openstack-helm.md

- 'Configuration':

- secrets.md

- networking.md

- Components:

- component-overview.md

- Networking:

- component-networking-neutron.md

- component-argo-workflows.md

- component-understack-workflows.md

- component-ansible.md

- 'Design Guide':

- design-guide/intro.md

- design-guide/add-remove-app.md

- 'Hardware Definitions':

- design-guide/device-types.md

- design-guide/hardware-traits.md

- design-guide/flavors.md

- design-guide/neutron-networking.md

- design-guide/argo-workflows.md

- design-guide/argo-events.md

- 'Deployment Guide':

- deploy-guide/welcome.md

- deploy-guide/requirements.md

- Quick Start: deploy-guide/gitops-install.md

- Preparing Our Deployment:

- deploy-guide/deploy-repo.md

- deploy-guide/config-dex.md

- deploy-guide/config-openstack.md

- deploy-guide/secrets-eso-setup.md

- deploy-guide/openstack-automation-users.md

- deploy-guide/nautobot-secrets.md

- deploy-guide/auth.md

- deploy-guide/config-argo-workflows.md

- Starting the Deployment:

- deploy-guide/management-cluster.md

- deploy-guide/global-cluster.md

- deploy-guide/site-cluster.md

- Post Deployment:

- deploy-guide/load-balancers.md

- deploy-guide/testing-verification.md

- deploy-guide/troubleshooting.md

- Further Actions:

- deploy-guide/extra-sites.md

- deploy-guide/override-openstack-svc-config.md

- Component Reference:

- deploy-guide/components/index.md

- deploy-guide/components/argo-events-workflows.md

- deploy-guide/components/argo-events.md

- deploy-guide/components/argo-workflows.md

- deploy-guide/components/cdn.md

- deploy-guide/components/cert-manager.md

- deploy-guide/components/chrony.md

- deploy-guide/components/cilium.md

- deploy-guide/components/cinder.md

- deploy-guide/components/cluster-issuer.md

- deploy-guide/components/cnpg-system.md

- deploy-guide/components/dex.md

- deploy-guide/components/envoy-configs.md

- deploy-guide/components/envoy-gateway.md

- deploy-guide/components/etcdbackup.md

- deploy-guide/components/external-dns.md

- deploy-guide/components/external-secrets.md

- deploy-guide/components/glance.md

- deploy-guide/components/global-workflows.md

- deploy-guide/components/horizon.md

- deploy-guide/components/ingress-nginx.md

- deploy-guide/components/ironic.md

- deploy-guide/components/karma.md

- deploy-guide/components/keystone.md

- deploy-guide/components/mariadb-operator.md

- deploy-guide/components/monitoring.md

- deploy-guide/components/nautobot-api-tokens.md

- deploy-guide/components/nautobot-site.md

- deploy-guide/components/nautobot.md

- deploy-guide/components/nautobotop.md

- deploy-guide/components/nautobot-worker.md

- deploy-guide/components/neutron.md

- deploy-guide/components/nova.md

- deploy-guide/components/octavia.md

- deploy-guide/components/openebs.md

- deploy-guide/components/openstack-exporter.md

- deploy-guide/components/openstack-helm.md

- deploy-guide/components/openstack-memcached.md

- deploy-guide/components/openstack-resource-controller.md

- deploy-guide/components/openstack.md

- deploy-guide/components/opentelemetry-operator.md

- deploy-guide/components/openvswitch.md

- deploy-guide/components/otel-collector.md

- deploy-guide/components/ovn.md

- deploy-guide/components/placement.md

- deploy-guide/components/rabbitmq-system.md

- deploy-guide/components/rook.md

- deploy-guide/components/rook-ceph-cluster.md

- deploy-guide/components/rook-ceph-operator.md

- deploy-guide/components/sealed-secrets.md

- deploy-guide/components/site-workflows.md

- deploy-guide/components/skyline.md

- deploy-guide/components/snmp-exporter.md

- deploy-guide/components/undersync.md

- 'Operator Guide':

- operator-guide/index.md

- 'OpenStack':

- operator-guide/openstack-ironic.md

- operator-guide/openstack-ironic-inspection-guide.md

- operator-guide/openstack-ironic-change-boot-interface.md

- operator-guide/openstack-ironic-console.md

- operator-guide/openstack-neutron.md

- operator-guide/openstack-placement.md

- 'Networking':

- operator-guide/openstack-neutron.md

- operator-guide/ovs-ovn.md

- 'Infrastructure':

- operator-guide/argocd-helm-chart.md

- operator-guide/workflows.md

- operator-guide/openstack-nautobot-sync.md

- operator-guide/monitoring.md

- operator-guide/gateway-api.md

- operator-guide/bmc-password.md

- operator-guide/mariadb-operator.md

- operator-guide/mariadb-upgrade-runbook.md

- operator-guide/postgres-operator.md

- operator-guide/rabbitmq.md

- operator-guide/rook-ceph.md

- operator-guide/nautobot.md

- operator-guide/nautobotop.md

- operator-guide/nautobot-celery-queues.md

- operator-guide/nautobot-mtls-certificate-renewal.md

- operator-guide/troubleshooting-osh.md

- operator-guide/logging.md

- operator-guide/ansible-local-usage.md

- 'Hardware':

- operator-guide/device-types.md

- operator-guide/flavors.md

- operator-guide/server-firmware-update.md

- 'Scripts and Tools':

- operator-guide/scripts.md

- operator-guide/understackctl.md

- 'User Guide':

- user-guide/index.md

- user-guide/openstack-cli.md

- user-guide/openstack-image.md

- user-guide/openstack-resource-controller.md

- user-guide/openstack-console.md

- user-guide/server-firmware-update.md

- Workflows: workflows/