Retire project
Sheepdog is no longer actively maintained and support will be removed. http://lists.wpkg.org/pipermail/sheepdog/2019-March/068451.html Depends-on: https://review.opendev.org/#/c/660452/ Change-Id: Ic57c55dee0967ec425d74caf8a22dfc9893aef62 Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
This commit is contained in:
parent
e520447e65
commit
9bc5831198
2
.gitignore
vendored
2
.gitignore
vendored
@ -1,2 +0,0 @@
|
|||||||
*~
|
|
||||||
.tox
|
|
201
LICENSE.md
201
LICENSE.md
@ -1,201 +0,0 @@
|
|||||||
Apache License
|
|
||||||
Version 2.0, January 2004
|
|
||||||
http://www.apache.org/licenses/
|
|
||||||
|
|
||||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
||||||
|
|
||||||
1. Definitions.
|
|
||||||
|
|
||||||
"License" shall mean the terms and conditions for use, reproduction,
|
|
||||||
and distribution as defined by Sections 1 through 9 of this document.
|
|
||||||
|
|
||||||
"Licensor" shall mean the copyright owner or entity authorized by
|
|
||||||
the copyright owner that is granting the License.
|
|
||||||
|
|
||||||
"Legal Entity" shall mean the union of the acting entity and all
|
|
||||||
other entities that control, are controlled by, or are under common
|
|
||||||
control with that entity. For the purposes of this definition,
|
|
||||||
"control" means (i) the power, direct or indirect, to cause the
|
|
||||||
direction or management of such entity, whether by contract or
|
|
||||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
||||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
||||||
|
|
||||||
"You" (or "Your") shall mean an individual or Legal Entity
|
|
||||||
exercising permissions granted by this License.
|
|
||||||
|
|
||||||
"Source" form shall mean the preferred form for making modifications,
|
|
||||||
including but not limited to software source code, documentation
|
|
||||||
source, and configuration files.
|
|
||||||
|
|
||||||
"Object" form shall mean any form resulting from mechanical
|
|
||||||
transformation or translation of a Source form, including but
|
|
||||||
not limited to compiled object code, generated documentation,
|
|
||||||
and conversions to other media types.
|
|
||||||
|
|
||||||
"Work" shall mean the work of authorship, whether in Source or
|
|
||||||
Object form, made available under the License, as indicated by a
|
|
||||||
copyright notice that is included in or attached to the work
|
|
||||||
(an example is provided in the Appendix below).
|
|
||||||
|
|
||||||
"Derivative Works" shall mean any work, whether in Source or Object
|
|
||||||
form, that is based on (or derived from) the Work and for which the
|
|
||||||
editorial revisions, annotations, elaborations, or other modifications
|
|
||||||
represent, as a whole, an original work of authorship. For the purposes
|
|
||||||
of this License, Derivative Works shall not include works that remain
|
|
||||||
separable from, or merely link (or bind by name) to the interfaces of,
|
|
||||||
the Work and Derivative Works thereof.
|
|
||||||
|
|
||||||
"Contribution" shall mean any work of authorship, including
|
|
||||||
the original version of the Work and any modifications or additions
|
|
||||||
to that Work or Derivative Works thereof, that is intentionally
|
|
||||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
||||||
or by an individual or Legal Entity authorized to submit on behalf of
|
|
||||||
the copyright owner. For the purposes of this definition, "submitted"
|
|
||||||
means any form of electronic, verbal, or written communication sent
|
|
||||||
to the Licensor or its representatives, including but not limited to
|
|
||||||
communication on electronic mailing lists, source code control systems,
|
|
||||||
and issue tracking systems that are managed by, or on behalf of, the
|
|
||||||
Licensor for the purpose of discussing and improving the Work, but
|
|
||||||
excluding communication that is conspicuously marked or otherwise
|
|
||||||
designated in writing by the copyright owner as "Not a Contribution."
|
|
||||||
|
|
||||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
||||||
on behalf of whom a Contribution has been received by Licensor and
|
|
||||||
subsequently incorporated within the Work.
|
|
||||||
|
|
||||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
||||||
this License, each Contributor hereby grants to You a perpetual,
|
|
||||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
||||||
copyright license to reproduce, prepare Derivative Works of,
|
|
||||||
publicly display, publicly perform, sublicense, and distribute the
|
|
||||||
Work and such Derivative Works in Source or Object form.
|
|
||||||
|
|
||||||
3. Grant of Patent License. Subject to the terms and conditions of
|
|
||||||
this License, each Contributor hereby grants to You a perpetual,
|
|
||||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
||||||
(except as stated in this section) patent license to make, have made,
|
|
||||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
||||||
where such license applies only to those patent claims licensable
|
|
||||||
by such Contributor that are necessarily infringed by their
|
|
||||||
Contribution(s) alone or by combination of their Contribution(s)
|
|
||||||
with the Work to which such Contribution(s) was submitted. If You
|
|
||||||
institute patent litigation against any entity (including a
|
|
||||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
||||||
or a Contribution incorporated within the Work constitutes direct
|
|
||||||
or contributory patent infringement, then any patent licenses
|
|
||||||
granted to You under this License for that Work shall terminate
|
|
||||||
as of the date such litigation is filed.
|
|
||||||
|
|
||||||
4. Redistribution. You may reproduce and distribute copies of the
|
|
||||||
Work or Derivative Works thereof in any medium, with or without
|
|
||||||
modifications, and in Source or Object form, provided that You
|
|
||||||
meet the following conditions:
|
|
||||||
|
|
||||||
(a) You must give any other recipients of the Work or
|
|
||||||
Derivative Works a copy of this License; and
|
|
||||||
|
|
||||||
(b) You must cause any modified files to carry prominent notices
|
|
||||||
stating that You changed the files; and
|
|
||||||
|
|
||||||
(c) You must retain, in the Source form of any Derivative Works
|
|
||||||
that You distribute, all copyright, patent, trademark, and
|
|
||||||
attribution notices from the Source form of the Work,
|
|
||||||
excluding those notices that do not pertain to any part of
|
|
||||||
the Derivative Works; and
|
|
||||||
|
|
||||||
(d) If the Work includes a "NOTICE" text file as part of its
|
|
||||||
distribution, then any Derivative Works that You distribute must
|
|
||||||
include a readable copy of the attribution notices contained
|
|
||||||
within such NOTICE file, excluding those notices that do not
|
|
||||||
pertain to any part of the Derivative Works, in at least one
|
|
||||||
of the following places: within a NOTICE text file distributed
|
|
||||||
as part of the Derivative Works; within the Source form or
|
|
||||||
documentation, if provided along with the Derivative Works; or,
|
|
||||||
within a display generated by the Derivative Works, if and
|
|
||||||
wherever such third-party notices normally appear. The contents
|
|
||||||
of the NOTICE file are for informational purposes only and
|
|
||||||
do not modify the License. You may add Your own attribution
|
|
||||||
notices within Derivative Works that You distribute, alongside
|
|
||||||
or as an addendum to the NOTICE text from the Work, provided
|
|
||||||
that such additional attribution notices cannot be construed
|
|
||||||
as modifying the License.
|
|
||||||
|
|
||||||
You may add Your own copyright statement to Your modifications and
|
|
||||||
may provide additional or different license terms and conditions
|
|
||||||
for use, reproduction, or distribution of Your modifications, or
|
|
||||||
for any such Derivative Works as a whole, provided Your use,
|
|
||||||
reproduction, and distribution of the Work otherwise complies with
|
|
||||||
the conditions stated in this License.
|
|
||||||
|
|
||||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
||||||
any Contribution intentionally submitted for inclusion in the Work
|
|
||||||
by You to the Licensor shall be under the terms and conditions of
|
|
||||||
this License, without any additional terms or conditions.
|
|
||||||
Notwithstanding the above, nothing herein shall supersede or modify
|
|
||||||
the terms of any separate license agreement you may have executed
|
|
||||||
with Licensor regarding such Contributions.
|
|
||||||
|
|
||||||
6. Trademarks. This License does not grant permission to use the trade
|
|
||||||
names, trademarks, service marks, or product names of the Licensor,
|
|
||||||
except as required for reasonable and customary use in describing the
|
|
||||||
origin of the Work and reproducing the content of the NOTICE file.
|
|
||||||
|
|
||||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
||||||
agreed to in writing, Licensor provides the Work (and each
|
|
||||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
||||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
||||||
implied, including, without limitation, any warranties or conditions
|
|
||||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
||||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
||||||
appropriateness of using or redistributing the Work and assume any
|
|
||||||
risks associated with Your exercise of permissions under this License.
|
|
||||||
|
|
||||||
8. Limitation of Liability. In no event and under no legal theory,
|
|
||||||
whether in tort (including negligence), contract, or otherwise,
|
|
||||||
unless required by applicable law (such as deliberate and grossly
|
|
||||||
negligent acts) or agreed to in writing, shall any Contributor be
|
|
||||||
liable to You for damages, including any direct, indirect, special,
|
|
||||||
incidental, or consequential damages of any character arising as a
|
|
||||||
result of this License or out of the use or inability to use the
|
|
||||||
Work (including but not limited to damages for loss of goodwill,
|
|
||||||
work stoppage, computer failure or malfunction, or any and all
|
|
||||||
other commercial damages or losses), even if such Contributor
|
|
||||||
has been advised of the possibility of such damages.
|
|
||||||
|
|
||||||
9. Accepting Warranty or Additional Liability. While redistributing
|
|
||||||
the Work or Derivative Works thereof, You may choose to offer,
|
|
||||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
||||||
or other liability obligations and/or rights consistent with this
|
|
||||||
License. However, in accepting such obligations, You may act only
|
|
||||||
on Your own behalf and on Your sole responsibility, not on behalf
|
|
||||||
of any other Contributor, and only if You agree to indemnify,
|
|
||||||
defend, and hold each Contributor harmless for any liability
|
|
||||||
incurred by, or claims asserted against, such Contributor by reason
|
|
||||||
of your accepting any such warranty or additional liability.
|
|
||||||
|
|
||||||
END OF TERMS AND CONDITIONS
|
|
||||||
|
|
||||||
APPENDIX: How to apply the Apache License to your work.
|
|
||||||
|
|
||||||
To apply the Apache License to your work, attach the following
|
|
||||||
boilerplate notice, with the fields enclosed by brackets "{}"
|
|
||||||
replaced with your own identifying information. (Don't include
|
|
||||||
the brackets!) The text should be enclosed in the appropriate
|
|
||||||
comment syntax for the file format. We also recommend that a
|
|
||||||
file or class name and description of purpose be included on the
|
|
||||||
same "printed page" as the copyright notice for easier
|
|
||||||
identification within third-party archives.
|
|
||||||
|
|
||||||
Copyright {yyyy} {name of copyright owner}
|
|
||||||
|
|
||||||
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.
|
|
19
README.rst
19
README.rst
@ -1,13 +1,10 @@
|
|||||||
======================
|
This project is no longer maintained.
|
||||||
Enabling in Devstack
|
|
||||||
======================
|
|
||||||
|
|
||||||
1. Download DevStack
|
The contents of this repository are still available in the Git
|
||||||
|
source code management system. To see the contents of this
|
||||||
|
repository before it reached its end of life, please check out the
|
||||||
|
previous commit with "git checkout HEAD^1".
|
||||||
|
|
||||||
2. Add this repo as an external repository::
|
For any further questions, please email
|
||||||
|
openstack-discuss@lists.openstack.org or join #openstack-dev on
|
||||||
cat > local.conf
|
Freenode.
|
||||||
[[local|localrc]]
|
|
||||||
enable_plugin sheepdog https://github.com/openstack/devstack-plugin-sheepdog.git
|
|
||||||
|
|
||||||
3. run ``stack.sh``
|
|
||||||
|
@ -1,150 +0,0 @@
|
|||||||
# DevStack extras script to install Sheepdog
|
|
||||||
|
|
||||||
# Dependencies:
|
|
||||||
#
|
|
||||||
# - ``functions`` file
|
|
||||||
# - ``cinder`` configurations
|
|
||||||
# - ``SHEEPDOG_DATA_DIR`` or ``DATA_DIR`` must be defined
|
|
||||||
|
|
||||||
# ``stack.sh`` calls the entry points in this order (via ``extras.d/60-sheepdog.sh``):
|
|
||||||
#
|
|
||||||
# - install_sheepdog
|
|
||||||
# - configure_sheepdog
|
|
||||||
# - init_sheepdog
|
|
||||||
# - start_sheepdog
|
|
||||||
# - stop_sheepdog
|
|
||||||
# - cleanup_sheepdog
|
|
||||||
|
|
||||||
# Defaults
|
|
||||||
# --------
|
|
||||||
|
|
||||||
# Set ``SHEEPDOG_DATA_DIR`` to the location of Sheepdog drives and objects.
|
|
||||||
# Default is the common DevStack data directory.
|
|
||||||
SHEEPDOG_DATA_DIR=${SHEEPDOG_DATA_DIR:-${DATA_DIR}/sheepdog}
|
|
||||||
SHEEPDOG_DISK_IMAGE=${SHEEPDOG_DATA_DIR}/drives/images/sheepdog.img
|
|
||||||
|
|
||||||
# DevStack will create a loop-back disk formatted as XFS to store the
|
|
||||||
# Sheepdog data. Set ``SHEEPDOG_LOOPBACK_DISK_SIZE`` to the disk size in
|
|
||||||
# kilobytes.
|
|
||||||
# Default is 8 gigabyte.
|
|
||||||
SHEEPDOG_LOOPBACK_DISK_SIZE_DEFAULT=8G
|
|
||||||
SHEEPDOG_LOOPBACK_DISK_SIZE=${SHEEPDOG_LOOPBACK_DISK_SIZE:-$SHEEPDOG_LOOPBACK_DISK_SIZE_DEFAULT}
|
|
||||||
|
|
||||||
# Functions
|
|
||||||
# ------------
|
|
||||||
|
|
||||||
# check_os_support_sheepdog() - Check if the operating system provides a decent version of Sheepdog
|
|
||||||
function check_os_support_sheepdog {
|
|
||||||
if [[ ! ${DISTRO} =~ (trusty) && ! ${DISTRO} =~ (xenial) ]]; then
|
|
||||||
echo "WARNING: your distro $DISTRO does not provide (at least) the Firefly release. Please use Ubuntu Trusty or Xenial."
|
|
||||||
if [[ "$FORCE_SHEEPDOG_INSTALL" != "yes" ]]; then
|
|
||||||
die $LINENO "If you wish to install Sheepdog on this distribution anyway run with FORCE_SHEEPDOG_INSTALL=yes"
|
|
||||||
fi
|
|
||||||
NO_UPDATE_REPOS=False
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
# stop_sheepdog() - Stop running processes (non-screen)
|
|
||||||
function stop_sheepdog {
|
|
||||||
stop_process sheepdog
|
|
||||||
|
|
||||||
if egrep -q ${SHEEPDOG_DATA_DIR} /proc/mounts; then
|
|
||||||
sudo umount ${SHEEPDOG_DATA_DIR}
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
# cleanup_sheepdog() - Remove residual data files, anything left over from previous
|
|
||||||
# runs that a clean run would need to clean up
|
|
||||||
function cleanup_sheepdog {
|
|
||||||
stop_sheepdog
|
|
||||||
|
|
||||||
if [[ -e ${SHEEPDOG_DISK_IMAGE} ]]; then
|
|
||||||
sudo rm -f ${SHEEPDOG_DISK_IMAGE}
|
|
||||||
fi
|
|
||||||
uninstall_package sheepdog > /dev/null 2>&1
|
|
||||||
}
|
|
||||||
|
|
||||||
# configure_sheepdog() - Set config files, create data dirs, etc
|
|
||||||
function configure_sheepdog {
|
|
||||||
# create a backing file disk
|
|
||||||
create_disk ${SHEEPDOG_DISK_IMAGE} ${SHEEPDOG_DATA_DIR} ${SHEEPDOG_LOOPBACK_DISK_SIZE}
|
|
||||||
sudo chown -R ${STACK_USER}: ${SHEEPDOG_DATA_DIR}
|
|
||||||
}
|
|
||||||
|
|
||||||
# install_sheepdog() - Collect source and prepare
|
|
||||||
function install_sheepdog {
|
|
||||||
if [[ ${os_CODENAME} =~ trusty || ${os_CODENAME} =~ xenial ]]; then
|
|
||||||
NO_UPDATE_REPOS=False
|
|
||||||
install_package sheepdog
|
|
||||||
install_package xfsprogs
|
|
||||||
else
|
|
||||||
exit_distro_not_supported "Sheepdog since your distro doesn't provide (at least) the Firefly release. Please use Ubuntu Trusty or Xenial."
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
# start_sheepdog() - Start running processes, including screen
|
|
||||||
function start_sheepdog {
|
|
||||||
if [[ ${DISTRO} =~ (trusty) ]]; then
|
|
||||||
run_process sheepdog "sheep -f -o -l 7 -c local -n ${SHEEPDOG_DATA_DIR}"
|
|
||||||
elif [[ ${DISTRO} =~ (xenial) ]]; then
|
|
||||||
SHEEP_COMMAND_PATH=`which sheep`
|
|
||||||
run_process sheepdog "$SHEEP_COMMAND_PATH -l dst=stdout,level=debug,format=server -c local -n ${SHEEPDOG_DATA_DIR}"
|
|
||||||
else
|
|
||||||
exit_distro_not_supported "Sheepdog since your distro doesn't provide (at least) the Firefly release. Please use Ubuntu Trusty or Xenial."
|
|
||||||
fi
|
|
||||||
|
|
||||||
sleep 3
|
|
||||||
|
|
||||||
dog cluster format -c 1
|
|
||||||
}
|
|
||||||
|
|
||||||
# configure_cinder_backend_sheepdog - Configure Cinder for Sheepdog backends
|
|
||||||
function configure_cinder_backend_sheepdog {
|
|
||||||
local be_name=$1
|
|
||||||
iniset $CINDER_CONF $be_name volume_backend_name $be_name
|
|
||||||
iniset $CINDER_CONF $be_name volume_driver "cinder.volume.drivers.sheepdog.SheepdogDriver"
|
|
||||||
|
|
||||||
# NOTE(yamada-h):
|
|
||||||
# Sheepdog driver is marked as unsupported at Jan 2017.
|
|
||||||
# We will remove this config after the driver is supported.
|
|
||||||
iniset $CINDER_CONF $be_name enable_unsupported_driver true
|
|
||||||
}
|
|
||||||
|
|
||||||
function configure_sheepdog_glance {
|
|
||||||
iniset $GLANCE_API_CONF DEFAULT show_image_direct_url true
|
|
||||||
iniset $GLANCE_API_CONF sheepdog default_store sheepdog
|
|
||||||
iniset $GLANCE_API_CONF sheepdog stores file,http,sheepdog
|
|
||||||
iniset $GLANCE_API_CONF sheepdog sheepdog_store_address 127.0.0.1
|
|
||||||
}
|
|
||||||
|
|
||||||
if [[ "$1" == "source" ]]; then
|
|
||||||
# Initial source
|
|
||||||
source $TOP_DIR/lib/sheepdog
|
|
||||||
elif [[ "$1" == "stack" && "$2" == "install" ]]; then
|
|
||||||
echo_summary "Installing Sheepdog"
|
|
||||||
check_os_support_sheepdog
|
|
||||||
install_sheepdog
|
|
||||||
elif [[ "$1" == "stack" && "$2" == "post-config" ]]; then
|
|
||||||
echo_summary "Configuring Sheepdog"
|
|
||||||
configure_sheepdog
|
|
||||||
configure_sheepdog_glance
|
|
||||||
|
|
||||||
# We need to have Sheepdog started before the main OpenStack components.
|
|
||||||
start_sheepdog
|
|
||||||
elif [[ "$1" == "stack" && "$2" == "test-config" ]]; then
|
|
||||||
if is_service_enabled tempest; then
|
|
||||||
iniset $TEMPEST_CONFIG compute-feature-enabled swap_volume False
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [[ "$1" == "unstack" ]]; then
|
|
||||||
stop_sheepdog
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [[ "$1" == "clean" ]]; then
|
|
||||||
cleanup_sheepdog
|
|
||||||
fi
|
|
||||||
|
|
||||||
## Local variables:
|
|
||||||
## mode: shell-script
|
|
||||||
## End:
|
|
@ -1,15 +0,0 @@
|
|||||||
# Devstack settings
|
|
||||||
|
|
||||||
# we have to add sheepdog to enabled services for run_process to work
|
|
||||||
enable_service sheepdog
|
|
||||||
|
|
||||||
# sheepdog driver doesn't support backup features
|
|
||||||
disable_service c-bak
|
|
||||||
|
|
||||||
# enable sheepdog cinder backend
|
|
||||||
CINDER_ENABLED_BACKENDS=sheepdog:sheepdog
|
|
||||||
TEMPEST_STORAGE_PROTOCOL=sheepdog
|
|
||||||
BUILD_TIMEOUT=600
|
|
||||||
|
|
||||||
# disable encrypted volume feature
|
|
||||||
ATTACH_ENCRYPTED_VOLUME_AVAILABLE=False
|
|
25
tox.ini
25
tox.ini
@ -1,25 +0,0 @@
|
|||||||
[tox]
|
|
||||||
minversion = 1.6
|
|
||||||
skipsdist = True
|
|
||||||
envlist = bashate
|
|
||||||
|
|
||||||
[testenv]
|
|
||||||
usedevelop = False
|
|
||||||
install_command = pip install {opts} {packages}
|
|
||||||
|
|
||||||
[testenv:bashate]
|
|
||||||
deps = bashate
|
|
||||||
whitelist_externals = bash
|
|
||||||
commands = bash -c "find {toxinidir} \
|
|
||||||
-not \( -type d -name .?\* -prune \) \
|
|
||||||
-not \( -type d -name doc -prune \) \
|
|
||||||
-type f \
|
|
||||||
-not -name \*~ \
|
|
||||||
-not -name \*.md \
|
|
||||||
\( \
|
|
||||||
-name \*.sh -or \
|
|
||||||
-name \*rc -or \
|
|
||||||
-name functions\* -or \
|
|
||||||
-wholename \*/lib/\* \
|
|
||||||
\) \
|
|
||||||
-print0 | xargs -0 bashate -v"
|
|
Loading…
Reference in New Issue
Block a user