22 Commits

Author SHA1 Message Date
junboli
d8136936f8 Update auth_url value in install docs
Follow the keystone install guide by using port 5000
as the default auth_url, this change is to update cinder
install guide to follow that.

Change-Id: I19c60701dbdcf93394ee1c75d2d6660d25c9cbcc
Closes-bug: #1754104
2018-05-01 00:17:01 +08:00
caoyuan
1b99782821 Update auth_uri option to www_authenticate_uri
Option auth_uri from group keystone_authtoken is deprecated[1].
Use option www_authenticate_uri from group keystone_authtoken.

[1]https://review.openstack.org/#/c/508522/

Change-Id: I2a9853b52f23fc4b6a24a0548b9749e976467758
2018-04-08 15:12:54 +08:00
Amy Marrich (spotz)
481535e8e9 Change order of installation to match previous
Re-ordered installation sections to match previous releases.

Change-Id: I8c67843a448049d8424c0fb1e34cf4a954e9ac91
Closes-Bug: #1750888
2018-02-21 14:05:29 -06:00
Lucian Petrut
8fe26313c6 Update Windows docs
This change updates the Cinder Volume install guide, targeting
Windows deployments.

The Windows iSCSI driver doc has been updated. The Windows SMB
driver was undocumented, which is also addressed by this change.

Closes-Bug: #1746022

Change-Id: I46fadc8df59f7203bc3445c24d3bd6547275ee5b
2018-01-30 20:15:23 +02:00
Zuul
acd813631e Merge "Fix indentation in docs" 2017-12-18 06:06:22 +00:00
Masayuki Igawa
c3daf02848
Fix indentation in docs
This commit removes weird indentations in docs.

Change-Id: I82dd98d9fd9a7bf4ff73a808f59651813ac5ec37
2017-12-16 18:16:05 +09:00
Sean McGinnis
78fa04624d Add thin provisioning package to install guide
Our installation guide walks through configuring storage nodes
using the LVM driver. LVM now defaults to thinly provisioned,
which requires thing-provisioning-tools to be installed on the
host. So by default, our instructions will result in failure
when we attempt to perform thin provision operations.

This adds mention of installing the required package for each
platform's instructions to get the necessary tools installed.

It also adds device-mapper-persistent-data to bindep for Red
Hat based platforms to get those thin provisioning tools that
were previously missing for these platforms.

Tools appear to be installed by default on Suse platforms.

Change-Id: I2a84ae99d71c3551814197917d114057430858b7
Closes-bug: #1738409
2017-12-15 13:08:15 -06:00
ZhongShengping
8f7356dca6 Fix project_domain_name and user_domain_name in doc
Change-Id: I192708586d89d1bf07a5e52ed1c45de6eab689a5
Closes-Bug: #1735051
2017-11-29 11:32:28 +08:00
Masayuki Igawa
9a29d679f7
Fix controller install document indentation
This commit fixes the document of cinder-controller-install*.rst.
Otherwise, the html docs are a little weird.

Change-Id: I615d5cab95b07f995318266166480a9fd4d713f8
2017-11-15 16:16:06 +09:00
Zuul
6d8b648399 Merge "Switch base to the latest in doc link address" 2017-10-31 03:58:22 +00:00
Jay S. Bryant
1fd02d1e7f Change Install 'Tutorials' to 'Guides'
It was decided by the documentation team that we should,
for consistency, call our install documentation 'guides'.
Our pages were listed as 'Tutorials'.  This change
corrects the inconsistency.

Change-Id: Id5d915064aa24a5b0c66364ecd618561ed18df9b
2017-10-18 09:22:41 -05:00
junboli
dbb60106e7 Switch base to the latest in doc link address
Although we had some effort to fix these before, it still left lots
of outdated link address, this patch is to fix them all.

Change-Id: I2f9ee172306bf5a99575e0cb6f5eac0ea87b0483
2017-10-10 09:42:54 +08:00
Jay S. Bryant
bad9d9157c [DOC] Update index page for Install tutorial
The index page for our install tutorial should point
back to the top level OpenStack installation tutorial
to give the user information on how to set up the base
OpenStack environment before starting installation.

This patch adds the link and notes that the setup in
there is a prerequisite to executing the Cinder Install
Tutorial.

Change-Id: I42418b30b3978bac24a856c22342ce5db3e42282
2017-09-19 13:32:52 -05:00
Jenkins
d21ea90810 Merge "Fix installation instructions format" 2017-08-31 16:05:27 +00:00
root
da974d646a Fix installation instructions format
These instructions have some sections missing which results in non-standard
format in the URLs. In addition, the automatic numbering is wrong. This patch
fixes the pages.

URLs:
https://docs.openstack.org/cinder/pike/install/cinder-storage-install-ubuntu.html
https://docs.openstack.org/cinder/pike/install/cinder-storage-install-obs.html
https://docs.openstack.org/cinder/pike/install/cinder-storage-install-rdo.html

Closes-Bug: #1713492
Change-Id: I8c9b2437d7eda06ebce3cf5a1c71e497d5146ebc
2017-08-31 18:52:21 +08:00
Jay S. Bryant
be10de4b91 [Doc Bld Fix] Add links to man page contents
The pages under man/ had not been linked to from anywhere.  This
was causing Sphinx to issue warnings during build.  This patch
corrects that.

There was also a 'todo' directive that wasn't valid that needed
to be removed.  This patch also corrects that.

Change-Id: I8ab75b7be921a05e9e4eb023c4dfe90cf4404e6c
2017-08-21 13:56:27 -05:00
Jenkins
6dd6c74b38 Merge "[Docs] Add documentation contribution docs" 2017-08-16 02:33:50 +00:00
Jay S. Bryant
ceed50fb34 [Docs] Pull over Cinder service overview for install
Discovered that when we migrated we forgot to bring over
the page that provides an overview of what the different
services are and how they work together.

This patch pulls that page over as well and links it to
the install guide.

Change-Id: Ic178f88d7c190c918b54da2a9815f61bbe51592e
2017-08-10 16:50:33 -05:00
Jay S. Bryant
79245a6283 [Docs] Add documentation contribution docs
Now that we are in charge of managing our documentation I thought
we should have a section in the Contributor Guide on
how to contribute documentation.  This patch adds that.

It also resolves build WARNINGS due to the README files I added
not being included in any toctrees and adds the missing README
file to the install directory.

Change-Id: I8e12628b439a400ebd1ee6d691673a16e2c2f9d2
2017-08-10 15:52:46 -05:00
Jay S. Bryant
de219b7134 [DOC BLD FIX] Fix missing references in documentation
The configuration, admin and install guides had pointers to
content that didn't get brought over from openstack-manuals.
This patch addresses that missing content.

The install guides ad a number of places where it referenced the
OpenStack Overview content which seemed reasonable to make available
in our documentation for reference.  I brought along associated figures
that support that documentation.

The windows-iscsi-volume-driver documentation had pointers to
content in the compute/hypervisor documentation that haven't and
may not be migrated.  I pulled the two sections being referenced into
the rst file in Cinder.

The reference in blockstorage-manage-volumes to networking was changed
to use a link to the Neutron documentation.

This eliminates all the Sphinx warnings generated around missing
links to documentation.

Change-Id: I85ad0207ae480d499a34d273895b6a88fb41fda7
2017-08-07 17:16:20 -05:00
Jay S. Bryant
ff2f4c669c Fix errors preventing doc builds
There were some syntax problems that came over with the
migration of the install docs in commit:
88be92ee719baff6d5f2f7e7e073b118db2dc2e0

It appears that the docs build for Cinder is more strict
than what was being done in openstack-manuals as the
syntax issues were causing our build to fail. The next step
in our doc migration is to fix these errors so we can do doc
builds.

Change-Id: I7282b2fa2efb50cbb6490ff36f69b123959b6dde
2017-07-07 13:48:35 -05:00
Alexandra Settle
88be92ee71 import installation guide pages from openstack-manuals
Change-Id: Id1ee4d52174b4a5e66c7d306e28b9c12a06d00e2
2017-06-27 11:41:07 +00:00