OPENSTACKDOCSTHEME(1) openstackdocstheme OPENSTACKDOCSTHEME(1) (NAME) openstackdocstheme - Sphinx openstackdocstheme Sphinx (Open Infrastructure Foundation) . openstackdocs docs.openstack.org developer.openstack.org . OpenStack (Technical Committee) . starlingxdocs docs.starlingx.io . StarlingX (Technical Steering Committee) . (USING THE THEME) : OpenStack . : Sphinx . 1. (requirements) openstackdocstheme ( test-requirements.txt). 2. oslosphinx ( ) oslosphinx conf.py import oslosphinx . 3. 'openstackdocstheme' Sphinx : extensions = [ # ... 'openstackdocstheme', # ... ] html_theme = 'openstackdocs' 4. git https://opendev.org . openstackdocs_repo_name . 'openstack/python-glanceclient'. openstackdocs_use_storyboard StoryBoard True . : StoryBoard bug_project bug_tag . openstackdocs_bug_project . launchpad python-glanceclient . "Report a bug" ( ) . StoryBoard . openstackdocs_bug_tag Launchpad. . . StoryBoard . launchpad : # openstackdocstheme options openstackdocs_repo_name = 'openstack/python-glanceclient' openstackdocs_bug_project = 'python-glanceclient' openstackdocs_bug_tag = '' StoryBoard : # openstackdocstheme options openstackdocs_repo_name = 'openstack/infra-manual' openstackdocs_use_storyboard = true 5. . o project o html_last_updated_fmt 6. . api-guide api-ref releasenotes . openstackdocs_auto_version True False . . o version o release 7. () . . openstackdocs_auto_name false project . 8. () PDF. PDF . openstack_pdf_link True . doc-.pdf (top-level) openstackdocs_repo_name . : openstackdocs_repo_name = "openstack/python-glanceclient" python-glanceclient doc-python-glanceclient.pdf . openstackdocs_pdf_filename . 2.2.0: openstack_pdf_link openstackdocs_pdf_filename . 2.1.0: repository_name bug_project bug_tag use_storyboard openstackdocs_repo_name openstackdocs_bug_project openstackdocs_bug_tag openstackdocs_use_storyboard . . 2.1.0: openstackdocs_auto_version openstackdocs_auto_name . 1.20: openstackdocstheme html_last_updated_fmt HTML latex_engine latex_elements PDF . . (ADDITIONAL CONFIGURATION) API html_theme_options conf.py : # To use the API Reference sidebar dropdown menu, # uncomment the html_theme_options parameter. The theme # variable, sidebar_dropdown, should be set to `api_ref`. # Otherwise, the list of links for the User and Ops docs # appear in the sidebar dropdown menu. html_theme_options = { # ... "sidebar_dropdown": "api_ref", "sidebar_mode": "toc", # ... } . sidebar_search True : html_theme_options = { # ... "sidebar_search": True, # ... } git html_theme_options conf.py . False : html_theme_options = { # ... "show_other_versions": "True", # ... } Mitaka html_theme_options conf.py . None : html_theme_options = { # ... "earliest_published_series": "grizzly", # ... } : release-notes . (badge) stable/ . api-ref api-guide releasenotes . html display_badge : html_theme_options = { # ... "display_badge": False, # ... } (TOC) ( ) ( ) . TOC TOC : html_theme_options = { # ... "display_global_toc_section": False, # ... } docs.openstack.org ("OpenStack Docs") (tooltip) : html_theme_options = { # ... "root_title": "OpenStack Governance", # ... } openstack_projects . master latest . conf.py : openstack_projects = ['horizon'] : :horizon-doc:`Launching Instances with Horizon ` : ( master ) . (DEMONSTRATION EXAMPLE) . API . [: ] [] (Demo documentation) . (Sidebar) . . . . (Glossary) : Cactus OpenStack . Compute (nova) Object Storage (swift) Image (glance) . (Cactus) OpenStack . OpenStack (summit) . CADF Cloud Auditing Data Federation (CADF) . CADF OpenStack Identity . CALL RPC OpenStack . . (Literal Blocks) : [DEFAULT] ... my_ip = 10.0.0.31 vnc_enabled = True vncserver_listen = 0.0.0.0 vncserver_proxyclient_address = 10.0.0.31 novncproxy_base_url = http://controller:6080/vnc_auto.html : def builder_inited(app): theme_dir = os.path.join(os.path.dirname(__file__), 'theme') LOG.info('Using openstack theme from %s' % theme_dir) # Insert our theme directory at the front of the search path and # force the theme setting to use the one in the package. This is # done here, instead of in setup(), because conf.py is read after # setup() runs, so if the conf contains these values the user # values overwrite these. That's not bad for the theme, but it # breaks the search path. app.config.html_theme_path.insert(0, theme_dir) # Set the theme name app.config.html_theme = 'openstack' # Re-initialize the builder, if it has the method for setting up # the templates and theme. if hasattr(app.builder, 'init_templates'): app.builder.init_templates() ..code-block: ini pygments : [DEFAULT] ... my_ip = 10.0.0.31 vnc_enabled = True vncserver_listen = 0.0.0.0 vncserver_proxyclient_address = 10.0.0.31 novncproxy_base_url = http://controller:6080/vnc_auto.html (Tables) : (OpenStack projects) +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------+--------------------------------------+ | | | | +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------+--------------------------------------+ |Nova | | | | | (Compute) | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | (bare | | | | metal) | | | | | | | | | | | | . | +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------+--------------------------------------+ |Neutron | (Networking) | OpenStack Neutron | | | | | | | | SDN | | | | | | | | | | | | (NaaS) | | | | | | | | | | | | . | +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------+--------------------------------------+ |Swift | | Swift | | | (Object store) | | | | | /blob | | | | | | | | | | | | | | | | | | | | . | | | | | | | | | | | | Swift | | | | | | | | | | | | | | | | | | | | | | | | . | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | . Swift | | | | | | | | | | | | | | | | | | | | | | | | . | +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------+--------------------------------------+ |... | ... | ... | | (Notices) | | | | . | | | | (note) | | | |: | | | |0.0 | | | |3.5 | | | | . | | | | | | | |168u | | | | | | | |168u | | | | (important) | | | |: | | | |0.0 | | | |3.5 | | | | . | | | | | | | |168u | | | | | | | |168u | | | | (tip) | | | |: | | | |0.0 | | | |3.5 | | | | . | | | | | | | |168u | | | | | | | |168u | | | | (caution) | | | |: | | | |0.0 | | | |3.5 | | | | . | | | | | | | |168u | | | | | | | |168u | | | | (seealso) | | | | : | | | |0.0 | | | |3.5 | | | | . | | | | | | | |168u | | | | | | | |168u | | | | (warning) | | | |: | | | |0.0 | | | |3.5 | | | | . | | | | | | | |168u | | | | | | | |168u | | | | | | | | 9.0.0-Mitaka . | | | | | | | | 10.0.0-Newton . | | | | | | | | 10.0.0-Newton : ! | | | | | | | | 11.0.0-Ocata : ! | | | | | | | | 11.0.0-Ocata : Notices . | | | | | | | | 12.0.0-Pike : | | | | | | | | | | | | (instance) (security group) ping SSH . IP . <#add-a-rule-to-the-default-security-group> . | | | | (Key pairs) SSH . cloud-init . . <#import-a-key-pair> . | | | | OpenStack . . ? (TODO!) . | | | | OpenStack IP . IP . IP IP (floating IP) . IP IP ..SS | | | | SSH ICMP (ping) . | | | | | | | | SSH ICMP | | | | . | | | | | | | | . | | | |: | | | |0.0 | | | |3.5 | | | | | | | | . | | | | | | | |168u | | | | | | | |168u | | | |0.0 | | | |1. 3 | | | | Access & | | | |Security . Security Groups | | | | . | | | |2. 3 | | | | (default) Edit Rules . | | | |3. 3 | | | | SSH Add Rule . | | | |4. 3 | | | | Add Rule : | | | |box center; | | | |l|l. | | | |Rule | SSH | | +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------+--------------------------------------+ |Remote | CIDR | | +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------+--------------------------------------+ |CIDR | 0.0.0.0/0 | | +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------+--------------------------------------+ : IP IP CIDR . 5. Add . SSH 22 IP . 6. ICMP Add Rule . 7. Add Rule : +----------+-----------+ |Rule | All ICMP | +----------+-----------+ |Direction | Ingress | +----------+-----------+ |Remote | CIDR | +----------+-----------+ |CIDR | 0.0.0.0/0 | +----------+-----------+ 8. Add . ICMP . . 1. Access & Security . 2. Keypairs . 3. Create Keypair . 4. Create Keypair Create Keypair . 5. . 1. Access & Security . 2. Keypairs . 3. Import Keypair . 4. Import Keypair Public Key Import Keypair . 5. *.pem . 6. : $ chmod 0600 yourPrivateKey.pem : PuTTYgen *.pem *.ppk . WinSCP PuTTYgen . 7. SSH ssh-add : $ ssh-add yourPrivateKey.pem Compute . Access & Security . IP OpenStack IP . IP . IP IP . IP IP . IP . 1. Access & Security . 2. Floating IPs IP . 3. Allocate IP to Project . 4. IP . 5. Allocate IP . 6. Floating IPs Associate . 7. Manage Floating IP Associations : o IP Address + IP . o Ports to be associated . IP . 8. Associate . : IP Disassociate . IP More Release Floating IP . OpenStack . (server instances) . nova-dashboard . 1. (host name) IP . 2. JavaScript . : Virtual Network Computing (VNC) HTML5 Canvas HTML5 WebSockets . VNC noVNC . noVNC: HTML5 VNC Client . Browser support . 3. IP . https://ipAddressOrHostName : URL (self-signed) . . 4. Log In Sign In . . Settings (sign out). (roles) . o Project . o (administrator) Project ( OpenStack-- Project) Admin ( OpenStack-- Admin) . OpenStack-- Project (Projects) (tenants) (accounts) . . (instances) . Project (images) . CURRENT PROJECT . : Project [].SS Project Project : Compute (Overview): . (Instances): (snapshot) VNC. (Volumes): : o (Volumes): . o (Volume Snapshots): . o (Images): . . (Access & Security): : o (Security Groups): . o (Key Pairs): (import) . o IP (Floating IPs): IP . o API (API Access): (endpoints) API. Network (Network Topology): () . (Networks): . (Routers): (subnets). Object Store (Containers): (containers) (objects). Orchestration (Stacks): REST API () . OpenStack -- Admin Admin flavor () . : Admin [] Admin : System Panel (Overview): . (Resource Usage): : (Daily Report): . (Stats): . (Hypervisors): . (Host Aggregates): (host aggregates). (availability zones). (Instances): ( ) . VNC. (Volumes): (volume types). (Flavors): flavor. flavor . (Images): . (Networks): . (Routers): . (System Info): : o (Services): . o (Compute Services): Compute. (Network Agents): . (Default Quotas): . (hard-coded) OpenStack Compute ..SS (Identity Panel tab) (Projects): . (Users): . (instance) (security group rules) ping SSH . IP . ( ) . (Key pairs) SSH . cloud-init . . Add a key pair . OpenStack (import) . . Import a key pair . OpenStack IP (fixed IP) . IP . IP IP (floating IP) . IP IP . SSH ICMP (ping) . SSH ICMP . . : . 1. (dashboard) Access & Security . Security Groups . 2. (default) Edit Rules . 3. SSH Add Rule . 4. Add Rule : +-----+--------+ |Rule | Remote | +-----+--------+ |SSH | CIDR | +-----+--------+ : IP IP CIDR . 5. Add . SSH IP . 6. ICMP Add Rule . 7. Add Rule : +---------+-----------+ |Rule | Direction | +---------+-----------+ |All ICMP | Ingress | +---------+-----------+ 8. Add . ICMP . . 1. Access & Security . 2. Keypairs . 3. Create Keypair . 4. Create Keypair Create Keypair . 5. . 1. Access & Security . 2. Keypairs . 3. Import Keypair . 4. Import Keypair Public Key Import Keypair . 5. *.pem . 6. : $ chmod 0600 yourPrivateKey.pem : Windows PuTTYgen *.pem *.ppk . WinSCP PuTTYgen . 7. SSH ssh-add . $ ssh-add yourPrivateKey.pem Compute . Access & Security . IP OpenStack IP . IP . IP IP . IP IP . IP . 1. Access & Security . 2. Floating IPs IP . 3. Allocate IP to Project . 4. IP . 5. Allocate IP . 6. Floating IPs Associate . 7. Manage Floating IP Associations : 1. IP Address + IP . 2. Ports to be associated . IP . 8. Associate . : IP Disassociate . IP More Release Floating IP ..SS (Database service) . . . datastore (flavor) . 1. datastore . datastore datastore . datastore . 1. /etc/trove/trove.conf : default_datastore = DATASTORE_NAME ``DATASTORE_NAME`` trove-manage datastore . datastore-list trove datastore . datastore MySQL mysql : default_datastore = mysql 2. Database (controller node): # service trove-api restart # service trove-taskmanager restart # service trove-conductor restart 2. flavor. flavor . . datastore flavor . 1. Databases . 2. Database Instances . . 3. Launch Instance . 4. Launch Database . Details Database Name: . Flavor: flavor . Volume Size: . GB . Initialize Databases: Initial Database : database1, database2, database3 Initial Admin User: . . Password: . Host: . . 5. Launch . . Database Object Storage . . (instance) . MySQL . 1. Databases . 2. Database Instances . . 3. Create Backup . 4. Backup Database : Name . Database Instance . 5. Backup . . . . 1. Databases . 2. Database Backups . . 3. Restore Backup . 4. Launch Database . 5. Restore From Database . 6. Launch . . OpenStack Networking OpenStack . ( IP ) . OpenStack . . OpenStack Administrator Guide . 1. Networks . 2. Create Network . 3. Create Network . Network Network Name: . Subnet Create Subnet: Error . Subnet Name: . Network Address: IP . IP Version: IPv4 IPv6 . Gateway IP: IP (gateway) . . Disable Gateway: IP (gateway) . Subnet Detail Enable DHCP: DHCP . Allocation Pools: IP . DNS Name Servers: DNS . Host Routes: IP (host routes) . 4. Create . Networks . 1. (dashboard) Routers . 2. Create Router . 3. Create Router Create Router . Routers . 4. Set Gateway . 5. External Network Set Gateway . 1. Routers . 2. Router Details Add Interface . 3. Add Interface Subnet . 4. Add Interface IP Address . IP Address OpenStack Networking IP . Router Name Router ID . 5. Add Interface . . Network Topology . 1. default: a. ICMP (ping): $ nova secgroup-add-rule default icmp -1 -1 0.0.0.0/0 +-------------+-----------+---------+-----------+--------------+ | IP Protocol | From Port | To Port | IP Range | Source Group | +-------------+-----------+---------+-----------+--------------+ | icmp | -1 | -1 | 0.0.0.0/0 | | +-------------+-----------+---------+-----------+--------------+ b. (SSH): $ nova secgroup-add-rule default tcp 22 22 0.0.0.0/0 +-------------+-----------+---------+-----------+--------------+ | IP Protocol | From Port | To Port | IP Range | Source Group | +-------------+-----------+---------+-----------+--------------+ | tcp | 22 | 22 | 0.0.0.0/0 | | +-------------+-----------+---------+-----------+--------------+ 2. floating IP address ext-net: $ neutron floatingip-create ext-net Created a new floatingip: +---------------------+--------------------------------------+ | Field | Value | +---------------------+--------------------------------------+ | fixed_ip_address | | | floating_ip_address | 203.0.113.102 | | floating_network_id | 9bce64a3-a963-4c05-bfcd-161f708042d1 | | id | 05e36754-e7f3-46bb-9eaa-3521623b3722 | | port_id | | | router_id | | | status | DOWN | | tenant_id | 7cf50047f8df4824bc76c2fdf66d11ec | +---------------------+--------------------------------------+ 1. 1. 2. 2. 1. 2. 1. 2. : 1. 1. : 1. 2. 2. 2. o <> (AUTHORS) (COPYRIGHT) 2015-2018 OpenStack 3.6.0 April 3, 2026 OPENSTACKDOCSTHEME(1)