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
120
Zero-downtime upgrades with SQLAlchemy + Alembic
stephenfin
0
700
OpenStack from 10,000ft
stephenfin
0
170
Teaching padawans to chop wood and carry water in their open source journey
stephenfin
0
250
What is Nova?
stephenfin
0
420
A Documentation-Driven Approach to Building APIs
stephenfin
0
190
A Lion, a Head, and a Dash of YAML (PyCon Limerick 2020)
stephenfin
0
340
Will Someone *Please* Tell Me What's Going On?
stephenfin
1
290
Trading Flexibility for Performance: The HPC Story in OpenStack
stephenfin
0
350
Other Decks in Technology
See All in Technology
Winning at PHP in Production in 2025
beberlei
1
280
Kaigi Effect 2025 #rubykaigi2025_after
sue445
0
110
Как мы автоматизировали интеграционное тестирование с Gonkey и не пожалели. Паша Егорычев, Кирилл Поляков
lamodatech
0
2.1k
Part2 GitHub Copilotってなんだろう
tomokusaba
2
750
Datadog のトライアルを成功に導く技術 / Techniques for a successful Datadog trial
nulabinc
PRO
0
130
Global Azure2025(GitHub Copilot ハンズオン)
tomokusaba
2
720
Cursorを全エンジニアに配布 その先に見据えるAI駆動開発の未来 / 2025-05-13-forkwell-ai-study-1-cursor-at-loglass
itohiro73
2
430
genspark_presentation.pdf
haruki_uiru
1
240
クラウドネイティブ環境の脅威モデリング
kyohmizu
2
400
Why Platform Engineering? - マルチプロダクト・少人数 SRE の壁を越える挑戦 -
nulabinc
PRO
4
380
Pythonデータ分析実践試験 出題傾向や学習のポイントとテクニカルハイライト
terapyon
1
140
Dataverseの検索列について
miyakemito
1
190
Featured
See All Featured
How GitHub (no longer) Works
holman
314
140k
Gamification - CAS2011
davidbonilla
81
5.3k
Put a Button on it: Removing Barriers to Going Fast.
kastner
60
3.8k
Keith and Marios Guide to Fast Websites
keithpitt
411
22k
Making Projects Easy
brettharned
116
6.2k
Designing for Performance
lara
608
69k
Performance Is Good for Brains [We Love Speed 2024]
tammyeverts
10
790
Build your cross-platform service in a week with App Engine
jlugia
230
18k
Building Flexible Design Systems
yeseniaperezcruz
329
39k
Thoughts on Productivity
jonyablonski
69
4.6k
Facilitating Awesome Meetings
lara
54
6.3k
The Pragmatic Product Professional
lauravandoore
33
6.6k
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