43 Commits

Author SHA1 Message Date
Akihiro Motoki
d18e847c94 Turn on warning-is-error in doc build
* Fixes warnings in RST file
* Suppress warning log from pyeclib during the doc build.
  pyeclib emits a warning message on an older liberasurecode [1]
  and sphinx treats this as error (when warning-is-error is set).
  There is no need to check warnings during the doc build,
  so we can safely suppress the warning.

This is a part of the doc migration community-wide effort.
http://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html

[1] https://github.com/openstack/pyeclib/commit/d163972b

Change-Id: I9adaee29185a2990cc3985bbe0dd366e22f4f1a2
2017-07-30 14:56:12 +00:00
Tim Burke
13a07aa77a Misc doc cleanup
* Change some absolute URLs to internal links
* Fix some bulletted list indentation
* Choose a better lexer for some syntax highlighting
* Use ``inline code`` instead of `italics` for some example command
  lines
* Change some quoted paragraphs that only included inlined code to be
  proper code blocks

Change-Id: Iaaa7eefb690122f5af9dcb1c871358c22335c743
2017-07-12 12:14:45 -07:00
Tim Burke
3981e1ee8a Remove links for EOLed releases
Change-Id: If7e8526edf18b02474ba272451b9b4212558e03c
2017-05-11 13:57:10 +00:00
Clay Gerrard
37f6f25283 Update multi-node install links
... as is useful to do from time to time

Change-Id: I165899445080fa3a8e6dc624ab5a13680b819a73
2017-05-11 09:13:02 -04:00
Andreas Jaeger
d4de5502c2 Remove broken links
The Install Guides for Kilo and older are not published anymore, all
these links give a 404. Remove the links for these outdated versions.

Change-Id: I73e96b0ca4840d83c4f3561b4ffb08510d61c8d7
2017-01-16 11:22:08 +01:00
Kota Tsuyuzaki
29b8d2da20 Avoid docs warning: Duplicate explicit target name
When we add two (or more than) different links as same target name,
we need to set two underscore[1] instead of one. This avoids "Duplicate
explicit target name" warnings.

1:
http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#hyperlink-references

Change-Id: I8a493e7a1deeece33ee1b3fb3f5c848f3cc31d06
2016-06-14 19:20:07 -07:00
Tim Burke
fb7a8e9ab7 Add links to mitaka install guides
Change-Id: I62331923751c521daded4468b5cc5f03655226bc
2016-05-24 13:38:43 -07:00
venkatamahesh
050e3b35dd Use uppercase 'S' in word "OpenStack"
Change-Id: I4692aa58b5173b1b662d5eee19fac770ae5aaed0
2016-02-04 16:48:13 +05:30
Ondřej Nový
5c6576d1eb Fixed docs: Title underline too short
Change-Id: If96b0e799a4671e7b7f3f5bea2628db75afa9578
2016-01-25 18:20:45 +01:00
Tim Burke
e534af645d Remove references to now-missing havana docs
Change-Id: I3c708bacd468e923e574bdd5afc7acc58b072159
2015-11-16 10:49:17 -08:00
Pete Zaitcev
652f0f9da4 Having said H, I, J, we ought to say K
In the long run, we might want to stop these updates. But this
decision is above my pay grade.

Change-Id: I335558e1da8052be1b215fbad51244b47af3d81b
2015-08-05 15:33:29 -06:00
Martin Kletzander
76b106fc01 Fix common misspellings
Wikipedia's list of common misspellings [1] has a machine-readable
version.  This patch fixes those misspellings mentioned in the list
which don't have multiple right variants (as e.g. "accension", which can
be both "accession" and "ascension"), such misspellings are left
untouched.  The list of changes was manually re-checked for false
positives.

[1] https://en.wikipedia.org/wiki/Wikipedia:Lists_of_common_misspellings/For_machines

Change-Id: Ic9a5438629664f7cea216413a28acc0e8992da05
Signed-off-by: Martin Kletzander <mkletzan@redhat.com>
2015-03-24 11:07:56 +01:00
Matthew Oliver
4f9a3a3342 Fixed links in multi-server Swift documentation
The link to the ubuntu installation guide was incorrect and 404'ing.

This change updates page to point (anchor) to the install guide
section of docs.openstack.org, so it will always point to the latest
versions of the install documentation.

It also updates the deep links to the current install guides for the
past few releases.

As links continue to get outdated or we forget to add new ones, the
anchor link at the top of the page will probably still work.

Change-Id: I38299c03370936eb41992a953aa9d10b01a8396b
Closes-Bug: #1147331
2015-03-03 16:18:58 +11:00
Tom Fifield
c207c9b9da Refer multi node install to docs.openstack.org
The multi-node install was so horribly outdated it still
refered to ubuntu 10.04. The install guide at docs.openstack.org
has a usable swift installation guide - link to it until such
time as this page can be fixed.

Change-Id: I29fa334d9ffc9b63c8f31c664e7509b2f2577574
2014-10-07 09:07:43 -07:00
Mahati Chamarthy
b68258a322 Added instructions to create a label or UUID to the XFS volume and mount using it.
Change-Id: Idcaf16a278d6c34770af9b1f17d69bdd94fb86b7
2014-09-23 14:55:16 +05:30
Pete Zaitcev
5cb7ac15c2 Fix numbering of steps in proxy section of install_multinode
Steps were numbered 1, 2, (note reset), 1, 2, etc. Then a user says:
"I'm on Step 2 in Proxy section, er..."

See a bug, fix a bug.

Change-Id: If6f32b3a33e1070e705812df7ab299e6736c9806
2014-02-04 11:20:56 -07:00
Pete Zaitcev
4b5db1dd0a Improve config samples
- Add proxy-logging to multinode. We had it since Folsom and people
  still forget it, resulting in missing logs.
- Use correct name, for ease hit with '*' in vi at least.

Admittedly trivial changes, which I meant to hold until Leah's major
doc improvement lands, but I'm tired of keeping stuff like this in
my working repo.

Change-Id: I44f80c51d6d7329a9b696e67fcb8a895db63e497
2013-06-06 19:41:13 -06:00
tong li
f1aefcbc13 directory /var/cache/swift /srv/node should be created.
For multiple node swift cluster setup, these directories should be
created in the setup steps. Otherwise, when start up storage servers
there will be errors. The error messages won't tell if it is because
of missing the directory.

Change-Id: I67d74abb7743b76739b5e747d6dcbd3214b00774
Fixes: bug #1158519
2013-04-04 20:39:01 +00:00
David Hadas
a979c8007b Add support for Hash Prefix
A new configuration parameter is added to /etc/swift/swift.conf
[swift-hash]
swift_hash_path_prefix = 'random unique string'

New installations are advised to set this parameter to a random secret,
which would not be disclosed ouside the organization.
The same secret needs to be used by all swift servers of the same cluster.

Existing installations should set this parameter to an empty string
(the default)

DocImpact

Fixes: Bug #1157454

Change-Id: I63b10d0b7d6dd3f74e0f10bb41b5f240fa03578a
2013-03-22 19:41:55 +02:00
tong li
c1dfe891e7 instruction command was not documented in right format.
Instructions for a Multiple Server Swift Installation (Ubuntu) doc
for creating /var/run/swift and changing owner command were not
using the right format. Missing two colons.

Change-Id: Ie23007a0da498373fbfb137c7edb3d80813c6ba5
Fixes: bug #1158310
2013-03-21 09:45:13 -04:00
tong li
68355d7ea5 Instruction for multi node setup misses /var/run/swift creation
Multiple Server Swift Installation (Ubuntu) instruction does not
indicate that the directory /var/run/swift needs to be created.
That directory actually needs to be created and the ownship needs
to be changed to the user/group which swift service runs under.

This patch will fix the document and gives the steps how to create
the directory and set the ownership right. It also gives instruction
on how the script can be added so that swift services can be resarted
after system reboots.

Change-Id: Id61aa67cc0d6f66d749701e6ea824b1ff3b2c478
Fixes: bug #1156631
2013-03-18 13:57:40 -04:00
Chmouel Boudjnah
0df6fe817d Add container-sync to container-server.conf doc.
- In howto install multi nodes container-sync was not included in the
  config example.

Change-Id: I2682d47c5cae28ff321ba03d70dae2fea00c276f
2013-01-12 23:37:25 +01:00
Chmouel Boudjnah
22572b506a Remove swift.common.client from here.
- It has been to its own gerrit project.
- direct_client should follow next.
- Implements blueprint clientbindings.

Change-Id: I3bb50c95eba81302bfec71cb7ce5288b85a41dc0
2012-06-07 16:36:49 +02:00
gholt
5f18d987a0 Fixed tabs in the multi-node doc.
Change-Id: Idf2ea227b0078026eb2693ff7c0a24ec926bb6f3
2012-04-26 20:29:08 +00:00
John Dickinson
3053c53ef7 added docs and warnings about using SSL
Change-Id: I766b2da0a3769869b5b6c5565106e9032fea8c3e
2012-04-23 19:29:26 -05:00
Jenkins
5104cf4cfc Merge "added account_autocreate = true to example proxy config" 2012-02-28 21:28:33 +00:00
Pete Zaitcev
133052b1ca Fix lp:875301
Pure formatting, not a word changed.

Change-Id: I95671428c5ad648497b0275489492d04e85ac79e
Bug: 875301
2012-02-22 18:43:05 -07:00
John Dickinson
17e95941dd added account_autocreate = true to example proxy config
Change-Id: Ib25c61da37bcbbda7bbd729560996ef6b3be1670
2012-02-09 07:40:00 -06:00
Chuck Thier
42c975aa4e Fixed ppa for multinode instructions 2011-08-31 19:08:02 +00:00
John Dickinson
0eeeae664e renamed st to swift 2011-06-14 11:04:06 -05:00
gholt
f68b6354e2 Renaming TestAuth to TempAuth because nose hates anything with the word test in it. 2011-05-26 02:24:12 +00:00
gholt
3ee4a01100 Remove swauth; update references from swauth to testauth. 2011-05-26 02:17:42 +00:00
Anne Gentle
6a54cb529c Edits to multinode install after testing in internal training class 2011-05-16 22:59:57 -05:00
gholt
bd22dbe712 Removing DevAuth 2011-03-14 02:56:37 +00:00
Anne Gentle
4cc6e76943 Fixes separate IP address for auth on multinode install plus adds some scripting touches 2011-03-04 16:35:02 -06:00
Michael Barton
2fac1d53ef modify default_swift_cluster option format 2011-01-17 21:49:48 +00:00
gholt
09e39032bf new swauth-cleanup-tokens; restricted listing .auth account to .super_admin; doc updates 2010-12-09 17:57:26 -08:00
gholt
3d2985201c swauth-list work; new swauth-set-account-service; .clusters is now .services; doc updates 2010-12-01 21:28:41 -08:00
gholt
35f3487879 Incorporated Swauth into Swift as an optional DevAuth replacement. 2010-12-01 17:08:49 -08:00
gholt
76edfbc94c Updated howto_installmultinode.rst 2010-11-29 15:52:51 -08:00
Anne Gentle
05658b8f8f Edits based on input 2010-11-24 10:55:29 -06:00
Anne Gentle
a342d6a9a4 Added a section about adding additional proxy servers to the multi-node install doc 2010-11-23 16:30:38 -06:00
Anne Gentle
9dc5ffcd07 Adds multi server install doc 2010-11-04 14:25:23 -05:00