forked from rackerlabs/genestack
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
318 lines (307 loc) · 12.7 KB
/
mkdocs.yml
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
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
---
site_name: Open Infrastructure
site_description: >-
Open Infrastructure, a Rackspace solution, is a collection of open-source tools and technologies that provide a
flexible, scalable, and cost-effective infrastructure solution for your business. This documentation provides
information on how to deploy and manage Open-Infrastructure in your environment. It also provides information on how
to onboard and manage your workloads on OpenStack, Kubernetes, and other open-source technologies.
site_url: https://docs.rackspacecloud.com
theme:
name: material
logo: assets/images/rackspace_logo-white.svg
favicon: assets/images/pngegg.png
icon:
logo: logo
palette:
- media: "(prefers-color-scheme)"
toggle:
icon: material/link
name: Switch to dark mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: black
accent: red
toggle:
icon: material/toggle-switch
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: rxt
primary: black
accent: red
toggle:
icon: material/toggle-switch-off
name: Switch to system preference
font:
text: Roboto
code: Roboto Mono
features:
- announce.dismiss
- header.autohide
- content.action.edit
- content.action.view
- content.code.annotate
- content.code.copy
- content.tooltips
- navigation.footer
- navigation.indexes
- navigation.instant
- navigation.instant.progress
- navigation.instant.preview
- navigation.prune
- navigation.path
- navigation.sections
- navigation.tabs
- navigation.top
- navigation.tracking
- search.highlight
- search.share
- search.suggest
- toc.follow
copyright: Copyright © 2024 RACKSPACE TECHNOLOGY
extra:
social:
- icon: fontawesome/brands/linkedin
link: https://linkedin.com/company/rackspace
name: Rackspace on LinkedIn
- icon: fontawesome/brands/x-twitter
link: https://twitter.com/rackspace
name: Rackspace on X
- icon: fontawesome/brands/github
link: https://github.com/rackerlabs
name: Rackspace on github
- icon: fontawesome/brands/discord
link: https://discord.gg/2mN5yZvV3a
name: Rackspace on Discord
- icon: fontawesome/solid/blog
link: https://blog.rackspacecloud.com/
extra_css:
- overrides/stylesheets/adr.css
- overrides/stylesheets/admonition.css
plugins:
- search
- swagger-ui-tag
- mkdocs-material-adr/adr
- glightbox
markdown_extensions:
- admonition
- attr_list
- md_in_html
- def_list
- footnotes
- 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_code_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.details
- pymdownx.tabbed:
alternate_style: true
- pymdownx.snippets:
restrict_base_path: false
repo_name: rackerlabs/genestack
repo_url: https://github.com/rackerlabs/genestack
dev_addr: "127.0.0.1:8001"
edit_uri: "edit/main/docs"
nav:
- Welcome: index.md
- Overview:
- Architecture: genestack-architecture.md
- Components: genestack-components.md
- Swift Object Storage: openstack-object-storage-swift.md
- Cloud Design:
- Overview: openstack-cloud-design-overview.md
- Regions in OpenStack: openstack-cloud-design-regions.md
- Availability Zones in OpenStack: openstack-cloud-design-az.md
- Host Aggregates in OpenStack: openstack-cloud-design-ha.md
- Accelerated Computing:
- Overview: accelerated-computing-overview.md
- Infrastructure: accelerated-computing-infrastructure.md
- Other Design Documentation:
- Disaster Recovery for OpenStack Clouds: openstack-cloud-design-dr.md
- Genestack Infrastructure Design: openstack-cloud-design-genestack-infra.md
- Deployment Guide:
- What is Genestack?: deployment-guide-welcome.md
- Getting Started:
- Building Virtual Environments: build-test-envs.md
- Getting the code: genestack-getting-started.md
- Open Infrastructure:
- Kubernetes:
- k8s-overview.md
- Providers:
- Kubespray: k8s-kubespray.md
- Post Deployment:
- Kubernetes Labels: k8s-labels.md
- Kubernetes Dashboard: k8s-dashboard.md
- Kubernetes Taint: k8s-taint.md
- Retrieve kube config: k8s-config.md
- Prometheus: prometheus.md
- OpenStack Preparations: openstack-helm-make.md
- Storage:
- storage-overview.md
- Ceph Internal: storage-ceph-rook-internal.md
- Ceph External: storage-ceph-rook-external.md
- NFS External: storage-nfs-external.md
- TopoLVM: storage-topolvm.md
- External Storage CSI: storage-external-block.md
- Secrets:
- Sealed Secrets: sealed-secrets.md
- Infrastructure:
- infrastructure-overview.md
- Namespace: infrastructure-namespace.md
- MetalLB: infrastructure-metallb.md
- Gateway API: infrastructure-gateway-api.md
- MariaDB:
- infrastructure-mariadb.md
- RabbitMQ:
- infrastructure-rabbitmq.md
- Memcached: infrastructure-memcached.md
- Libvirt: infrastructure-libvirt.md
- OVN: infrastructure-ovn-setup.md
- Loki: infrastructure-loki.md
- OpenStack:
- openstack-overview.md
- OpenStack Services:
- Keystone: openstack-keystone.md
- Glance: openstack-glance.md
- Heat: openstack-heat.md
- Barbican: openstack-barbican.md
- Block Storage:
- Cinder: openstack-cinder.md
- LVM iSCSI: openstack-cinder-lvmisci.md
- NETAPP:
- Worker: openstack-cinder-netapp-worker.md
- Containerized: openstack-cinder-netapp-container.md
- FIPS Cinder Encryption: openstack-cinder-fips-encryption.md
- Compute Kit:
- Compute Overview: openstack-compute-kit.md
- Secrets: openstack-compute-kit-secrets.md
- Placement: openstack-compute-kit-placement.md
- Nova: openstack-compute-kit-nova.md
- Neutron: openstack-compute-kit-neutron.md
- Dashboards:
- Horizon: openstack-horizon.md
- skyline: openstack-skyline.md
- Octavia: openstack-octavia.md
- Magnum: openstack-magnum.md
- Metering:
- PostgreSQL: infrastructure-postgresql.md
- Gnocchi: openstack-gnocchi.md
- Ceilometer: openstack-ceilometer.md
- Monitoring:
- Monitoring Overview: prometheus-monitoring-overview.md
- Getting Started: monitoring-getting-started.md
- Grafana: grafana.md
- Kube-OVN Monitoring: prometheus-kube-ovn.md
- NGINX Gateway Fabric Monitoring: prometheus-nginx-gateway.md
- RabbitMQ Exporter: prometheus-rabbitmq-exporter.md
- Memcached Exporter: prometheus-memcached-exporter.md
- MariaDB Exporter: prometheus-mysql-exporter.md
- Postgres Exporter: prometheus-postgres-exporter.md
- Openstack Exporter: prometheus-openstack-metrics-exporter.md
- Blackbox Exporter: prometheus-blackbox-exporter.md
- Pushgateway: prometheus-pushgateway.md
- Custom Node Metrics: prometheus-custom-node-metrics.md
- Alert Manager Examples:
- alertmanager-slack.md
- alertmanager-msteams.md
- alertmanager-pagerduty.md
- Operational Guide:
- Genestack:
- Supporting multi-region: multi-region-support.md
- Running Upgrades: genestack-upgrade.md
- Resource Metering:
- Metering Overview: metering-overview.md
- Ceilometer: metering-ceilometer.md
- Gnocchi: metering-gnocchi.md
- Billing Tenants: metering-billing.md
- Chargebacks: metering-chargebacks.md
- Infrastructure:
- Kubernetes:
- Etcd Backup: etcd-backup.md
- Adding New Nodes: adding-new-node.md
- Running Kubespray Upgrades: k8s-kubespray-upgrade.md
- OVN:
- Introduction: ovn-intro.md
- Troubleshooting: ovn-troubleshooting.md
- Traffic flow introduction: ovn-traffic-flow-intro.md
- Database Backup: infrastructure-ovn-db-backup.md
- Monitoring introduction: ovn-monitoring-introduction.md
- Claim Storm alert: ovn-alert-claim-storm.md
- Updating Kube OVN to OpenStack Configuration: ovn-kube-ovn-openstack.md
- MariaDB:
- Operations: infrastructure-mariadb-ops.md
- Observability:
- Observability Overview: observability-info.md
- Monitoring Overview: monitoring-info.md
- Alerting Overview: alerting-info.md
- Logging Overview: genestack-logging.md
- Third Party Tools:
- OSIE: extra-osie.md
- OpenStack:
- CLI Access:
- Generating Clouds YAML: openstack-clouds.md
- Compute:
- Nova Flavor Creation: openstack-flavors.md
- Nova CPU Allocation Ratio: openstack-cpu-allocation-ratio.md
- Nova PCI Passthrough: openstack-pci-passthrough.md
- Host Aggregates: openstack-host-aggregates.md
- Quota Management:
- Quota Management: openstack-quota-managment.md
- Images:
- Glance Images Creation: openstack-glance-images.md
- Identity:
- Keystone Federation to Rackspace: openstack-keystone-federation.md
- Keystone Readonly Users: openstack-keystone-readonly.md
- Networking:
- Creating Networks: openstack-neutron-networks.md
- Magnum:
- Creating kubernetes clusters: magnum-kubernetes-cluster-setup-guide.md
- Octavia:
- Creating Cloud Load Balancers: octavia-loadbalancer-setup-guide.md
- Object Storage:
- Operating Swift Object Storage: openstack-swift-operators-guide.md
- Service Overrides: openstack-service-overrides.md
- Resource and Project Lookups: openstack-resource-lookups.md
- Working locally With Docs: mkdocs-howto.md
- Cloud Onboarding:
- Cloud Onboarding Welcome: cloud-onboarding-welcome.md
- Openstack Installing CLI Tools: openstack-deploy-cli.md
- OpenStack Getting Started: openstack-getting-started-cli.md
- Openstack Security Groups: openstack-security-groups.md
- Openstack Floating Ips: openstack-floating-ips.md
- Openstack Keypairs: openstack-keypairs.md
- Openstack Servers: openstack-servers.md
- Openstack Routers: openstack-router.md
- Openstack Images: openstack-images.md
- Openstack Metrics: openstack-metrics.md
- Openstack Object Store Swift CLI: storage-object-store-swift-cli.md
- Openstack Object Store Openstack CLI: storage-object-store-openstack-cli.md
- Openstack Object Store Skyline GUI: storage-object-store-skyline-gui.md
- Openstack Object Store 3rd Party SDK, Tools: storage-object-store-swift-3rd-party.md
- Openstack Snapshot: openstack-snapshot.md
- Openstack Volumes: openstack-volumes.md
- Openstack Load Balancers: openstack-load-balancer.md
- Openstack Networks: openstack-networks.md
- Openstack Quotas: openstack-quota.md
- Security Primer:
- Introduction: security-introduction.md
- Security In Phases: security-lifecycle.md
- Cloud Security: security-stages.md
- Summary: security-summary.md
- Blog: https://blog.rackspacecloud.com/
- Status: api-status.md
- Style Guide: documentation-standards.md