Skip to content

Commit 992490f

Browse files
sdodsleysdodsley
committed
Initial Commit
1 parent 6ceac98 commit 992490f

File tree

96 files changed

+4605
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

96 files changed

+4605
-0
lines changed

‎.gitignore‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
.DS_Store
2+
# Files created by Sphinx build
3+
.autogenerated
4+
.tox
5+
.venv
6+
.idea
7+
*.pyc*
8+
*.egg*
9+
build/*
10+
update_html

‎README.md‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
Pure Storage OpenStack Deployment & Operations Guide
2+
==============================================
3+
4+
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
5+
6+
This repository contains documentation to aid operators and users of
7+
OpenStack clouds powered by Pure Storage FlashArray.
8+
9+
The latest build of this documentation is live here:
10+
11+
https://<TBD>
12+
13+
14+
Contributing
15+
------------
16+
17+
We welcome contributions and requests for enhancement. If you find bugs in
18+
the documentation, please file
19+
an [issue](https://github.com/PureStorage-OpenConnect/openstack-docs/issues). You
20+
may also do this from within the documentation webpage, using the bug links
21+
provided on each page.
22+
23+
This documentation is written and built with Sphinx using
24+
[reStructured Text](http://www.sphinx-doc.org/en/stable/rest.html) as the
25+
markup language.
26+
27+
To build this guide, you will need
28+
[tox](https://tox.readthedocs.io/en/latest/).
29+
30+
Install tox by running:
31+
32+
```
33+
pip install tox
34+
```
35+
36+
From inside the repository, build this guide with:
37+
38+
```
39+
tox -e docs
40+
```
41+
42+
A "build" folder is created with doctrees and html output.
43+
44+
45+
If you're building this on macOS, it is possible you'll run into dependency
46+
issues if you do not have Xcode Command Line utilities enabled. You can
47+
enable it with:
48+
49+
```
50+
xcode-select --install
51+
```
52+
53+
54+
Attributions
55+
------------
56+
57+
The theme used by the builds of this documentation was [developed by the
58+
OpenStack community](https://docs.openstack.org/openstackdocstheme/latest/).
59+

‎requirements.txt‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# The order of packages is significant, because pip processes them in the order
2+
# of appearance. Changing the order has an impact on the overall integration
3+
# process, which may cause wedges in the gate later.
4+
5+
# pbr should be first
6+
pbr!=2.1.0,>=2.0.0 # Apache-2.0
7+
8+
sphinx!=1.6.6,!=1.6.7,!=2.1.0;python_version>='3.4' # BSD
9+
sphinxmark>=0.1.14
10+
sphinxcontrib-spelling>=2.3.0
11+
sphinx_rtd_theme

‎setup.cfg‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
[metadata]
2+
name = openstack-deploy-ops-guide
3+
summary = OpenStack Deployment and Operations Guide
4+
description-file =
5+
README.md
6+
author = Pure Storage Inc.
7+
author-email = [email protected]
8+
home-page = https://purestorage.com
9+
classifier =
10+
Environment :: OpenStack
11+
Intended Audience :: Information Technology
12+
Intended Audience :: System Administrators
13+
License :: OSI Approved :: Apache Software License
14+
Operating System :: POSIX :: Linux
15+
Programming Language :: Python
16+
Programming Language :: Python :: 2
17+
Programming Language :: Python :: 2.7
18+
Programming Language :: Python :: 3
19+
Programming Language :: Python :: 3.5
20+
[global]
21+
setup-hooks =
22+
pbr.hooks.setup_hook
23+
24+
[files]
25+
packages =
26+
openstack-deploy-ops-guide
27+
puredocstheme
28+
[build_sphinx]
29+
all_files = 1
30+
build-dir = build
31+
source-dir = source
32+
builders = html
33+
warning-is-error = 1
34+
35+
[egg_info]
36+
tag_build =
37+
tag_date = 0
38+
tag_svn_revision = 0
39+
40+
[wheel]
41+
universal = 1

‎setup.py‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Licensed under the Apache License, Version 2.0 (the "License");
2+
# you may not use this file except in compliance with the License.
3+
# You may obtain a copy of the License at
4+
#
5+
# http://www.apache.org/licenses/LICENSE-2.0
6+
#
7+
# Unless required by applicable law or agreed to in writing, software
8+
# distributed under the License is distributed on an "AS IS" BASIS,
9+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
10+
# implied.
11+
# See the License for the specific language governing permissions and
12+
# limitations under the License.
13+
14+
import setuptools
15+
16+
# In python < 2.7.4, a lazy loading of package `pbr` will break
17+
# setuptools if some other modules registered functions in `atexit`.
18+
# solution from: http://bugs.python.org/issue15881#msg170215
19+
try:
20+
import multiprocessing # noqa
21+
except ImportError:
22+
pass
23+
24+
setuptools.setup(
25+
setup_requires=['pbr>=2.0.0'],
26+
pbr=True)

‎source/appendices/appendix_packaging.rst‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
Packaging
2+
*********
3+
4+
Installation and Uninstallation
5+
===============================
6+
7+
Refer to the following link for install/uninstall-related information:
8+
http://wiki.openstack.org/Getopenstack
9+
10+
For more information related to Linux ``multipath`` recommended configuration
11+
for FlashArrays refer to the `Pure Support website page. <https://support.purestorage.com/Solutions/Linux/Linux_Reference/Linux_Recommended_Settings>`_
12+
13+
Upgrading and Reverting
14+
=======================
15+
16+
Refer to the following link for upgrading/reverting-related information:
17+
https://docs.openstack.org/operations-guide/ops-upgrades.html
18+
19+
Licensing
20+
=========
21+
22+
OpenStack is released under the Apache 2.0 license.
23+
24+
Versioning
25+
==========
26+
27+
Versioning for Pure Storage OpenStack Cinder drivers is detailed in the
28+
`Pure Storage Support site. <https://support.purestorage.com/Solutions/OpenStack/OpenStack_Reference/Pure_Storage_FlashArray_Volume_Driver_for_OpenStack_Release_Notes>`_
29+
30+
.. _deprecated_drivers:
31+
32+
Deprecated Drivers
33+
==================
34+
35+
Currently there are no deprecated drivers for the Pure Storage FlashArray in OpenStack Cinder.

‎source/appendices/section_common-problems.rst‎

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
.. _common-probs:
2+
3+
Common Problems
4+
======================
5+
6+
Common problems listed below are followed by the ``cinder``,
7+
or ``nova`` CLI command and possible reasons for the occurrence of the
8+
problem.
9+
10+
1. Volume create operation fails
11+
--------------------------------
12+
13+
::
14+
15+
$ cinder create size_gb
16+
17+
- Cinder API service is down.
18+
19+
- Cinder scheduler service is down.
20+
21+
2. Volume create with volume-type operation fails
22+
-------------------------------------------------
23+
24+
::
25+
26+
$ cinder create --volume-type volume_type size_gb
27+
28+
- All the reasons mentioned under Item 1 in this appendix.
29+
30+
- The FlashArray backend(s) with available space do not support at least
31+
one of the extra-specs bound to the volume-type requested. Hence, it
32+
does not return the extra spec in volume stats call to the Cinder
33+
scheduler.
34+
35+
- The configured API token does not have sufficient
36+
privileges on the FlashArray.
37+
38+
- The configured management IP address/FQDN and API token for a FlashArray
39+
backend are incorrect.
40+
41+
3. Volume create from image-id operation fails
42+
----------------------------------------------
43+
44+
::
45+
46+
$ cinder create --image-id image-id size_gb
47+
48+
- All the reasons mentioned under Item 1 in this appendix.
49+
50+
- Glance related services are down.
51+
52+
- The image could not be downloaded from glance because of download
53+
error.
54+
55+
4. Volume create from image-id with volume-type operation fails
56+
---------------------------------------------------------------
57+
58+
::
59+
60+
$ cinder create --image-id image-id --volume-type volume_type size_gb
61+
62+
- All the reasons mentioned under Items 1, 2, and 3 in this appendix.
63+
64+
5. Volume create from snapshot operation fails
65+
----------------------------------------------
66+
67+
::
68+
69+
$ cinder create --snapshot-id snapshot-id size_gb
70+
71+
- All reason mentioned under Items 1 in this appendix.
72+
73+
6. Create cloned volume operation fails
74+
---------------------------------------
75+
76+
::
77+
78+
$ cinder create --source-volid volume-id size_gb
79+
80+
- All reason mentioned under Items 1 in this appendix.
81+
82+
7. Volume attach operation in nova fails
83+
----------------------------------------
84+
85+
::
86+
87+
nova volume-attach instance-id volume-id path size_gb
88+
89+
- iSCSI drivers:
90+
91+
- The iSCSI service on the ``nova-compute`` host may not be running.
92+
93+
- The iSCSI network is not reachable due to firewall, configuration, or
94+
transient issues.
95+
96+
- FC drivers:
97+
98+
- The FC zones are incorrectly configured.
99+
100+
- If using the Fibre Channel Zone Manager the SAN switch connectivity
101+
information is incorrect.

‎source/appendices/section_references.rst‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
.. _references:
2+
3+
References
4+
==========
5+
6+
The following references were used in this paper:
7+
8+
- NIST Cloud Definition http://www.nist.gov
9+
10+
- OpenStack Foundation http://www.openstack.org
11+
12+
- Cloud Data Management Interface (CDMI) http://www.snia.org/cdmi
13+
14+
For additional information, visit:
15+
16+
- For source code for OpenStack, including Pure Storage contributions,
17+
available through Github: http://www.github.com/openstack
18+
19+
- For more information about OpenStack history:
20+
http://www.openstack.org or http://en.wikipedia.org/wiki/OpenStack
21+
22+
- For Pure Storage OpenStack Deployment and Operations Guide source code,
23+
visit: https://github.com/PureStorage-OpenConnect/openstack-docs

‎source/appendices/section_support.rst‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
.. _support:
2+
3+
Support
4+
=======
5+
6+
Support provides support for OpenStack connections with FlashArray backends via
7+
the standard Pure Storage support channels by either calling +1-650-729-4088
8+
(Global Toll Number), or going to https://support.purestorage.com/Pure1/Support
9+
for regional support numbers, or by submitting a support request via email to
10+
email:[email protected]
11+
12+
Community support is available through the 'code' slack channel:
13+
https://code-purestorage.slack.com/.
14+
15+
All documentation for Pure Storage's drivers for OpenStack are contained in this
16+
Deployment Operations Guide. A link to the most current version can always
17+
be found at http://support.purestorage.com/Solutions/Openstack/.
18+
19+
The Pure Storage OpenStack team presently intends to provide maintenance of
20+
the three most recently released versions of OpenStack. For example,
21+
during Wallaby development, all code that is part of the Train, Ussuri and
22+
Victoria official branches are supported. Upon Wallaby release, direct
23+
maintenance for Train would be dropped and maintenance for Wallaby is
24+
added.
25+
26+
If your host operating system, hypervisor, and other components involved
27+
in the data path are approved through the IMT, then as long as you are
28+
using an OpenStack release (or n-1) version, your configuration is supported.
29+
See the `FlashArray compatibility Matrix <https://support.purestorage.com/FlashArray/Getting_Started_with_FlashArray/FlashArray_Compatibility_Matrix>_`
30+
to verify your configuration is supported.
31+
32+
Pure Storage can provide customized support options for production
33+
requirements. For more information, please contact your sales team.

0 commit comments

Comments
 (0)