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
140
Zero-downtime upgrades with SQLAlchemy + Alembic
stephenfin
0
720
OpenStack from 10,000ft
stephenfin
0
340
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
Windows 11 で AWS Documentation MCP Server 接続実践/practical-aws-documentation-mcp-server-connection-on-windows-11
emiki
0
950
Observability в PHP без боли. Олег Мифле, тимлид Altenar
lamodatech
0
340
OpenHands🤲にContributeしてみた
kotauchisunsun
1
420
A2Aのクライアントを自作する
rynsuke
1
170
より良いプロダクトの開発を目指して - 情報を中心としたプロダクト開発 #phpcon #phpcon2025
bengo4com
1
3.1k
PostgreSQL 18 cancel request key長の変更とRailsへの関連
yahonda
0
120
Liquid Glass革新とSwiftUI/UIKit進化
fumiyasac0921
0
200
Witchcraft for Memory
pocke
1
260
20250623 Findy Lunch LT Brown
3150
0
850
GeminiとNotebookLMによる金融実務の業務革新
abenben
0
220
20250625 Snowflake Summit 2025活用事例 レポート / Nowcast Snowflake Summit 2025 Case Study Report
kkuv
1
300
製造業からパッケージ製品まで、あらゆる領域をカバー!生成AIを利用したテストシナリオ生成 / 20250627 Suguru Ishii
shift_evolve
PRO
1
130
Featured
See All Featured
Producing Creativity
orderedlist
PRO
346
40k
Put a Button on it: Removing Barriers to Going Fast.
kastner
60
3.9k
Measuring & Analyzing Core Web Vitals
bluesmoon
7
490
GraphQLとの向き合い方2022年版
quramy
47
14k
Bootstrapping a Software Product
garrettdimon
PRO
307
110k
The Cost Of JavaScript in 2023
addyosmani
51
8.4k
The World Runs on Bad Software
bkeepers
PRO
69
11k
Making the Leap to Tech Lead
cromwellryan
134
9.3k
Designing Experiences People Love
moore
142
24k
Rebuilding a faster, lazier Slack
samanthasiow
81
9.1k
XXLCSS - How to scale CSS and keep your sanity
sugarenia
248
1.3M
ReactJS: Keep Simple. Everything can be a component!
pedronauck
667
120k
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