diff --git a/tools/www-generator.py b/tools/www-generator.py
index bc88a7bc39..698b063a0b 100755
--- a/tools/www-generator.py
+++ b/tools/www-generator.py
@@ -73,6 +73,8 @@ def _check_url(url):
_URLS = [
('has_install_guide',
'https://docs.openstack.org/{name}/{series}/install/'),
+ ('has_admin_guide',
+ 'https://docs.openstack.org/{name}/{series}/admin/'),
('has_config_ref',
'https://docs.openstack.org/{name}/{series}/configuration/'),
('has_in_tree_api_docs',
diff --git a/www/admin-guide.html b/www/admin-guide.html
new file mode 100644
index 0000000000..45654a6cb6
--- /dev/null
+++ b/www/admin-guide.html
@@ -0,0 +1,64 @@
+{% set series = 'latest' %}
+{% set projects = PROJECT_DATA[series] %}
+{% set scriptdir = './common/js/' %}
+{% set cssdir = './common/css/' %}
+{% extends "templates/base.tmpl" %}
+{% block pagetitle %}Administrator Guides{% endblock %}
+{% block title %}
+Documentation > Administrator Guides
+{% endblock %}
+{% block content %}
+
+
+
+
+
+
OpenStack Administrator Guides
+
+ This page contains documentation about administering OpenStack services.
+
+
+
+
+
+
+
+
+
+
+
Administrator Guides for Common OpenStack Libraries
+{% for project in projects|sort(attribute='name') -%}
+{% if project.type == 'library' and project.has_admin_guide %}
+
+ {{project.service}} ({{project.name}})
+
+{% endif %}
+{%- endfor %}
+
+
+
+
+
+
Documentation treated like code, powered by the community - interested?
+
How To Contribute
+
+
+
+
+
+{% endblock content %}
diff --git a/www/project-data/README.txt b/www/project-data/README.txt
index 25a41e6c92..bf30f6a4d8 100644
--- a/www/project-data/README.txt
+++ b/www/project-data/README.txt
@@ -55,5 +55,7 @@ include a link to that documentation on the templated landing pages.
has_in_tree_api_docs -- produces a link to docs.o.o/name/latest/api/
+ has_admin_guide -- produces a link to docs.o.o/name/latest/admin/
+
NOTE: The documentation associated with the flags must exist before
the flags are set.
diff --git a/www/project-data/latest.yaml b/www/project-data/latest.yaml
index b07ee25ab9..94310f4a91 100644
--- a/www/project-data/latest.yaml
+++ b/www/project-data/latest.yaml
@@ -6,6 +6,7 @@
service_type: identity
has_install_guide: true
has_api_ref: true
+ has_admin_guide: true
# has_config_ref: true
type: service
- name: python-keystoneclient
@@ -28,6 +29,7 @@
has_install_guide: true
has_api_ref: true
has_config_ref: true
+ has_admin_guide: true
type: service
- name: python-glanceclient
service: Image service Python Bindings
@@ -61,6 +63,7 @@
service: Networking service
service_type: network
has_install_guide: true
+ has_admin_guide: true
# has_api_ref: true # currently published under /networking/ not /network/
# has_config_ref: true
type: service
@@ -85,6 +88,7 @@
service: Dynamic Routing service Plug-in
type: networking
has_install_guide: true
+ has_admin_guide: true
- name: neutron-fwaas
service: Firewall-as-a-Service Plug-in
type: networking
@@ -99,6 +103,7 @@
service: OVN Networking service Plug-in
type: networking
has_install_guide: true
+ has_admin_guide: true
- name: networking-sfc
service: Service Function Chaining Networking service Plug-in
type: networking
@@ -108,6 +113,7 @@
service: Dashboard
has_install_guide: true
has_config_ref: true
+ has_admin_guide: true
type: service
- name: django_openstack_auth
service: pluggable Django authentication backend for authenticating with Keystone
@@ -120,6 +126,7 @@
service_type: block-storage
has_install_guide: true
has_api_ref: true
+ has_admin_guide: true
# has_config_ref: true
type: service
- name: python-cinderclient
@@ -140,6 +147,7 @@
service_type: baremetal
has_install_guide: true
has_api_ref: true
+ has_admin_guide: true
# has_config_ref: true
type: service
- name: python-ironicclient
@@ -178,6 +186,7 @@
- name: designate
service: DNS service
service_type: dns
+ has_admin_guide: true
# has_install_guide: true
# has_config_ref: true
has_api_ref: true
@@ -222,6 +231,7 @@
- name: swift
service: Object Storage service
service_type: object-store
+ has_admin_guide: true
# has_install_guide: true
# has_api_ref: true # currently published under /object-storage/ not /object-store/
# has_config_ref: true
@@ -269,6 +279,7 @@
service: Telemetry Data Collection service
service_type: meter
has_install_guide: true
+ has_admin_guide: true
# has_config_ref: true
type: service
- name: python-ceilometerclient
@@ -305,6 +316,7 @@
type: service
has_in_tree_api_docs: true
has_install_guide: true
+ has_admin_guide: true
# has_config_ref: true
- name: python-watcherclient
service: Infrastructure Optimization service Python Bindings
@@ -469,18 +481,22 @@
service: A logging configuration library.
has_config_ref: true
has_install_guide: true
+ has_admin_guide: true
- name: oslo.messaging
type: library
service: Inter-process communication.
+ has_admin_guide: true
- name: oslo.middleware
type: library
service: WSGI middleware library for web service development.
has_config_ref: true
has_install_guide: true
+ has_admin_guide: true
- name: oslo.policy
type: library
service: Common policy enforcement.
has_install_guide: true
+ has_admin_guide: true
- name: oslo.privsep
type: library
service: library for privilege separation
@@ -545,6 +561,7 @@
has_install_guide: true
has_api_ref: true
has_config_ref: true
+ has_admin_guide: true
type: service
- name: python-octaviaclient
service: Load-balancer service client
@@ -672,6 +689,7 @@
- name: openstack-ansible
type: deployment
service: Deploying OpenStack with Ansible
+ has_admin_guide: true
- name: tripleo-docs
type: deployment
service: Deploying OpenStack with TripleO
diff --git a/www/project-data/schema.yaml b/www/project-data/schema.yaml
index 4a92fa1a9f..24507dc6ad 100644
--- a/www/project-data/schema.yaml
+++ b/www/project-data/schema.yaml
@@ -37,3 +37,5 @@ items:
type: boolean
has_in_tree_api_docs:
type: boolean
+ has_admin_guide:
+ type: boolean
diff --git a/www/templates/ops_and_admin_guides.tmpl b/www/templates/ops_and_admin_guides.tmpl
index 8feea55f6b..520d499399 100644
--- a/www/templates/ops_and_admin_guides.tmpl
+++ b/www/templates/ops_and_admin_guides.tmpl
@@ -1,5 +1,5 @@
Operations and Administration Guides
-
Administrator Guide
+
Administrator Guides
Manage and troubleshoot an OpenStack cloud
High Availability Guide[PDF]
Install and configure OpenStack for high availability