132 Commits

Author SHA1 Message Date
Alistair Coles
721cd1634a Show file parameters as mandatory in swift-*-info man pages
Changes the file parameters on command line to use the convention of
<file> for a mandatory option rather than [file] which suggests an
optional flag. Also drop to lower case as is convention in other man
pages.

Change-Id: Icfb4b4786343eb493a73b092cad1fdadc935d066
2016-11-11 16:34:15 +00:00
Mohit Motiani
243dd97c58 Add OPTIONS in manpages
swift-account-info, swift-container-info, swift-object-info
and swift-get-node do not contain any information about the available
options. This patch adds OPTIONS in these manpages.

Change-Id: I832c621460ee6bf19adac8e0aadeab32be4b8da0
2016-11-11 16:31:02 +00:00
Ondřej Nový
99a13d9386 Fixed rysnc -> rsync typo
Change-Id: I671b4206072c6e22f4ae38033502336ec32e86ad
2016-10-19 20:17:00 +02:00
Jenkins
6daa382c34 Merge "Revises 'url' to 'URL' and 'json' to 'JSON'" 2016-10-06 00:23:41 +00:00
Yushiro FURUKAWA
9b98c89983 Revises 'url' to 'URL' and 'json' to 'JSON'
Change-Id: I44743fbb9bcbce3a50ed6770264ba0f4b17803d7
2016-09-30 22:21:03 +09:00
Jenkins
23c2d69ee1 Merge "Add more comment to authtoken sample options" 2016-09-30 04:21:18 +00:00
Alistair Coles
18bb99971f Add more comment to authtoken sample options
Prior to the Mitaka release the install guides showed
services (including Swift) being in a default Keystone
domain which existed by default and has id=default. This
domain id is reflected in the proxy-server.conf-sample
authtoken options and also shown in man page and auth docs.

The Mitaka install guide shows a domain with *name* default
being created, and having a random UUID assigned, in which
services are created. This has caused confusion (see
discussion on linked bug report).

This patch does not change the sample options but does
add to the comments in order to emphasize that a user
may need to alter the options to match their Keystone
configuration.

Change-Id: I17bfcdbd983402eeb561bb704b8b1f1e27547c7d
Partial-Bug: #1604674
2016-09-21 15:48:11 +01:00
Ondřej Nový
9a81b9537f Fixed cut and pasted paragraph from commit message in manpage
Change-Id: Iab839a917e407ce8119f0c6162751f11136cbf5b
2016-09-19 15:31:46 +02:00
Nandini Tata
51925e5e34 Add man page for swift.conf
Added man page for swift.conf

Change-Id: I88235ed414dfc34cb46f2fea014f1e721962885a
Closes-Bug: 1607027
2016-09-08 14:54:25 -07:00
Jenkins
c9c2571b83 Merge "Added missing manpages for all cli tools" 2016-09-07 02:11:30 +00:00
Ondřej Nový
0f761852f8 Added missing manpages for all cli tools
Change-Id: Ief3cf510d426a4eeefc8bb8d12f6fa9c8343f55b
Closes-Bug: #1607005
Closes-Bug: #1607007
Closes-Bug: #1607010
Closes-Bug: #1607012
Closes-Bug: #1607014
Closes-Bug: #1607016
Closes-Bug: #1607019
Closes-Bug: #1607021
Closes-Bug: #1607023
Closes-Bug: #1599923
2016-09-04 14:58:27 +02:00
Peter Lisák
8bf2233b40 Documantation enhancements of nice/ionice feature
Based on comments from patch #238799.

Change-Id: I9455cf6dc7fd12fee62439ff3c5f3255287ab1be
2016-08-19 07:39:49 +02:00
Jenkins
4992c7d399 Merge "Change schedule priority of daemon/server in config" 2016-08-18 08:34:48 +00:00
Jenkins
c87d04c5cb Merge "add swift-oldies man page" 2016-08-11 23:23:10 +00:00
Peter Lisák
ed772236c7 Change schedule priority of daemon/server in config
The goal is to modify schedule priority and I/O scheduling class and
priority of daemon/server via configuration.
Setting is optional, default keeps current behaviour.

Use case:
Prioritize object-server to object-auditor, because all user's requests
needed to be served in peak hours and audit could wait.

Co-Authored-By: Clay Gerrard <clay.gerrard@gmail.com>
DocImpact
Change-Id: I1018a18f4706daabdb84574ffd9a58d831e68396
2016-08-10 23:56:15 +02:00
Jenkins
a5a46854d5 Merge "NIT: fixing inconsistent naming of OpenStack Swift" 2016-08-09 18:16:13 +00:00
Jenkins
1956d4c398 Merge "Fix repeated OPTIONS in swift-dispersion-report manpage" 2016-08-09 18:07:16 +00:00
Shashirekha Gundur
c5ff9932a4 NIT: fixing inconsistent naming of OpenStack Swift
Throughout the manpages maintaining references to OpenStack Swift.

Change-Id: I2a0c2658e10a92671bfc092c0a3abaddfd8cd7d9
Closes-Bug: #1609687
2016-08-05 13:58:25 +00:00
Paul Dardeau
4f94e71d55 add swift-oldies man page
Closes-bug: #1607017
Change-Id: I365edf77c5bf34e2e51d7f10c9ea1012c1bda8ed
2016-08-04 10:43:48 -04:00
Alistair Coles
5cf24ecf16 Fix link to docs from swift-dispersion manpages
Change the link to the admin docs to point to #dispersion-report
rather than non-existent #cluster-health.

Change-Id: Ia2f4262c266201d4d555e7bedb8c5c2eb9fb1264
2016-08-02 10:57:59 +01:00
Alistair Coles
e0c7e6bf78 Fix repeated OPTIONS in swift-dispersion-report manpage
Remove the repeated OPTIONS section headers, which looks odd
and is inconsistent with swift-dispersion-populate.

Change-Id: I6d894e3b61002ddf7c0ea8a78cde226617eb11a6
2016-08-02 10:41:26 +01:00
Shashirekha Gundur
d819ae00a5 update swift-dispersion manpages to add policy-name
This change adds -P / --policy-name option to the swift-dispersion
manpages. Also tidied up a little removing some extra whitespace at the
end of lines.

Change-Id: Ic3372379994964e96258939580452f94fb575a06
Closes-Bug: #1605686
2016-08-02 07:30:56 +00:00
Jenkins
125a808fee Merge "Fix typo in object-server.conf and container-server.conf manpage" 2016-07-07 18:30:10 +00:00
Mohit Motiani
9e82891f08 Fix typo in object-server.conf and container-server.conf manpage
Change-Id: Iffad70b2fd901b305dc66d363039b7df44d619da
2016-07-07 15:21:01 +00:00
Mohit Motiani
4c0a1481f1 Fix typo in the account-server.conf manpage
Change-Id: I4e7bb85ce746fcb1ec3a4cbf534761e4e47634c9
Closes-Bug: #1599888
2016-07-07 14:56:10 +00:00
Mohit Motiani
6c9a1899a1 Adds region as a search-value in manpage
This patch adds region and example related to it in the man page
of swift-ring-builder.

Change-Id: I12ceab4e41240240cf2daa77dad94729dd1fd76d
2016-06-10 11:56:07 -07:00
Mohit Motiani
334140a543 Removed whitespaces from swift-ring-builder manpage
Change-Id: I25cf69f8d963ba84df4c59129d72ee39ec341bd3
2016-06-07 19:13:34 +00:00
Ondřej Nový
a54095e562 swift-ring-builder --yes option
This option assume a yes response to all questions. It is usefull for
scripts.

Change-Id: I28ca1a44507e0f1265afd36e6ac1e7c6c176428f
2016-05-31 17:11:13 +02:00
Jenkins
a403faadd4 Merge "Allow fallocate_reserve to be a percentage" 2016-05-12 08:18:39 +00:00
Jenkins
6a88f27eb0 Merge "Remove threads_per_disk setting" 2016-05-11 01:36:43 +00:00
Shashirekha Gundur
cf48e75c25 change default ports for servers
Changing the recommended ports for Swift services
from ports 6000-6002 to unused ports 6200-6202;
so they do not conflict with X-Windows or other services.

Updated SAIO docs.

DocImpact
Closes-Bug: #1521339
Change-Id: Ie1c778b159792c8e259e2a54cb86051686ac9d18
2016-04-29 14:47:38 -04:00
Christian Schwede
9d6a055b31 Remove threads_per_disk setting
This patch removes the threads_per_disk setting. It was already a deprecated
setting and by default set to 0, which effectively meant to not use a per-disk
thread pool at all. Users are encouraged to use servers_per_port instead.

DocImpact

Change-Id: Ie76be5c8a74d60a1330627caace19e06d1b9383c
2016-04-28 12:06:24 -05:00
Andy McCrae
0da9da5131 Allow fallocate_reserve to be a percentage
Add the ability to set the fallocate_reserve value as a percentage.
This happens automatically when adding the '%' at the end of the value.
Having the ability to set a % of free space rather than a byte value is
useful especially when drive sizes are heterogenous.

The default for fallocate_reserve has been adjusted to 1%, having the
fallocate_reserve set seems sensible for all deploys and percentages are
far safer to default than byte values (across drives of any size).

Tests added for using fallocate_reserve as a percentage.

Duplicate tests for fallocate_reserve have been removed.

Docs updated to reflect the fallocate_reserve change.

Change-Id: I4aea613a708205c917e81d6b2861396655e73238
2016-04-23 08:02:00 -05:00
Nguyen Hung Phuong
59bbe27fb0 Fix typos in Swift files
Change-Id: I34e0c9a888127704ac1910e73ddd14e27ebade13
2016-03-30 04:15:23 +00:00
Jenkins
4be3701805 Merge "Auditor will clean up stale rsync tempfiles" 2016-03-23 22:21:51 +00:00
Clay Gerrard
1d03803a85 Auditor will clean up stale rsync tempfiles
DiskFile already fills in the _ondisk_info attribute when it tries to open
a diskfile - even if the DiskFile's fileset is not valid or deleted.
During this process the rsync tempfiles would be discovered and logged,
but no-one would attempt to clean them up - even if they were really old.

Instead of logging and ignoring unexpected files when validate a DiskFile
fileset we'll add unexpected files to the unexpected key in the
_ondisk_info attribute.

With a little bit of re-organization in the auditor's object_audit method
to get things into a single return path we can add an unconditional check
for unexpected files and remove those that are "old enough".

Since the replicator will kill any rsync processes that are running longer
than the configured rsync_timeout we know that any rsync tempfiles older
than this can be deleted.

Split unlink_older_than in common.utils into two functions to allow an
explicit list of previously discovered paths to be passed in to avoid an
extra listdir.  Since the getmtime handling already ignores OSError
there's less concern of race condition where a previous discovered
unexpected file is reaped by rsync while we're attempting to clean it up.

Update some doc on the new config option.

Closes-Bug: #1554005

Change-Id: Id67681cb77f605e3491b8afcb9c69d769e154283
2016-03-23 19:34:34 +00:00
Alistair Coles
736de613f1 Docs: Container sync does not require POST-as-COPY
Updates docs to remove warnings that container sync only
works with object_post_as_copy=True. Since commit e91de49
container sync will also sync POST updates when using
object_post_as_copy=False.

Change-Id: I5cc3cc6e8f9ba2fef6f896f2b11d2a4e06825f7f
2016-03-22 11:36:32 +00:00
Jenkins
7cc2c783a4 Merge "Keystone middleware deprecated option is_admin removed" 2016-03-18 10:51:46 +00:00
Jenkins
1637fa2f8f Merge "Make keystone middleware options consistent in docs" 2016-03-18 10:43:23 +00:00
Alistair Coles
6efee0ebb1 Make keystone middleware options consistent in docs
Bring overview_auth.rst and proxy server man page
up to date with changes made in [1]

[1] Change-Id: I373734933189c87c4094203b0752dd3762689034

Change-Id: Ia16f0c391e7c357ccb9c13945839dc5647e49a13
2016-03-16 11:43:20 +00:00
Kota Tsuyuzaki
ecbcc94989 Fix ssync related object-server docs
Swift now uses SSYNC verb instead of old REPLICATION verb for ssync
protocol. This patch replaces all docs written as REPLICATION into
SSYNC and fix a few words for explanation.

Change-Id: I1253210d4f49749e7d425d6252dd262b650d9548
2016-03-16 08:58:31 +00:00
Ondřej Nový
335d58611d Keystone middleware deprecated option is_admin removed
It has been deprecated from Swift 1.8.0 (Grizzly)

Change-Id: Id6bc10c3e84262c0a9e6160a76af03c0ad363e9c
2016-02-11 10:52:47 +00:00
root
bcada66b90 Removed unused parameter in server.py
The variable max_large_object_get_time is no longer used and was
removed to reflect the change.

Change-Id: I43051181dcb38245de6d13fab63876e83f46fc39
Closes-Bug: #1538834
2016-02-10 14:26:10 -06:00
Ondřej Nový
ae632abbd8 Fixed manpages errors.
account-server.conf.5
105: warning: numeric expression expected (got `)')

container-server.conf.5
111: warning: numeric expression expected (got `)')

object-expirer.conf.5
79: warning: numeric expression expected (got `)')

object-server.conf.5
114: warning: numeric expression expected (got `)')

proxy-server.conf.5
121: warning: numeric expression expected (got `)')
331: warning: numeric expression expected (got `[')
1005: warning: macro `*' not defined

Change-Id: I203dcfde83035e3b1dcb91109b72b5d08bb7840e
2016-02-04 16:20:14 +01:00
Jenkins
eaf6af3179 Merge "Allow IPv6 addresses/hostnames in StatsD target" 2016-02-04 03:23:01 +00:00
Darrell Bishop
26327e1e8b Allow IPv6 addresses/hostnames in StatsD target
The log_statsd_host value can now be an IPv6 address or a hostname
which only resolves to an IPv6 address.  In both cases, the new
behavior is to use an AF_INET6 socket on which .sendto() is called
with the originally-configured hostname (or IP).  This means the
Swift process is not caching a DNS resolution for the lifetime of
the process (a good thing).

If a hostname resolves to both an IPv6 or IPv4 address, an AF_INET
socket is used (i.e. only the IPv4 address will receive the UDP
packet).

The old behavior is preserved: any invalid IP address literals and
failures in DNS resolution or actual StatsD packet sending do not
halt the process or bubble up; they are caught, logged, and
otherwise ignored.

Change-Id: Ibddddcf140e2e69b08edf3feed3e9a5fa17307cf
2016-02-03 00:26:31 -08:00
Thomas Goirand
c3886eea15 Fix a few English mistakes in man
These errors are producing lintian warnings, so fixing them
helps having less errors when checking for Debian packages.

Change-Id: Iff99a8d5f2276515f42d758d110a43cae757db28
2016-01-28 09:16:59 +00:00
Clay Gerrard
3347646023 fixups for ipv6 memcache_servers docs
Change-Id: I20d91c1e276014eaf210fa9eb43788bc17f4e8df
2016-01-12 21:08:58 -08:00
Ondřej Nový
3b1591f235 swift-init: New option kill-after-timeout
This option send SIGKILL to daemon after kill_wait period.
When daemon hangs and doesn't respond to SIGTERM/SIGHUP
there is no way to stop it using swift-init now. Classic
init scripts in Linux kills hanged process after grace
period and this patch add same behaviour. This is most
usefull when using "restart" on hanged daemon.

Change-Id: I8c932b673a0f51e52132df87ea2f4396f4bba9d8
2016-01-05 11:34:03 +01:00
Peter Lisák
28c4b7310f Unification of manpages and conf-samples (default values, etc)
Change-Id: I47a3127ef698b4bd1537b1562901ee9c2b5924d4
2015-11-30 10:08:16 -08:00