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
170
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
150
Zero-downtime upgrades with SQLAlchemy + Alembic
stephenfin
0
740
OpenStack from 10,000ft
stephenfin
0
400
Teaching padawans to chop wood and carry water in their open source journey
stephenfin
0
260
What is Nova?
stephenfin
0
440
A Documentation-Driven Approach to Building APIs
stephenfin
0
200
A Lion, a Head, and a Dash of YAML (PyCon Limerick 2020)
stephenfin
0
350
Will Someone *Please* Tell Me What's Going On?
stephenfin
1
310
Trading Flexibility for Performance: The HPC Story in OpenStack
stephenfin
0
370
Other Decks in Technology
See All in Technology
分散トレーシングによる コネクティッドカーのデータ処理見える化の試み
thatsdone
0
250
AI Ready API ─ AI時代に求められるAPI設計とは?/ AI-Ready API - Designing MCP and APIs in the AI Era
yokawasa
21
5.9k
ゼロから始めるSREの事業貢献 - 生成AI時代のSRE成長戦略と実践 / Starting SRE from Day One
shinyorke
PRO
0
250
The Madness of Multiple Gemini CLIs Developing Simultaneously with Jujutsu
gunta
1
2.6k
Webの技術とガジェットで那須の子ども達にワクワクを! / IoTLT_20250720
you
PRO
0
130
「現場で活躍するAIエージェント」を実現するチームと開発プロセス
tkikuchi1002
6
1.1k
増え続ける脆弱性に立ち向かう: 事前対策と優先度づけによる 持続可能な脆弱性管理 / Confronting the Rise of Vulnerabilities: Sustainable Management Through Proactive Measures and Prioritization
nttcom
1
190
メモ整理が苦手な者による頑張らないObsidian活用術
optim
0
130
Data Engineering Study#30 LT資料
tetsuroito
1
610
ML Pipelineの開発と運用を OpenTelemetryで繋ぐ @ OpenTelemetry Meetup 2025-07
getty708
0
290
Jitera Company Deck / JP
jitera
0
180
Power Automate のパフォーマンス改善レシピ / Power Automate Performance Improvement Recipes
karamem0
0
230
Featured
See All Featured
Scaling GitHub
holman
461
140k
The Pragmatic Product Professional
lauravandoore
35
6.8k
How to train your dragon (web standard)
notwaldorf
96
6.1k
Gamification - CAS2011
davidbonilla
81
5.4k
What’s in a name? Adding method to the madness
productmarketing
PRO
23
3.6k
Designing Dashboards & Data Visualisations in Web Apps
destraynor
231
53k
Cheating the UX When There Is Nothing More to Optimize - PixelPioneers
stephaniewalter
283
13k
Making the Leap to Tech Lead
cromwellryan
134
9.4k
Distributed Sagas: A Protocol for Coordinating Microservices
caitiem20
331
22k
The Straight Up "How To Draw Better" Workshop
denniskardys
235
140k
Reflections from 52 weeks, 52 projects
jeffersonlam
351
21k
Typedesign – Prime Four
hannesfritz
42
2.7k
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