Commit Graph

104 Commits

Author SHA1 Message Date
gecong 57211d5f11 Fix freezer doc error
Change-Id: I3da0508b01c65b896bba7b6364e8381bbb931899
2023-02-14 02:36:21 +00:00
gecong 0d47828fa9 Fix freezer doc error
Change-Id: Ib2484797cf0e8cfb6c6f5084ec6a226818f82c4d
2022-08-30 07:55:08 +00:00
caihui c4bdfb6693 Correct spelling errors
Update "--restore-abs-pat" to "--restore-abs-path"

Change-Id: Ic27d20b03e3a312e2a332f3893377bb39b3d623b
2020-11-17 23:18:55 -08:00
caihui 4ed938b1f1 Fix Freeze Doc
1. Add  a brief introduction of Freezer
2. Correct "DB Elasticsearch " to "DB"
3. Other small errors.

Change-Id: I0bc6e328dedbd6aa8b3fb5ed4d423ff3a34789e8
2020-11-12 00:52:58 -08:00
caihui 1b0fa4fa32 Update Freezer introduce doc
Update Freezer doc for new version.

Change-Id: I55b6d1109173a222cd04d37889a56b7dd946cb69
2020-11-11 23:00:12 -08:00
caihui c7b27743c5 Update Freezer doc
THe falcon version is already updated to new . The issuse of falcon < 0.1.8 is not exist any more.
Update the doc.

Change-Id: I48b10ae5505f59685f852d0e3d3a913d5a105409
2020-11-10 00:02:37 -08:00
zhoulinhui 2f00991548 Fix a typo: update Freeer to Freezer
Change-Id: I382adfde933137d1bb90a5b374bb5b9e9f611995
2020-10-02 22:21:33 +08:00
wu.chunyang bb05719a17 [doc] remove six from requirement
six library has removed, so clean it from doc.

Change-Id: I608589c395bd3d7d668fc3ae1b6f21ab90357f2c
2020-08-03 14:38:27 +08:00
Caihui e455e6b5f5 Overriding configured project name with name extraceted from package(freezer)
[openstackdocstheme] overriding configured project name (Python) with
name extracted from the package (freezer); you can disable this behavior
with the 'openstackdocs_auto_name' option

Change-Id: Ic6b6dbe567a1dec92c5c4c9490b0672cc96d1d1f
2020-07-05 20:56:25 -07:00
Andreas Jaeger f7cd7dbe35 Switch to newer openstackdocstheme and reno versions
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.

Remove docs requirements from lower-constraints, they are not needed
during install or test but only for docs building.

openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: I502e67164a3639e2df51edbd239f2b2bab474924
2020-05-30 16:47:27 +02:00
jacky06 815b66364b tox: Keeping going with docs
Sphinx 1.8 introduced [1] the '--keep-going' argument which, as its name
suggests, keeps the build running when it encounters non-fatal errors.
This is exceptionally useful in avoiding a continuous edit-build loop
when undertaking large doc reworks where multiple errors may be
introduced.

[1] https://github.com/sphinx-doc/sphinx/commit/e3483e9b045

Change-Id: I18032bd40489c4b1c511713b0f1c5bb1aca7c1d2
2020-03-30 12:03:27 +08:00
Michal Arbet f968a82c74 Fix documentation, replace src_file to path_to_backup
This patch is fixing documentation as freezer_action's 'src_file'
option is not used in a code, instead of this option 'path_to_backup'
is used.

Change-Id: I908a310c4252db49ac74f2396e2e27184fe0f3f1
2020-01-30 14:36:01 +01:00
Ghanshyam Mann f04df2caa5 [ussuri][goal] Drop python 2.7 support and testing
OpenStack is dropping the py2.7 support in ussuri cycle.

freezer is ready with python 3 and ok to drop the
python 2.7 support.

Complete discussion & schedule can be found in
- http://lists.openstack.org/pipermail/openstack-discuss/2019-October/010142.html
- https://etherpad.openstack.org/p/drop-python2-support

Ussuri Communtiy-wide goal:
https://governance.openstack.org/tc/goals/selected/ussuri/drop-py27.html

Change-Id: I14ab74f3e82e83ef5c5a49831f68335965e7e101
2019-11-22 01:52:55 +00:00
Zuul c4d8cf5bb3 Merge "Blacklist sphinx 2.1.0 (autodoc bug)" 2019-10-14 01:25:20 +00:00
pengyuesheng 65a985e8c3 Bump the openstackdocstheme extension to 1.20
Some options are now automatically configured by the version 1.20:
- project
- html_last_updated_fmt
- latex_engine
- latex_elements
- version
- release.

Change-Id: I5084068694f867b725e684ceb4e3933974aaa9fa
2019-08-02 14:51:37 +08:00
pengyuesheng fc2a5c9450 Blacklist sphinx 2.1.0 (autodoc bug)
See https://github.com/sphinx-doc/sphinx/issues/6440 for upstream details

Change-Id: I1b6b097e22b3077ccc35ba29457bbcff4f5fbc4c
2019-08-02 14:49:14 +08:00
Andreas Jaeger 67abf372aa Update api-ref location
The api documentation is now published on docs.openstack.org instead
of developer.openstack.org. Update all links that are changed to the
new location.

Note that redirects will be set up as well but let's point now to the
new location.

For details, see:
http://lists.openstack.org/pipermail/openstack-discuss/2019-July/007828.html

Change-Id: Icb170841bacdc5b069c2ff1894615af19d5ab358
2019-07-22 18:22:21 +02:00
chenke fe4ab522a3 Update Sphinx requirement
Sphinx 2.0 no longer works on python 2.7, so we need to start capping
it there as well.

The errors[1] are as follow:

Requirement(package='sphinx', location='', specifiers='!=1.6.6,!=1.6.7,>=1.6.5'
does not match "python_version>='3.4'"
Requirement(package='sphinx', location='', specifiers='!=1.6.6,!=1.6.7,>=1.6.5'
does not match "python_version=='2.7'"
Could not find a global requirements entry to match package sphinx. If the package
is already included in the global list, the name or platform markers there may not
match the local settings.

Reference:
[1]. http://logs.openstack.org/56/665856/4/check/requirements-check/e565cc2/job-output.txt.gz
[2]. https://review.opendev.org/#/c/658965/

Change-Id: Ida52a0921e4ca281954b2ac80bd0bf7f82ec17bd
2019-06-18 16:24:58 +08:00
gecong1973 44c3081610 Add user doc for glance image backup and restore
The patch add user doc for glance image backup and restore
for freezer

Change-Id: I06535ca0ad52d08ad259ebac0de13867bb7ff01e
2019-06-14 02:10:15 -07:00
zhangdebo 285b59a048 Update link address of installation guide
Change-Id: I937eb4c3f2ec746a31987b01071088de047f4b40
2018-11-28 19:07:54 +08:00
gengchc2 42dd05768d Add describe about ssh(sftp) in freezer-agent user guides
The describe is added about ssh(sftp) in freezer-agent user guides.
O

Change-Id: I5839fedce2152263d6943f51fdcb782a0e899fff
2018-11-22 03:28:14 +00:00
Zuul 04014fdabc Merge "Add describes about sql database in freezer in images" 2018-11-21 10:44:41 +00:00
gengchc2 4423a800a3 Add describes about sql database in freezer in images
Change-Id: I584814cac0160e71a2bcb6d6147e63016512858b
2018-11-21 00:47:45 -08:00
gecong1973 750c4e7d12 Add ftp support document modification
The patch add ftp document modification

Change-Id: Ia99af6051f40b1d2f77c6504676ba5e6a6e04350
2018-11-20 23:48:01 -08:00
Zuul 4ec633bd30 Merge "Freezer Backup for nova and cinder should accept instances names" 2018-11-14 10:29:49 +00:00
Zuul 0b083d266d Merge "Update .gitignore" 2018-11-13 04:17:07 +00:00
Cai Hui f83cdaa8fa Update .gitignore
Add doc/source/_static/*.sample in .gitignore
The files in doc/source/_static/*.sample is auto generated.

Closes-Bug: #1803006

Change-Id: I85ba194caffbbeae0f557275347460d4327c7e35
2018-11-12 19:01:11 -05:00
Vishakha Agarwal 5226536301 Freezer Backup for nova and cinder should accept instances names
Added parameters ‘nova_inst_name’ and ‘cinder_vol_name’
to take freezer backups for nova and cinder.

Change-Id: Iafe7e50b66fc727b2099b45e4b26f083768ef858
Closes-Bug: #1603099
2018-11-12 11:59:16 +00:00
Cai Hui eb5a0fe31d Update API routes in Developer Guide
Add  API v2 routes in doc.

Change-Id: I9586b524bf4c8f13a6bab071ef22d00b17ee321f
2018-11-12 10:12:07 +00:00
Zuul 370009349f Merge "Update freezer_api config doc" 2018-11-10 03:28:56 +00:00
Pierre Blanc 4d9f20c07e Fix duplicate option in documentation
Just remove one occurence of a duplicate option.

Change-Id: I5cc95fd519159da4e52d5f6373da06430add26ec
2018-11-09 15:38:05 -05:00
Mike Chen 94c65577e6 Update freezer_api config doc
Update freezer_api configurations in the installation documentation

Change-Id: Ic205728bc9b3505f60c1acd72dbc147510430cd6
2018-11-06 02:57:43 +00:00
gengchc2 29865ce51f Modify freezer-api v1 and v2 and scheduler configuration
Change-Id: I8a579bdc4f95eb28366b8ec2ed244a49f7d5195b
2018-11-05 03:35:51 +00:00
Trinh Nguyen 1467df83a6 Clean up docs and specs directories
This patch proposes to clean up unused or redundant docs
as well as moving config-generator to the etc dir

Change-Id: I37d4c4ad1d46ee273575021ca90d5b31121ce9e8
2018-09-05 15:18:30 +09:00
Nguyen Hai 29a4e902aa Fix openstack-tox-docs failure
Change-Id: I01035d5cb04b5908571d1d5e177176e9d8f24091
2018-09-04 21:04:06 +09:00
Zuul d18f80a3cd Merge "Drop all qpid related explanations" 2018-08-30 13:00:49 +00:00
melissaml f1380cb4c5 Drop all qpid related explanations
Qpid was removed in Mitaka from Oslo Messaging, so we
can remove all qpid related explanations.

Change-Id: I161df87e0d36e89a32a7a8bd44417cc30e1f60b7
2018-08-30 10:55:34 +00:00
tanmingxiao 61a28e1475 fix some mistake in freezer user guide document(nova backup)
I test the freezer with freezer-agent.rst and I find some mistake in
cinder and nova  backups
 - nova backup need --mode option. otherwise it will into the
   default mode fs
 - nova backup need more necessary parameters,It is the --engine nova
   and --no-incremental True and --backup-name [BACKUP_NAME]

Closes-Bug:1619158

Change-Id: Id0326f35f8d15eb78c4aa272dba4cf8bf5c539ff
2018-08-30 10:46:18 +00:00
Dao Cong Tien 401256a6e5 Adds doc8 check to pep8
This patch adds doc8 check for .rst files to pep8.
Files that fail doc8 check are also fixed.

Ignores D000, D001 of doc8 check. This requires lot of changes
and should be done in a separated patch.

Change-Id: I7d021e6fee3e12feff7c219e09c545da5274c354
2018-07-12 20:13:25 +07:00
Matthew Thode 7c16877195
switch to cryptography
Fernet could not be used as it is not a streaming cipher.
CFB mode does not require padding, so removed padding code.

Depends-On: https://review.openstack.org/c/575199/
Change-Id: I14f58d9d473c20ce7863baa0b2adadbfda268b7a
2018-06-19 10:54:05 -05:00
wu.chunyang 39f57bd350 update keysone url
this patch [0] has updated the "auth_port"in install documents
i think the README.rst also need to update.more information about
keysont see [1]
[0] https://review.openstack.org/#/c/567514/
[1] https://docs.openstack.org/keystone/latest/contributor/http-api.html

Change-Id: Ia2e70770a6edf5add03c0ebefc694e4969041552
2018-05-13 18:45:54 +08:00
Zuul 4e0c8475ea Merge "Update "auth_port" in install docs" 2018-05-11 23:18:23 +00:00
Zuul 791e40183d Merge "Fix typos in docs" 2018-05-11 23:18:22 +00:00
Zuul 948be5c102 Merge "Fix indentation in docs" 2018-05-11 23:18:22 +00:00
Vu Cong Tuan 4c89c0ad00 Update "auth_port" in install docs
Based on the change in Keystone Install Guide [1],
this patch replace port 35357 with 5000 for "auth_port" in docs.

For more details, please check similar changes which have been done
on other projects: Nova [2], Neutron [3], Cinder [4], Glance [5].

[1] https://review.openstack.org/#/c/541857
[2] https://review.openstack.org/#/c/562812
[3] https://review.openstack.org/#/c/566491
[4] https://review.openstack.org/#/c/565464
[5] https://review.openstack.org/#/c/558932

Change-Id: I3c0dabf08ce95a33ecf31249f3ac2526ce5e79a3
2018-05-10 15:33:43 +07:00
David Rabel be3872fad5 Fix indentation in docs
Fix indentation in cli docs. Old indentation was wrongly interpreted as
quotation.

Change-Id: I3dc5faf3fd97e994ee98c965088f133bbc17d6c3
2018-05-03 13:11:32 +00:00
David Rabel 54a00153c3 Fix typos in docs
Change-Id: Ib3e9b09c7e3acbdabf83edda08a4b2767c669108
2018-05-03 15:07:37 +02:00
zhang.lei cb8f9b1807 Revise the code-block format of documentation
Change-Id: If28db07bdd1bab3dc856a4a7675461a319618f32
2018-04-28 01:51:04 +00:00
Oleksiy Petrenko 1ebd6d12ef Add note about installing dependencies
Change-Id: I636286bd3e94d1b908335a162eb3c6f86e5a6210
Closes-Bug: #1750776
2018-04-25 18:35:20 +03:00
Zuul c00be6cb7c Merge "Fix doc common_configure '..' format error" 2018-04-16 10:21:48 +00:00