Merge "Add install-guide for karbor"
This commit is contained in:
Jenkins
Gerrit Code Review
commit
ae2f2f9269
|
|
@ -0,0 +1,301 @@
|
|||
# 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.
|
||||
|
||||
# This file is execfile()d with the current directory set to its
|
||||
# containing dir.
|
||||
#
|
||||
# Note that not all possible configuration values are present in this
|
||||
# autogenerated file.
|
||||
#
|
||||
# All configuration values have a default; values that are commented out
|
||||
# serve to show the default.
|
||||
|
||||
import os
|
||||
# import sys
|
||||
|
||||
|
||||
import openstackdocstheme
|
||||
|
||||
# If extensions (or modules to document with autodoc) are in another directory,
|
||||
# add these directories to sys.path here. If the directory is relative to the
|
||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||
# sys.path.insert(0, os.path.abspath('.'))
|
||||
|
||||
# -- General configuration ------------------------------------------------
|
||||
|
||||
# If your documentation needs a minimal Sphinx version, state it here.
|
||||
# needs_sphinx = '1.0'
|
||||
|
||||
# Add any Sphinx extension module names here, as strings. They can be
|
||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||
# ones.
|
||||
# TODO(ajaeger): enable PDF building, for example add 'rst2pdf.pdfbuilder'
|
||||
# extensions =
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
# templates_path = ['_templates']
|
||||
|
||||
# The suffix of source filenames.
|
||||
source_suffix = '.rst'
|
||||
|
||||
# The encoding of source files.
|
||||
# source_encoding = 'utf-8-sig'
|
||||
|
||||
# The master toctree document.
|
||||
master_doc = 'index'
|
||||
|
||||
# General information about the project.
|
||||
project = u'Installation Guide for Data Protection Service'
|
||||
bug_tag = u'install-guide'
|
||||
copyright = u'2017, OpenStack contributors'
|
||||
|
||||
# The version info for the project you're documenting, acts as replacement for
|
||||
# |version| and |release|, also used in various other places throughout the
|
||||
# built documents.
|
||||
#
|
||||
# The short X.Y version.
|
||||
version = '0.1'
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = '0.1'
|
||||
|
||||
# A few variables have to be set for the log-a-bug feature.
|
||||
# giturl: The location of conf.py on Git. Must be set manually.
|
||||
# gitsha: The SHA checksum of the bug description. Automatically extracted
|
||||
# from git log.
|
||||
# bug_tag: Tag for categorizing the bug. Must be set manually.
|
||||
# These variables are passed to the logabug code via html_context.
|
||||
giturl = u'http://git.openstack.org/cgit/openstack/karbor/tree/' \
|
||||
u'install-guide/source'
|
||||
git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '"
|
||||
gitsha = os.popen(git_cmd).read().strip('\n')
|
||||
html_context = {"gitsha": gitsha, "bug_tag": bug_tag,
|
||||
"giturl": giturl, "bug_project": "karbor"}
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
# language = None
|
||||
|
||||
# There are two options for replacing |today|: either, you set today to some
|
||||
# non-false value, then it is used:
|
||||
# today = ''
|
||||
# Else, today_fmt is used as the format for a strftime call.
|
||||
# today_fmt = '%B %d, %Y'
|
||||
|
||||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
exclude_patterns = []
|
||||
|
||||
# The reST default role (used for this markup: `text`) to use for all
|
||||
# documents.
|
||||
# default_role = None
|
||||
|
||||
# If true, '()' will be appended to :func: etc. cross-reference text.
|
||||
# add_function_parentheses = True
|
||||
|
||||
# If true, the current module name will be prepended to all description
|
||||
# unit titles (such as .. function::).
|
||||
# add_module_names = True
|
||||
|
||||
# If true, sectionauthor and moduleauthor directives will be shown in the
|
||||
# output. They are ignored by default.
|
||||
# show_authors = False
|
||||
|
||||
# The name of the Pygments (syntax highlighting) style to use.
|
||||
pygments_style = 'sphinx'
|
||||
|
||||
# A list of ignored prefixes for module index sorting.
|
||||
# modindex_common_prefix = []
|
||||
|
||||
# If true, keep warnings as "system message" paragraphs in the built documents.
|
||||
# keep_warnings = False
|
||||
|
||||
|
||||
# -- Options for HTML output ----------------------------------------------
|
||||
|
||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
html_theme = 'openstackdocs'
|
||||
|
||||
# Theme options are theme-specific and customize the look and feel of a theme
|
||||
# further. For a list of options available for each theme, see the
|
||||
# documentation.
|
||||
# html_theme_options = {}
|
||||
|
||||
# Add any paths that contain custom themes here, relative to this directory.
|
||||
html_theme_path = [openstackdocstheme.get_html_theme_path()]
|
||||
|
||||
# The name for this set of Sphinx documents. If None, it defaults to
|
||||
# "<project> v<release> documentation".
|
||||
# html_title = None
|
||||
|
||||
# A shorter title for the navigation bar. Default is the same as html_title.
|
||||
# html_short_title = None
|
||||
|
||||
# The name of an image file (relative to this directory) to place at the top
|
||||
# of the sidebar.
|
||||
# html_logo = None
|
||||
|
||||
# The name of an image file (within the static path) to use as favicon of the
|
||||
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
||||
# pixels large.
|
||||
# html_favicon = None
|
||||
|
||||
# Add any paths that contain custom static files (such as style sheets) here,
|
||||
# relative to this directory. They are copied after the builtin static files,
|
||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||
# html_static_path = []
|
||||
|
||||
# Add any extra paths that contain custom files (such as robots.txt or
|
||||
# .htaccess) here, relative to this directory. These files are copied
|
||||
# directly to the root of the documentation.
|
||||
# html_extra_path = []
|
||||
|
||||
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
||||
# using the given strftime format.
|
||||
# So that we can enable "log-a-bug" links from each output HTML page, this
|
||||
# variable must be set to a format that includes year, month, day, hours and
|
||||
# minutes.
|
||||
html_last_updated_fmt = '%Y-%m-%d %H:%M'
|
||||
|
||||
|
||||
# If true, SmartyPants will be used to convert quotes and dashes to
|
||||
# typographically correct entities.
|
||||
# html_use_smartypants = True
|
||||
|
||||
# Custom sidebar templates, maps document names to template names.
|
||||
# html_sidebars = {}
|
||||
|
||||
# Additional templates that should be rendered to pages, maps page names to
|
||||
# template names.
|
||||
# html_additional_pages = {}
|
||||
|
||||
# If false, no module index is generated.
|
||||
# html_domain_indices = True
|
||||
|
||||
# If false, no index is generated.
|
||||
html_use_index = False
|
||||
|
||||
# If true, the index is split into individual pages for each letter.
|
||||
# html_split_index = False
|
||||
|
||||
# If true, links to the reST sources are added to the pages.
|
||||
html_show_sourcelink = False
|
||||
|
||||
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
||||
# html_show_sphinx = True
|
||||
|
||||
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
||||
# html_show_copyright = True
|
||||
|
||||
# If true, an OpenSearch description file will be output, and all pages will
|
||||
# contain a <link> tag referring to it. The value of this option must be the
|
||||
# base URL from which the finished HTML is served.
|
||||
# html_use_opensearch = ''
|
||||
|
||||
# This is the file name suffix for HTML files (e.g. ".xhtml").
|
||||
# html_file_suffix = None
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = 'install-guide'
|
||||
|
||||
# If true, publish source files
|
||||
html_copy_source = False
|
||||
|
||||
# -- Options for LaTeX output ---------------------------------------------
|
||||
|
||||
latex_elements = {
|
||||
# The paper size ('letterpaper' or 'a4paper').
|
||||
# 'papersize': 'letterpaper',
|
||||
|
||||
# The font size ('10pt', '11pt' or '12pt').
|
||||
# 'pointsize': '10pt',
|
||||
|
||||
# Additional stuff for the LaTeX preamble.
|
||||
# 'preamble': '',
|
||||
}
|
||||
|
||||
# Grouping the document tree into LaTeX files. List of tuples
|
||||
# (source start file, target name, title,
|
||||
# author, documentclass [howto, manual, or own class]).
|
||||
latex_documents = [
|
||||
('index', 'InstallGuide.tex', u'Install Guide',
|
||||
u'OpenStack contributors', 'manual'),
|
||||
]
|
||||
|
||||
# The name of an image file (relative to this directory) to place at the top of
|
||||
# the title page.
|
||||
# latex_logo = None
|
||||
|
||||
# For "manual" documents, if this is true, then toplevel headings are parts,
|
||||
# not chapters.
|
||||
# latex_use_parts = False
|
||||
|
||||
# If true, show page references after internal links.
|
||||
# latex_show_pagerefs = False
|
||||
|
||||
# If true, show URL addresses after external links.
|
||||
# latex_show_urls = False
|
||||
|
||||
# Documents to append as an appendix to all manuals.
|
||||
# latex_appendices = []
|
||||
|
||||
# If false, no module index is generated.
|
||||
# latex_domain_indices = True
|
||||
|
||||
|
||||
# -- Options for manual page output ---------------------------------------
|
||||
|
||||
# One entry per manual page. List of tuples
|
||||
# (source start file, name, description, authors, manual section).
|
||||
man_pages = [
|
||||
('index', 'installguide', u'Install Guide',
|
||||
[u'OpenStack contributors'], 1)
|
||||
]
|
||||
|
||||
# If true, show URL addresses after external links.
|
||||
# man_show_urls = False
|
||||
|
||||
|
||||
# -- Options for Texinfo output -------------------------------------------
|
||||
|
||||
# Grouping the document tree into Texinfo files. List of tuples
|
||||
# (source start file, target name, title, author,
|
||||
# dir menu entry, description, category)
|
||||
texinfo_documents = [
|
||||
('index', 'InstallGuide', u'Install Guide',
|
||||
u'OpenStack contributors', 'InstallGuide',
|
||||
'This guide shows OpenStack end users how to install '
|
||||
'an OpenStack Data Protection Service.', 'Miscellaneous'),
|
||||
]
|
||||
|
||||
# Documents to append as an appendix to all manuals.
|
||||
# texinfo_appendices = []
|
||||
|
||||
# If false, no module index is generated.
|
||||
# texinfo_domain_indices = True
|
||||
|
||||
# How to display URL addresses: 'footnote', 'no', or 'inline'.
|
||||
# texinfo_show_urls = 'footnote'
|
||||
|
||||
# If true, do not generate a @detailmenu in the "Top" node's menu.
|
||||
# texinfo_no_detailmenu = False
|
||||
|
||||
# -- Options for Internationalization output ------------------------------
|
||||
locale_dirs = ['locale/']
|
||||
|
||||
# -- Options for PDF output --------------------------------------------------
|
||||
|
||||
pdf_documents = [
|
||||
('index', u'InstallGuide', u'Install Guide',
|
||||
u'OpenStack contributors')
|
||||
]
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
================================
|
||||
Data Protection service overview
|
||||
================================
|
||||
|
||||
Karbor responsibility is protecting the Data and Meta-Data that comprises an
|
||||
OpenStack-deployed Application against loss/damage (e.g. backup, replication)
|
||||
- not to be confused with Application Security or DLP. It does that by providing
|
||||
a standard framework of APIs and services that enables vendors to introduce various data
|
||||
protection services into a coherent and unified flow for the user.
|
||||
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
=======================
|
||||
Data Protection service
|
||||
=======================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
get_started.rst
|
||||
install.rst
|
||||
verify.rst
|
||||
launch-instance.rst
|
||||
next-steps.rst
|
||||
|
||||
To protect the Data and Metadata that comprises an OpenStack-deployed
|
||||
Application against loss/damage (e.g. backup, replication), The Data
|
||||
Protection service (Karbor) provides a standard framework of APIs and
|
||||
services that allows vendors to provide plugins through a unified interface.
|
||||
|
||||
This chapter assumes a working setup of OpenStack following the
|
||||
`OpenStack Installation Tutorial <http://docs.openstack.org/#install-guides>`_.
|
||||
|
|
@ -0,0 +1,242 @@
|
|||
.. _install-ubuntu:
|
||||
|
||||
Install and configure for Ubuntu
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
This section describes how to install and configure the Data Protection
|
||||
service for Ubuntu 14.04 (LTS) and Ubuntu 16.04 (LTS).
|
||||
|
||||
Prerequisites
|
||||
-------------
|
||||
|
||||
Before you install and configure Data Protection service, you must create a
|
||||
database, service credentials, and API endpoints. Data Protection service also
|
||||
requires additional information in the Identity service.
|
||||
|
||||
#. To create the database, complete these steps:
|
||||
|
||||
* Use the database access client to connect to the database
|
||||
server as the ``root`` user:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ mysql -u root -p
|
||||
|
||||
* Create the ``karbor`` database:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
CREATE DATABASE karbor;
|
||||
|
||||
* Grant proper access to the ``karbor`` database:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
GRANT ALL PRIVILEGES ON karbor.* TO 'karbor'@'localhost' IDENTIFIED BY 'KARBOR_DBPASS';
|
||||
GRANT ALL PRIVILEGES ON karbor.* TO 'karbor'@'%' IDENTIFIED BY 'KARBOR_DBPASS';
|
||||
|
||||
Replace ``KARBOR_DBPASS`` with a suitable password.
|
||||
|
||||
* Exit the database access client.
|
||||
|
||||
#. Source the ``admin`` credentials to gain access to
|
||||
admin-only CLI commands:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ . admin-openrc
|
||||
|
||||
#. To create the service credentials, complete these steps:
|
||||
|
||||
* Create the ``karbor`` user:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ openstack user create --domain default --password-prompt karbor
|
||||
User Password:
|
||||
Repeat User Password:
|
||||
+-----------+----------------------------------+
|
||||
| Field | Value |
|
||||
+-----------+----------------------------------+
|
||||
| domain_id | e0353a670a9e496da891347c589539e9 |
|
||||
| enabled | True |
|
||||
| id | ca2e175b851943349be29a328cc5e360 |
|
||||
| name | karbor |
|
||||
+-----------+----------------------------------+
|
||||
|
||||
* Add the ``admin`` role to the ``karbor`` user:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ openstack role add --project service --user karbor admin
|
||||
|
||||
.. note::
|
||||
|
||||
This command provides no output.
|
||||
|
||||
* Create the ``karbor`` service entities:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ openstack service create --name karbor --description "Application Data Protection Service" data-protect
|
||||
+-------------+-------------------------------------+
|
||||
| Field | Value |
|
||||
+-------------+-------------------------------------+
|
||||
| description | Application Data Protection Service |
|
||||
| enabled | True |
|
||||
| id | 727841c6f5df4773baa4e8a5ae7d72eb |
|
||||
| name | karbor |
|
||||
| type | data-protect |
|
||||
+-------------+-------------------------------------+
|
||||
|
||||
#. Create the Data Protection service API endpoints:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ openstack endpoint create --region RegionOne data-protect public http://controller:8799/v1/%\(project_id\)s
|
||||
+--------------+------------------------------------------+
|
||||
| Field | Value |
|
||||
+--------------+------------------------------------------+
|
||||
| enabled | True |
|
||||
| id | 3f4dab34624e4be7b000265f25049609 |
|
||||
| interface | public |
|
||||
| region | RegionOne |
|
||||
| region_id | RegionOne |
|
||||
| service_id | 727841c6f5df4773baa4e8a5ae7d72eb |
|
||||
| service_name | karbor |
|
||||
| service_type | data-protect |
|
||||
| url | http://controller:8799/v1/%(project_id)s |
|
||||
+--------------+------------------------------------------+
|
||||
|
||||
$ openstack endpoint create --region RegionOne data-protect internal http://controller:8799/v1/%\(project_id\)s
|
||||
+--------------+------------------------------------------+
|
||||
| Field | Value |
|
||||
+--------------+------------------------------------------+
|
||||
| enabled | True |
|
||||
| id | 3f4dab34624e4be7b000265f25049609 |
|
||||
| interface | internal |
|
||||
| region | RegionOne |
|
||||
| region_id | RegionOne |
|
||||
| service_id | 727841c6f5df4773baa4e8a5ae7d72eb |
|
||||
| service_name | karbor |
|
||||
| service_type | data-protect |
|
||||
| url | http://controller:8799/v1/%(project_id)s |
|
||||
+--------------+------------------------------------------+
|
||||
|
||||
$ openstack endpoint create --region RegionOne data-protect admin http://controller:8799/v1/%\(project_id\)s
|
||||
+--------------+------------------------------------------+
|
||||
| Field | Value |
|
||||
+--------------+------------------------------------------+
|
||||
| enabled | True |
|
||||
| id | 3f4dab34624e4be7b000265f25049609 |
|
||||
| interface | admin |
|
||||
| region | RegionOne |
|
||||
| region_id | RegionOne |
|
||||
| service_id | 727841c6f5df4773baa4e8a5ae7d72eb |
|
||||
| service_name | karbor |
|
||||
| service_type | data-protect |
|
||||
| url | http://controller:8799/v1/%(project_id)s |
|
||||
+--------------+------------------------------------------+
|
||||
|
||||
Install and configure components
|
||||
--------------------------------
|
||||
|
||||
.. note::
|
||||
|
||||
Default configuration files vary by distribution. You might need
|
||||
to add these sections and options rather than modifying existing
|
||||
sections and options. Also, an ellipsis (``...``) in the configuration
|
||||
snippets indicates potential default configuration options that you
|
||||
should retain.
|
||||
|
||||
#. Install the packages:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# apt-get install karbor
|
||||
|
||||
2. Edit the ``/etc/karbor/karbor.conf`` file and complete the following
|
||||
actions:
|
||||
|
||||
* In the ``[database]`` section, configure database access:
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
[database]
|
||||
...
|
||||
connection = mysql+pymysql://karbor:KARBOR_DBPASS@controller/karbor
|
||||
|
||||
Replace ``KARBOR_DBPASS`` with the password you chose for the
|
||||
Data Protection database.
|
||||
|
||||
* In the ``[DEFAULT]`` section,
|
||||
configure ``RabbitMQ`` message queue access:
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
[DEFAULT]
|
||||
...
|
||||
transport_url = rabbit://openstack:RABBIT_PASS@controller
|
||||
|
||||
Replace ``RABBIT_PASS`` with the password you chose for the
|
||||
``openstack`` account in ``RabbitMQ``.
|
||||
|
||||
* In the ``[keystone_authtoken]``, ``[trustee]``,
|
||||
``[clients_keystone]``, and ``[karbor_client]`` sections,
|
||||
configure Identity service access:
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
[keystone_authtoken]
|
||||
...
|
||||
auth_uri = http://controller/identity
|
||||
auth_url = http://controller/identity_admin
|
||||
memcached_servers = controller:11211
|
||||
auth_type = password
|
||||
project_domain_name = default
|
||||
user_domain_name = default
|
||||
project_name = service
|
||||
username = karbor
|
||||
password = KARBOR_PASS
|
||||
|
||||
[trustee]
|
||||
...
|
||||
auth_type = password
|
||||
auth_url = http://controller/identity_admin
|
||||
username = karbor
|
||||
password = KARBOR_PASS
|
||||
user_domain_name = default
|
||||
|
||||
[clients_keystone]
|
||||
...
|
||||
auth_uri = http://controller/identity_admin
|
||||
|
||||
[karbor_client]
|
||||
...
|
||||
version = 1
|
||||
service_type = data-protect
|
||||
service_name = karbor
|
||||
|
||||
Replace ``KARBOR_PASS`` with the password you chose for the
|
||||
``karbor`` user in the Identity service.
|
||||
|
||||
3. Populate the Data Protection database:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# su -s /bin/sh -c "karbor-manage db sync" karbor
|
||||
|
||||
.. note::
|
||||
|
||||
Ignore any deprecation messages in this output.
|
||||
|
||||
Finalize installation
|
||||
---------------------
|
||||
|
||||
1. Restart the Data Protection services:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# service karbor-api restart
|
||||
# service karbor-operationengine restart
|
||||
# service karbor-protection restart
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
.. _install:
|
||||
|
||||
Install and configure
|
||||
~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
This section describes how to install and configure Karbor, Application Data
|
||||
Protection service, on the controller node.
|
||||
|
||||
This section assumes that you already have a working OpenStack
|
||||
environment with at least the following components installed. These components are optional:
|
||||
`Identity service (keystone) <https://docs.openstack.org/ocata/install-guide-ubuntu/keystone.html>`_.
|
||||
and the following components may be installed:
|
||||
`Compute service (nova) <https://docs.openstack.org/ocata/install-guide-ubuntu/nova.html>`_,
|
||||
`Block Storage service (cinder) <https://docs.openstack.org/ocata/install-guide-ubuntu/cinder.html>`_,
|
||||
`Image service (glance) <https://docs.openstack.org/ocata/install-guide-ubuntu/glance.html>`_.
|
||||
and Default provider need the following components to be installed:
|
||||
`Object Storage service (swift) <https://docs.openstack.org/project-install-guide/object-storage/ocata/>`_.
|
||||
|
||||
Note that installation and configuration vary by distribution.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
install-ubuntu.rst
|
||||
|
|
@ -0,0 +1,188 @@
|
|||
.. _launch-instance:
|
||||
|
||||
Launch an instance
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
In environments that include the Data Protection service, you can create a
|
||||
checkpoint and restore this checkpoint.
|
||||
|
||||
Create a checkpoint
|
||||
-------------------
|
||||
|
||||
Create a checkpoint for some resource. For example, for volume:
|
||||
|
||||
#. Source the ``demo`` credentials to perform
|
||||
the following steps as a non-administrative project:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ . demo-openrc
|
||||
|
||||
#. list provider.
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ karbor provider-list
|
||||
+--------------------------------------+-------------------+-------------------------------------------------------------------------------------+
|
||||
| Id | Name | Description |
|
||||
+--------------------------------------+-------------------+-------------------------------------------------------------------------------------+
|
||||
| b766f37c-d011-4026-8228-28730d734a3f | No-Op Provider | This provider does nothing for each protect and restore operation. Used for testing |
|
||||
| cf56bd3e-97a7-4078-b6d5-f36246333fd9 | OS Infra Provider | This provider uses OpenStack's own services (swift, cinder) as storage |
|
||||
| e4008868-be97-492c-be41-44e50ef2e16f | EISOO Provider | This provider provides data protection for applications with EISOO AnyBackup |
|
||||
+--------------------------------------+-------------------+-------------------------------------------------------------------------------------+
|
||||
|
||||
#. list protectable.
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ karbor protectable-list
|
||||
+-----------------------+
|
||||
| Protectable type |
|
||||
+-----------------------+
|
||||
| OS::Cinder::Volume |
|
||||
| OS::Glance::Image |
|
||||
| OS::Keystone::Project |
|
||||
| OS::Nova::Server |
|
||||
+-----------------------+
|
||||
|
||||
#. list volume resources, and get volume ID.
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ openstack volume list
|
||||
+--------------------------------------+--------------+-----------+------+-------------+
|
||||
| ID | Display Name | Status | Size | Attached to |
|
||||
+--------------------------------------+--------------+-----------+------+-------------+
|
||||
| 286a43e9-3899-4983-965f-d8b1faef5e58 | Volume1 | available | 1 | |
|
||||
+--------------------------------------+--------------+-----------+------+-------------+
|
||||
|
||||
#. Create a plan for this volume:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ karbor plan-create Plan1 cf56bd3e-97a7-4078-b6d5-f36246333fd9 '286a43e9-3899-4983-965f-d8b1faef5e58'='OS::Cinder::Volume'='Volume1'
|
||||
+-------------+----------------------------------------------------+
|
||||
| Property | Value |
|
||||
+-------------+----------------------------------------------------+
|
||||
| description | None |
|
||||
| id | 81ac01b7-0a69-4b0b-8ef5-bd46a900c90a |
|
||||
| name | Plan1 |
|
||||
| parameters | {} |
|
||||
| provider_id | cf56bd3e-97a7-4078-b6d5-f36246333fd9 |
|
||||
| resources | [ |
|
||||
| | { |
|
||||
| | "id": "286a43e9-3899-4983-965f-d8b1faef5e58", |
|
||||
| | "name": "Volume1", |
|
||||
| | "type": "OS::Cinder::Volume" |
|
||||
| | } |
|
||||
| | ] |
|
||||
| status | suspended |
|
||||
+-------------+----------------------------------------------------+
|
||||
|
||||
#. Create checkpoint by plan:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ karbor checkpoint-create cf56bd3e-97a7-4078-b6d5-f36246333fd9 81ac01b7-0a69-4b0b-8ef5-bd46a900c90a
|
||||
+-----------------+------------------------------------------------------+
|
||||
| Property | Value |
|
||||
+-----------------+------------------------------------------------------+
|
||||
| created_at | None |
|
||||
| extra_info | None |
|
||||
| id | c1112037-b19c-421a-83c9-dd209e785189 |
|
||||
| project_id | 690ccee85834425e973258252e0da888 |
|
||||
| protection_plan | { |
|
||||
| | "id": "81ac01b7-0a69-4b0b-8ef5-bd46a900c90a", |
|
||||
| | "name": "Plan1", |
|
||||
| | "resources": [ |
|
||||
| | { |
|
||||
| | "id": "286a43e9-3899-4983-965f-d8b1faef5e58", |
|
||||
| | "name": "Volume1", |
|
||||
| | "type": "OS::Cinder::Volume" |
|
||||
| | } |
|
||||
| | ] |
|
||||
| | } |
|
||||
| resource_graph | None |
|
||||
| status | protecting |
|
||||
+-----------------+------------------------------------------------------+
|
||||
|
||||
#. After a short time, verify successful creation of the checkpoint:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ karbor checkpoint-show cf56bd3e-97a7-4078-b6d5-f36246333fd9 c1112037-b19c-421a-83c9-dd209e785189
|
||||
+-----------------+-----------------------------------------------------------+
|
||||
| Property | Value |
|
||||
+-----------------+-----------------------------------------------------------+
|
||||
| created_at | 2017-03-27 |
|
||||
| extra_info | None |
|
||||
| id | c1112037-b19c-421a-83c9-dd209e785189 |
|
||||
| project_id | 690ccee85834425e973258252e0da888 |
|
||||
| protection_plan | { |
|
||||
| | "id": "81ac01b7-0a69-4b0b-8ef5-bd46a900c90a", |
|
||||
| | "name": "Plan1", |
|
||||
| | "provider_id": "cf56bd3e-97a7-4078-b6d5-f36246333fd9", |
|
||||
| | "resources": [ |
|
||||
| | { |
|
||||
| | "id": "286a43e9-3899-4983-965f-d8b1faef5e58", |
|
||||
| | "name": "Volume1", |
|
||||
| | "type": "OS::Cinder::Volume" |
|
||||
| | } |
|
||||
| | ] |
|
||||
| | } |
|
||||
| resource_graph | [ |
|
||||
| | { |
|
||||
| | "0x0": [ |
|
||||
| | "OS::Cinder::Volume", |
|
||||
| | "286a43e9-3899-4983-965f-d8b1faef5e58", |
|
||||
| | "Volume1" |
|
||||
| | ] |
|
||||
| | }, |
|
||||
| | [] |
|
||||
| | ] |
|
||||
| status | available |
|
||||
+-----------------+-----------------------------------------------------------+
|
||||
|
||||
#. Create restore by checkpoint:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ karbor restore-create cf56bd3e-97a7-4078-b6d5-f36246333fd9 c1112037-b19c-421a-83c9-dd209e785189
|
||||
+------------------+--------------------------------------+
|
||||
| Property | Value |
|
||||
+------------------+--------------------------------------+
|
||||
| checkpoint_id | c1112037-b19c-421a-83c9-dd209e785189 |
|
||||
| id | 2c9dea83-3e12-4fa1-80af-16f02b5738ef |
|
||||
| parameters | {} |
|
||||
| project_id | 690ccee85834425e973258252e0da888 |
|
||||
| provider_id | cf56bd3e-97a7-4078-b6d5-f36246333fd9 |
|
||||
| resources_reason | {} |
|
||||
| resources_status | {} |
|
||||
| restore_target | None |
|
||||
| status | in_progress |
|
||||
+------------------+--------------------------------------+
|
||||
|
||||
#. After a short time, verify successful restore for the checkpoint:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ karbor restore-show 2c9dea83-3e12-4fa1-80af-16f02b5738ef
|
||||
+------------------+----------------------------------------------------------------------------+
|
||||
| Property | Value |
|
||||
+------------------+----------------------------------------------------------------------------+
|
||||
| checkpoint_id | c1112037-b19c-421a-83c9-dd209e785189 |
|
||||
| id | 2c9dea83-3e12-4fa1-80af-16f02b5738ef |
|
||||
| parameters | {} |
|
||||
| project_id | 690ccee85834425e973258252e0da888 |
|
||||
| provider_id | cf56bd3e-97a7-4078-b6d5-f36246333fd9 |
|
||||
| resources_reason | {} |
|
||||
| resources_status | {u'OS::Cinder::Volume#b0b2d98d-ec8a-498e-ad50-00a2240c76a2': u'available'} |
|
||||
| restore_target | None |
|
||||
| status | success |
|
||||
+------------------+----------------------------------------------------------------------------+
|
||||
|
||||
#. Delete the checkpoint.
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ karbor checkpoint-delete cf56bd3e-97a7-4078-b6d5-f36246333fd9 c1112037-b19c-421a-83c9-dd209e785189
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
.. _next-steps:
|
||||
|
||||
Next steps
|
||||
~~~~~~~~~~
|
||||
|
||||
Your OpenStack environment now includes the Karbor service.
|
||||
|
||||
To add more services, see the
|
||||
`additional documentation on installing OpenStack <http://docs.openstack.org/#install-guides>`_ .
|
||||
|
||||
To learn more about the Karbor service, read the `Karbor developer documentation
|
||||
<http://docs.openstack.org/developer/karbor/index.html>`__.
|
||||
|
|
@ -0,0 +1,35 @@
|
|||
.. _verify:
|
||||
|
||||
Verify operation
|
||||
~~~~~~~~~~~~~~~~
|
||||
|
||||
Verify operation of the Data Protection service.
|
||||
|
||||
.. note::
|
||||
|
||||
Perform these commands on the controller node.
|
||||
|
||||
#. Source the ``admin`` tenant credentials:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ . admin-openrc
|
||||
|
||||
#. List and show service components to verify successful launch and
|
||||
registration of each process:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ openstack service list |grep data-protect
|
||||
| dedab9a746e34d3990ca44bc2e885b49 | karbor | data-protect |
|
||||
|
||||
$ openstack service show dedab9a746e34d3990ca44bc2e885b49
|
||||
+-------------+-------------------------------------+
|
||||
| Field | Value |
|
||||
+-------------+-------------------------------------+
|
||||
| description | Application Data Protection Service |
|
||||
| enabled | True |
|
||||
| id | dedab9a746e34d3990ca44bc2e885b49 |
|
||||
| name | karbor |
|
||||
| type | data-protect |
|
||||
+-------------+-------------------------------------+
|
||||
2
tox.ini
2
tox.ini
|
|
@ -50,6 +50,8 @@ commands =
|
|||
[testenv:releasenotes]
|
||||
commands = sphinx-build -a -E -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
|
||||
|
||||
[testenv:install-guide]
|
||||
commands = sphinx-build -a -E -W -d install-guide/build/doctrees -b html install-guide/source install-guide/build/html
|
||||
|
||||
[flake8]
|
||||
show-source = True
|
||||
|
|
|
|||
Loading…
Reference in New Issue