Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Features
Speaker Deck
PRO
Sign in
Sign up for free
Search
Search
OpenStack + Sphinx In A Tree
Search
Stephen Finucane
November 06, 2017
Technology
1
180
OpenStack + Sphinx In A Tree
An overview of the various Sphinx extensions available within the OpenStack ecosystem.
Stephen Finucane
November 06, 2017
Tweet
Share
More Decks by Stephen Finucane
See All by Stephen Finucane
API Contracts: Bringing OpenAPI and typing to OpenStack
stephenfin
0
160
Zero-downtime upgrades with SQLAlchemy + Alembic
stephenfin
0
760
OpenStack from 10,000ft
stephenfin
0
540
Teaching padawans to chop wood and carry water in their open source journey
stephenfin
0
260
What is Nova?
stephenfin
0
460
A Documentation-Driven Approach to Building APIs
stephenfin
0
210
A Lion, a Head, and a Dash of YAML (PyCon Limerick 2020)
stephenfin
0
360
Will Someone *Please* Tell Me What's Going On?
stephenfin
1
310
Trading Flexibility for Performance: The HPC Story in OpenStack
stephenfin
0
380
Other Decks in Technology
See All in Technology
2025年にHCP Vaultを学び直して見えた景色 / Lessons and New Perspectives from Relearning HCP Vault in 2025
aeonpeople
0
230
AWSで始める実践Dagster入門
kitagawaz
1
570
ZOZOマッチのアーキテクチャと技術構成
zozotech
PRO
3
1.4k
企業の生成AIガバナンスにおけるエージェントとセキュリティ
lycorptech_jp
PRO
2
140
AI時代に非連続な成長を実現するエンジニアリング戦略
sansantech
PRO
3
1.2k
サンドボックス技術でAI利活用を促進する
koh_naga
0
200
オブザーバビリティが広げる AIOps の世界 / The World of AIOps Expanded by Observability
aoto
PRO
0
330
「全員プロダクトマネージャー」を実現する、Cursorによる仕様検討の自動運転
applism118
10
3.8k
Flutterでキャッチしないエラーはどこに行く
taiju59
0
220
roppongirb_20250911
igaiga
0
190
250905 大吉祥寺.pm 2025 前夜祭 「プログラミングに出会って20年、『今』が1番楽しい」
msykd
PRO
1
630
フルカイテン株式会社 エンジニア向け採用資料
fullkaiten
0
8.7k
Featured
See All Featured
Improving Core Web Vitals using Speculation Rules API
sergeychernyshev
18
1.1k
For a Future-Friendly Web
brad_frost
180
9.9k
How to Create Impact in a Changing Tech Landscape [PerfNow 2023]
tammyeverts
53
2.9k
Let's Do A Bunch of Simple Stuff to Make Websites Faster
chriscoyier
507
140k
Save Time (by Creating Custom Rails Generators)
garrettdimon
PRO
32
1.5k
The Invisible Side of Design
smashingmag
301
51k
A Tale of Four Properties
chriscoyier
160
23k
JavaScript: Past, Present, and Future - NDC Porto 2020
reverentgeek
51
5.6k
The Art of Programming - Codeland 2020
erikaheidi
55
13k
Visualization
eitanlees
148
16k
Practical Tips for Bootstrapping Information Extraction Pipelines
honnibal
PRO
23
1.4k
How to Think Like a Performance Engineer
csswizardry
26
1.9k
Transcript
OpenStack + Sphinx In A Tree Stephen Finucane (@stephenfin) 2017-11-06,
OpenStack Summit Sydney
Intro What’s a Directive? .. directive_name:: [arg [arg...]] :option: [option_arg]
Body text here.
Intro What can OpenStack offer? • oslo.config • oslo.policy •
cliff • stevedore
oslo.config Two extensions • A config documentation directive and role
• A config generator hook
oslo.config Directive and Role .. show-options:: oslo.config oslo.log :oslo.config:option:`config_file`
https://docs.openstack.org/nova/pike/configuration/config.html
oslo.config Config Generator config_generator_config_file = [ ('../../etc/glance-api.conf', 'api'), ('../../etc/glance-cache.conf', 'cache'),
('../../etc/glance-glare.conf', None), ('../../etc/glance-registry.conf', None), ('../../etc/glance-scrubber.conf', None), ]
https://docs.openstack.org/nova/pike/configuration/sample-config.html
oslo.policy Also has two extensions • A policy documentation directive
• A policy generator hook
oslo.policy Directive .. show-policy:: :config-file: etc/nova/nova-policy-generator.conf
https://docs.openstack.org/nova/pike/configuration/policy.html
oslo.policy Config Generator policy_generator_config_file = '../../etc/nova/nova-policy-generator.conf' sample_policy_basename = '_static/nova'
https://docs.openstack.org/nova/pike/configuration/sample-policy.html
cliff One directive that handles multiple commands Uses standard domain
directives; program, option, envvar
cliff Directive .. autoprogram-cliff:: openstack.compute.v2 :command: server add fixed ip
:prog:`openstack server add fixed ip`
https://docs.openstack.org/python-openstackclient/latest/cli/command-objects/access-token.html
Stevedore A single directive for listing plugins for an entrypoint
Stevedore Directive .. list-plugins:: stevedore.example.formatter
https://docs.openstack.org/oslo.messaging/latest/admin/drivers.html
Wrap Up Links & Resources • oslo.config Directive • oslo.config
Configuration Generator • oslo.policy Directive • oslo.policy Configuration Generator • cliff Directive • stevedore Directive