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
150
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
Zero-downtime upgrades with SQLAlchemy + Alembic
stephenfin
0
510
OpenStack from 10,000ft
stephenfin
0
120
Teaching padawans to chop wood and carry water in their open source journey
stephenfin
0
190
What is Nova?
stephenfin
0
280
A Documentation-Driven Approach to Building APIs
stephenfin
0
160
A Lion, a Head, and a Dash of YAML (PyCon Limerick 2020)
stephenfin
0
260
Will Someone *Please* Tell Me What's Going On?
stephenfin
1
220
Trading Flexibility for Performance: The HPC Story in OpenStack
stephenfin
0
280
Working with Documentation, The OpenStack Way
stephenfin
0
220
Other Decks in Technology
See All in Technology
Scaling Technical Excellence at 104: Evolution in AWS and Developer Empowerment
scotthsieh825
1
150
VPoEの視点から見た、ヘンリーがサーバーサイドKotlinを使う理由 / Why Server-side Kotlin 2024
cho0o0
1
420
コンテナ・K8s研修 - 後半 Kubernetes 基礎&ハンズオン【MIXI 24新卒技術研修】
mixi_engineers
PRO
1
120
[NIKKEI Tech Talk] KDDI/KAG Scrum & Community for Engineering Training
curanosuke
2
220
AutomatedLabを使って内部ペンテストを勉強しよう! -やられ社内ネットワークの自動構築-
n_etupirka
1
610
DDDにおける認可の扱いとKotlinにおける実装パターン / authorization-for-ddd-and-kotlin-implement-pattern
urmot
4
390
簡単に始めるSnowflakeの機械学習
nayuts
1
190
ソフトウェアエンジニアリングの知見を活かして データ基盤をいい感じにする on Snowflake [MIERUNE BBQ #10]
mtpooh
2
150
サービスの持続的な成長と技術負債について
siva_official
PRO
10
4.4k
Docker互換のセキュアなコンテナ実行環境「Podman」超入門
devops_vtj
6
3.2k
Git 研修 Advanced【MIXI 24新卒技術研修】
mixi_engineers
PRO
0
200
クラウド利用者の「責任」をどう果たす?AWSセキュリティ対策のススメ #AWSSummit
hiashisan
0
270
Featured
See All Featured
Documentation Writing (for coders)
carmenintech
63
4.2k
KATA
mclloyd
20
13k
Product Roadmaps are Hard
iamctodd
PRO
48
10k
Side Projects
sachag
451
42k
XXLCSS - How to scale CSS and keep your sanity
sugarenia
245
1.2M
Done Done
chrislema
179
15k
A better future with KSS
kneath
231
17k
Stop Working from a Prison Cell
hatefulcrawdad
266
20k
The Success of Rails: Ensuring Growth for the Next 100 Years
eileencodes
35
6.3k
The Cost Of JavaScript in 2023
addyosmani
31
4.7k
Design by the Numbers
sachag
277
18k
The Language of Interfaces
destraynor
151
23k
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