From a99cf92c99a5626f4f23d337368f80b2091f4608 Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Tue, 18 Jul 2017 17:45:02 -0400 Subject: [PATCH] move top level pages into ocata directory Move the top level html pages into the ocata directory and establish redirects for their new locations. Recover the old versions of the project list and language-bindings pages with their static lists and use those for the ocata pages. We will use the dynamic templates for pike and later series. Bring the included templates inline in index.html to adjust the links they provide without breaking other pages. Change-Id: I94e82053a3523b11c5069627045263497efdb1de Signed-off-by: Doug Hellmann --- www/.htaccess | 8 + www/index.html | 101 ------------- www/language-bindings.html | 64 -------- www/ocata/index.html | 64 +++++++- www/ocata/language-bindings.html | 126 ++++++++++++++++ www/ocata/projects.html | 246 +++++++++++++++++++++++++++++++ www/openstack-projects.html | 105 ------------- 7 files changed, 438 insertions(+), 276 deletions(-) delete mode 100644 www/index.html delete mode 100644 www/language-bindings.html create mode 100644 www/ocata/language-bindings.html create mode 100644 www/ocata/projects.html delete mode 100644 www/openstack-projects.html diff --git a/www/.htaccess b/www/.htaccess index 637b75b5ce..e38878b804 100644 --- a/www/.htaccess +++ b/www/.htaccess @@ -1,6 +1,14 @@ {% set series = 'latest' %} +{% set released_series = 'ocata' %}{# The most recently released series #} {% set projects = PROJECT_DATA[series] %} +# Redirect old top-level HTML pages to the version under most recent +# full release. +redirectmatch 301 /$ /{{released_series}}/ +redirectmatch 301 /index.html$ /{{released_series}}/ +redirectmatch 301 /openstack-projects.html$ /{{released_series}}/projects.html +redirectmatch 301 /language-bindings.html$ /{{released_series}}/language-bindings.html + # Redirecting End-of-Life (EOL) versions, see https://wiki.openstack.org/wiki/Releases: redirectmatch 301 /bexar/.*$ /index.html redirectmatch 301 /cactus/.*$ /index.html diff --git a/www/index.html b/www/index.html deleted file mode 100644 index d7006d4678..0000000000 --- a/www/index.html +++ /dev/null @@ -1,101 +0,0 @@ -{% extends "templates/indexbase.tmpl" %} -{% block pagetitle %}Ocata{% endblock %} -{% block title %}{% endblock %} -{% block header %} -{% endblock header %} -{% block content %} - -
-
-
-
-

Welcome to OpenStack Documentation

-

- What is OpenStack? OpenStack is a cloud operating system that controls large pools of compute, storage, and networking resources throughout a datacenter, all managed through a dashboard that gives administrators control while empowering their users to provision resources through a web interface. -

-

Warning: Major rework in progress

-

Note that on July 3rd of 2017, all projects have been - moved to a new location on this server. Each project - is required to merge any single change in order to be - published. Keep in mind that bookmarks saved before - the changes may no longer function. - - See the specification - for more information. -

- -
-

What are the next steps?

- View The Docs - Get OpenStack - Get Training - {% include 'templates/swiftype_search.tmpl' %} -
-
-
-
-
-
-
-
-
-
-

Documentation for Ocata (February 2017)

-

This is the latest release. Use the menu to select a prior release if needed.

-
- {% include 'templates/dropdown_releases_and_languages.tmpl' %} -
-
-
-
-
-
-
-
-
-
-
-

Release Notes

-

New features, upgrade and deprecation notes, known issues, and bug fixes

- OpenStack Projects Release Notes - OpenStack Documentation Release Notes -
-
-

Installation Tutorials and Guides

-

Getting started with the most commonly used OpenStack services

- Installation Tutorials and Guides -
-
-

Deployment Guides

-

Choose how to deploy OpenStack and get started with the most commonly used OpenStack services

- Deployment Guides -
-
- {% include 'templates/ops_and_admin_guides.tmpl' %} - Networking Guide[PDF] -

Deploy and manage OpenStack Networking (neutron)

-
-
-

Configuration Guides

- Configuration Reference -

Installation and configuration options for OpenStack

-
- {% include 'templates/api_guides.tmpl' %} -
-
- {% include 'templates/user_guides.tmpl' %} - {% include 'templates/project_guides.tmpl' %} - {% include 'templates/contributor_guides.tmpl' %} - {% include 'templates/training_guides.tmpl' %} -
-
-
-
-

Documentation treated like code, powered by the community - interested?

- How To Contribute -
-
-
-
- -{% endblock content %} diff --git a/www/language-bindings.html b/www/language-bindings.html deleted file mode 100644 index fa43a2d187..0000000000 --- a/www/language-bindings.html +++ /dev/null @@ -1,64 +0,0 @@ -{% set series = 'latest' %} -{% set projects = PROJECT_DATA[series] %} -{% extends "templates/base.tmpl" %} -{% block pagetitle %}Language bindings{% endblock %} -{% block title %} -Documentation > Language Bindings and Python Clients -{% endblock %} -{% block content %} - -
-
-
-
-

OpenStack API Bindings

-

- This page contains documentation about the Python bindings provided by OpenStack and how to use them. -

-
-
-
-
-
-
-
-
-

Bindings for the OpenStack APIs

-{% for project in projects|sort(attribute='service') -%} -{% if project.type == 'client' %} - - {{project.service}} ({{project.description}}) -
-{% endif %} -{%- endfor %} -
-
-
-
-

Use the dashboard and command-line clients

- - OpenStack End User Guide -
-

- User guide for the OpenStack dashboard and command-line clients. -

- - Unified OpenStack Client -
-

- Documentation for python-openstackclient, a unified shell command structure. -

-
-
-
-
-
-

Documentation treated like code, powered by the community - interested?

- How To Contribute -
-
-
-
- -{% endblock content %} diff --git a/www/ocata/index.html b/www/ocata/index.html index 318c57b39d..550f2ce604 100644 --- a/www/ocata/index.html +++ b/www/ocata/index.html @@ -70,7 +70,19 @@ Deployment Guides
- {% include 'templates/ops_and_admin_guides.tmpl' %} +

Operations and Administration Guides

+ Administrator Guides +

Manage and troubleshoot an OpenStack cloud

+ High Availability Guide[PDF] +

Install and configure OpenStack for high availability

+ Operations Guide[PDF] +

Design, create, and administer a production OpenStack cloud

+ Security Guide +

Guidelines and scenarios for creating more secure OpenStack clouds

+ Virtual Machine Image Guide[PDF] +

Obtain, create, and modify OpenStack-compatible virtual machine images

+ Architecture Design Guide[PDF] +

Guidelines for designing an OpenStack cloud

Networking Guide[PDF]

Deploy and manage OpenStack Networking (neutron)

@@ -79,13 +91,53 @@ Configuration Reference

Installation and configuration options for OpenStack

- {% include 'templates/api_guides.tmpl' %} +
+

API Guides

+ API Guides +

OpenStack API Documentation

+
- {% include 'templates/user_guides.tmpl' %} - {% include 'templates/project_guides.tmpl' %} - {% include 'templates/contributor_guides.tmpl' %} - {% include 'templates/training_guides.tmpl' %} +
+

User Guides

+ End User Guide (includes Python SDK)[PDF] +

Create and manage resources using the OpenStack dashboard, command-line client, and Python SDK

+ Open source software for application development +

Resources for application development on OpenStack clouds

+
+
+

Project-specific Guides

+ Services and Libraries +

Documentation for OpenStack services and libraries

+ Language Bindings and Python Clients +

Documentation for the OpenStack Python bindings and clients

+
+
+

Contributor Guides

+ OpenStack Documentation Contributor Guide +

Documentation workflow and conventions

+ OpenStack Technical Committee Governance Documents +

OpenStack Technical Committee reference documents and official resolutions

+ OpenStack Project specifications +

Specifications for future project features

+ OpenStack Project Team Guide +

Guide to the OpenStack project and community

+ OpenStack Developer and Community Infrastructure Documentation +

Development and infrastructure documentation

+ OpenStack I18n Guide +

Internationalization workflow and conventions

+ Join the OpenStack Foundation +

How to join the OpenStack Foundation

+ Take the Deployment Survey +

Influence the future of OpenStack

+
+
+

Training Guides And Training Labs

+ Upstream training +

Resources for the OpenStack Upstream Training program

+ Training Labs +

Tools for OpenStack Training. Automatic deployment of lean virtualized multi-node openstack cluster.

+
diff --git a/www/ocata/language-bindings.html b/www/ocata/language-bindings.html new file mode 100644 index 0000000000..c2e6fcab2b --- /dev/null +++ b/www/ocata/language-bindings.html @@ -0,0 +1,126 @@ +{% extends "templates/base.tmpl" %} +{% block pagetitle %}Language bindings{% endblock %} +{% block title %} +Documentation > Language Bindings and Python Clients +{% endblock %} +{% block content %} + +
+
+
+
+

OpenStack API Bindings

+

+ This page contains documentation about the Python bindings provided by OpenStack and how to use them. +

+
+
+
+
+
+
+
+
+

Bindings for the OpenStack APIs

+ + Bare Metal service Python Bindings (ironic client) +
+ + Block Storage service Python Bindings (cinder client) +
+ + Compute service Python Bindings (nova client) +
+ + Container Infrastructure Management service Python Bindings (magnum client) +
+ + Data Processing service Python Bindings (sahara client) +
+ + Database service Python Bindings (trove client) +
+ + DNS service Python Bindings (designate client) +
+ + Governance service Python Bindings (congress client) +
+ + Identity service Python Bindings (keystone client) +
+ + Image service Python Bindings (glance client) +
+ + Infrastructure Optimization service Python Bindings (watcher client) +
+ + Key Management service Python Bindings (barbican client) +
+ + Messaging service Python Bindings (zaqarclient client) +
+ + Networking service Python Bindings (neutron client) +
+ + Object Storage service Python Bindings (swift client) +
+ + Orchestration service Python Bindings (heat client) +
+ + Shared File Systems service Python Bindings (manila client) +
+ + Telemetry Alarming service Python Bindings (aodh client) +
+ + Telemetry Data Collection service Python Bindings (ceilometer client) +
+ + Telemetry Time Series Database as a Service Python Bindings (gnocchi client) +
+ + Workflow service Python Bindings (mistral client) +
+
+
+
+
+

Use the dashboard and command-line clients

+ + OpenStack End User Guide +
+

+ User guide for the OpenStack dashboard and command-line clients. +

+ + OpenStack Command Line Interface Reference +
+

+ Reference listing of all commands and parameters + available for keystone, glance, neutron, nova, + cinder, swift, heat, and ceilometer commands. +

+ + Unified OpenStack Client +
+

+ Documentation for python-openstackclient, a unified shell command structure. +

+
+
+
+
+
+

Documentation treated like code, powered by the community - interested?

+ How To Contribute +
+
+
+
+ +{% endblock content %} diff --git a/www/ocata/projects.html b/www/ocata/projects.html new file mode 100644 index 0000000000..bc0b48d6e7 --- /dev/null +++ b/www/ocata/projects.html @@ -0,0 +1,246 @@ +{% extends "templates/base.tmpl" %} +{% block pagetitle %}Services and Libraries{% endblock %} +{% block title %} +Documentation > Services and Libraries +{% endblock %} +{% block content %} + +
+
+
+
+

OpenStack Projects

+

+ This page contains project-specific documentation for + OpenStack services and libraries. +

+
+
+
+
+
+
+
+
+
+
+
+ +
+

OpenStack Services

+ + Application Catalog service (murano)
+ + Bare Metal service (ironic)
+ + Block Storage service (cinder)
+ + Clustering service (senlin)
+ + Compute inside Object Storage service (storlets)
+ + Compute service (nova)
+ + Container Infrastructure Management service (magnum)
+ + Containers service (zun)
+ + Dashboard (horizon)
+ + Data Processing service (sahara)
+ + Database service (trove)
+ + DNS service (designate)
+ + Governance service (congress)
+ + Identity service (keystone)
+ + Image service (glance)
+ + Infrastructure Optimization service (watcher)
+ + Key Management service (barbican)
+ + Message service (zaqar)
+ + Networking service (neutron)
+ + NFV Orchestration service (tacker)
+ + Object Storage service (swift)
+ + Orchestration service (heat)
+ + Rating service (cloudkitty)
+ + Root Cause Analysis service (vitrage)
+ + Search service (searchlight)
+ + Shared File Systems service (manila)
+ + Telemetry Alarming service (aodh)
+ + Telemetry Data Collection service (ceilometer)
+ + Telemetry Event service (panko)
+ + Telemetry Time Series Database service (gnocchi)
+ + Workflow service (mistral)
+
+ +
+

Bare Metal Sub Projects

+ + Bare Metal Introspection service (ironic-inspector)
+
+ +
+

Networking Sub Projects

+ + BaGPipe backend (networking-bagpipe)
+ + BGP-MPLS VPN Networking service Plug-in (networking-bgpvpn)
+ + Dynamic Routing service Plug-in (neutron-dynamic-routing)
+ + Firewall-as-a-Service Plug-in (neutron-fwaas)
+ + MidoNet Networking service Plug-in (networking-midonet)
+ + OpenDaylight(ODL) Networking service Plug-in (networking-odl)
+ + OVN Networking service Plug-in (networking-ovn)
+ + Service Function Chaining Networking service Plug-in (networking-sfc)
+
+ +
+

Deployment Projects

+ + Deploying OpenStack using Juju Charms (charms)
+ + Deploying OpenStack using Fuel (fuel)
+ + Deploying OpenStack using Ansible in Docker Containers (kolla)
+ + Deploying OpenStack with Ansible (openstack-ansible)
+ + Deploying OpenStack with TripleO (tripleo)
+
+ +
+

Contributor Tools

+ + DevStack (DevStack)
+ + Release Notes Manager (reno)
+ + Tempest Test Suite for OpenStack
+
+ +
+

Related Projects

+ bandit
+

Security linter for Python.

+ bashate
+

Linter for bash scripts.

+ grenade
+

Grenade is an OpenStack test harness to exercise the upgrade process between releases.

+ refstack
+

RefStack is a toolset for testing interoperability between OpenStack clouds.

+ syntribos
+

Automated API security testing tool.

+
+ +
+
+ +
+

Using Libraries

+ automaton
+

Friendly state machines for python.

+ cliff
+

Builds command-line programs in Python.

+ debtcollector
+

A collection of Python deprecation patterns and strategies that + help you collect your technical debt in a non-destructive manner.

+ futurist
+

Asynchronous code from the future, helping you build out your + applications to handle asynchronous and periodic work in a nice manner.

+ keystoneauth
+

Common authentication library for OpenStack clients.

+ keystonemiddleware
+

Middleware provided for integrating with the OpenStack Identity API.

+ neutron-lib
+

Library provided for integrating with the OpenStack Networking platform.

+ oslo.cache
+

Generic caching mechanism for OpenStack projects by wrapping + the dogpile.cache.

+ oslo.concurrency
+

External process management and task synchronization.

+ oslo.config
+

Configuration option parsing from the command line or configuration files.

+ oslo.context
+

Helpers to maintain useful information about a request context

+ oslo.db
+

Database connectivity.

+ oslo.i18n
+

Internationalization and translation.

+ oslo.log
+

A logging configuration library.

+ oslo.messaging
+

Inter-process communication.

+ oslo.middleware
+

A collection of WSGI middleware for web service development.

+ oslo.policy
+

Common policy enforcement.

+ oslo.reports
+

Error report framework for projects.

+ oslo.rootwrap
+

Fine filtering of shell commands to run as root.

+ oslo.serialization
+

Serialization with special handling for some common types.

+ oslo.service
+

Library for running and managing OpenStack services.

+ oslo.utils
+

Database and RPC object schema versioning.

+ oslo.versionedobjects
+

Library of common low-level utility modules.

+ oslo.vmware
+

Common functionality required by VMware drivers in several projects.

+ oslosphinx
+

Theme and extension support for Sphinx documentation.

+ oslotest
+

Unit test and fixture framework.

+ osprofiler
+

Cross-Project profiling library.

+ pbr
+

Manages setuptools packaging needs in a consistent way.

+ PyCADF
+

Creates CADF events to capture cloud-related events.

+ pylockfile
+

The lockfile package provides a simple API for locking files.

+ stevedore
+

Manages dynamic plug-ins for Python applications.

+ TaskFlow
+

Makes task execution easy, consistent, and reliable.

+ Tooz
+

Distributed primitives like group membership protocol, lock service and leader elections.

+
+ +
+
+
+
+

Documentation treated like code, powered by the community - interested?

+ How To Contribute +
+
+
+
+ +{% endblock content %} diff --git a/www/openstack-projects.html b/www/openstack-projects.html deleted file mode 100644 index 733a2f30f8..0000000000 --- a/www/openstack-projects.html +++ /dev/null @@ -1,105 +0,0 @@ -{% set series = 'latest' %} -{% set projects = PROJECT_DATA[series] %} -{% extends "templates/base.tmpl" %} -{% block pagetitle %}Services and Libraries{% endblock %} -{% block title %} -Documentation > Services and Libraries -{% endblock %} -{% block content %} - -
-
-
-
-

OpenStack Projects

-

- This page contains project-specific documentation for - OpenStack services and libraries. -

-
-
-
-
-
-
-
-
-
-
-
- -
-

OpenStack Services

-{% for project in projects|sort(attribute='service') %} -{% if project.type in ['service', 'other'] %} - - {{project.service}} ({{project.name}})
-{% endif %} -{% endfor %} -
- -
-

Bare Metal Sub Projects

-{% for project in projects|sort(attribute='service') %} -{% if project.type == 'baremetal' %} - - {{project.service}} ({{project.name}})
-{% endif %} -{% endfor %} -
- -
-

Networking Sub Projects

-{% for project in projects|sort(attribute='service') %} -{% if project.type == 'networking' %} - - {{project.service}} ({{project.name}})
-{% endif %} -{% endfor %} -
- -
-

Deployment Projects

-{% for project in projects|sort(attribute='service') %} -{% if project.type == 'deployment' %} - - {{project.service}}
-{% endif %} -{% endfor %} -
- -
-

Contributor Tools

-{% for project in projects|sort(attribute='name') %} -{% if project.type in ['tool'] %} - {{project.name}}
-

{{project.service}}

-{% endif %} -{% endfor %} -
- -
-
- -
-

Using Libraries

-{% for project in projects|sort(attribute='name') %} -{% if project.type == 'library' %} - {{project.name}}
-

{{project.service}}

-{% endif %} -{% endfor %} -
- -
-
-
-
-

Documentation treated like code, powered by the community - interested?

- How To Contribute -
-
-
-
- -{% endblock content %}