swift/doc/manpages/swift-object-expirer.1
Kazuhiro MIYAHARA 443f029a58 Enable to configure object-expirer in object-server.conf
To prepare for object-expirer's general task queue feature [1],
this patch enables to configure object-expirer in object-server.conf.
Object-expirer.conf can be used in the same manner as before, but deprecated.

If both of object-server.conf with "object-expirer" section and
object-expirer.conf are in a node, only object-server.conf is used.
Object-expirer.conf is used only if all object-server.conf doesn't have
"object-expirer" section.

There are two differences between "object-expirer.conf" style and
"object-server.conf" style.

The first difference is `dequeue_from_legacy` default value.
`dequeue_from_legacy` defines task queue mode. In "object-expirer.conf"
style, the default mode is legacy queue. In "object-server.conf" style,
the default mode is general queue. But general mode means no-op mode
for now, because general task queue is not implemented yet.

The second difference is internal client config. In "object-expirer.conf"
style, config file of internal client is the object-expirer.conf itself.
In "object-server.conf" style, config file of internal client is
another file.

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

Co-Authored-By: Matthew Oliver <matt@oliver.net.au>

Change-Id: Ib21568f9b9d8547da87a99d65ae73a550e9c3230
2019-05-04 15:45:02 +00:00

76 lines
2.1 KiB
Groff

.\"
.\" Author: Joao Marcelo Martins <marcelo.martins@rackspace.com> or <btorch@gmail.com>
.\" Copyright (c) 2012 OpenStack Foundation.
.\"
.\" Licensed under the Apache License, Version 2.0 (the "License");
.\" you may not use this file except in compliance with the License.
.\" You may obtain a copy of the License at
.\"
.\" http://www.apache.org/licenses/LICENSE-2.0
.\"
.\" Unless required by applicable law or agreed to in writing, software
.\" distributed under the License is distributed on an "AS IS" BASIS,
.\" WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
.\" implied.
.\" See the License for the specific language governing permissions and
.\" limitations under the License.
.\"
.TH swift-object-expirer 1 "3/15/2012" "Linux" "OpenStack Swift"
.SH NAME
.LP
.B swift-object-expirer
\- OpenStack Swift object expirer
.SH SYNOPSIS
.LP
.B swift-object-expirer
[CONFIG] [-h|--help] [-v|--verbose] [-o|--once]
.SH DESCRIPTION
.PP
The swift-object-expirer offers scheduled deletion of objects. The Swift client would
use the X-Delete-At or X-Delete-After headers during an object PUT or POST and the
cluster would automatically quit serving that object at the specified time and would
shortly thereafter remove the object from the system.
The X-Delete-At header takes a Unix Epoch timestamp, in integer form; for example:
1317070737 represents Mon Sep 26 20:58:57 2011 UTC.
The X-Delete-After header takes an integer number of seconds. The proxy server
that receives the request will convert this header into an X-Delete-At header
using its current time plus the value given.
The options are as follows:
.RS 4
.PD 0
.IP "-v"
.IP "--verbose"
.RS 4
.IP "log to console"
.RE
.IP "-o"
.IP "--once"
.RS 4
.IP "only run one pass of daemon"
.RE
.PD
.RE
.SH DOCUMENTATION
.LP
More in depth documentation in regards to
.BI swift-object-expirer
can be found at
.BI https://docs.openstack.org/swift/latest/overview_expiring_objects.html
and also about OpenStack Swift as a whole can be found at
.BI https://docs.openstack.org/swift/latest/
.SH "SEE ALSO"
.BR object-server.conf(5)
.BR object-expirer.conf(5)