265 Commits

Author SHA1 Message Date
Zuul
edab434bb2 Merge "[doc] Add documentation for Vault plugin" 2020-10-29 16:37:11 +00:00
Douglas Mendizábal
69459a0ecf Use serial number or label for PKCS#11 tokens
The PKCS#11 standard does not make any guarantees about
slot numbering, so the slot ID alone should not be used
to identify a token.  Instead, the token's Serial Number
or Label should be used to ensure the correct token
is being used.

This patch adds two new config options to the p11_crypto
plugin: token_serial_number and token_label.

These new options allow for more flexibility in configuring
the PKCS#11 module.  The config may include either the token's
serial number or its label.

Serial numbers should be unique, so they take higher precedence.

Some devices allow tokens to have the same label, so this patch
ensures that only one token with the specified label is present.

If both serial number and label are given, only the serial number
will be checked and an error will be raised if it is not found.

slot_id continues to work as expected, although its use is discouraged
and may be deprecated in a future patch.  If the conf contains
only the slot_id, it will be used.  If the serial number or
label are also provided, the new logic will ignore the slot_id
and search for the serial number or label instead.

Change-Id: I115cf1a7006a6c85f37c5e50ded13134a3dfd1a3
2020-10-19 16:21:15 -05:00
Dmitriy Rabotyagov
4d017c4cc2 [doc] Add documentation for Vault plugin
Vault plugin has been added for a while, however it is still undocumented

Change-Id: I354a406799344a1577ba1a2d6a88df2a129bef1b
2020-10-09 16:01:25 +03:00
Ricardo Rocha
6642a60830 Set db_auto_create default to False
Change the default value for the db_auto_create option to False. This is
vital as the flag is managing upgrades as well if the databases already
exist.

It will prevent production deployments from having their databases
impacted if an API daemon is started for any reason pointing to
a production database.

Change-Id: Id7eac78737af76afe628deeca7c15c2ac969d47e
2020-09-25 14:34:07 +00:00
liushuobj
0edaaf2756 Fix kmip&dogtag level problem in the document hierarchy
Change-Id: I5a161abbfd4ac3b6cbc6304a4674e6abde0605b5
2020-08-18 08:56:01 -05:00
Moisés Guimarães de Medeiros
71bad5df06 Ussuri contrib docs community goal
This patch standardizes the CONTRIBUTING.rst file and adds the
required doc/source/contributor/contributing.rst

Task: 38514
Change-Id: I8a5d202f903e89e19106ccdda11fc30522892e7f
2020-06-24 10:26:22 +02:00
Moisés Guimarães de Medeiros
df194df816 Fix PDF build
Do not include config sample since PDF building fails with the
large file. This fix PDF building of openstack-tox-docs job.

Change-Id: I69fd56ca1cdbae4c5442fb79fd3c1f5f79290044
Signed-off-by: Moisés Guimarães de Medeiros <moguimar@redhat.com>
2020-06-23 16:37:17 +02:00
Zuul
87ba19b78b Merge "Fixes index.rst titles and add mascot" 2020-06-09 14:18:51 +00:00
Zuul
632e181e85 Merge "docs: Minor tweaks to DevStack guide" 2020-06-09 01:29:40 +00:00
Moisés Guimarães de Medeiros
5df6c0cf84 Fixes index.rst titles and add mascot
Change based on other services docs like Nova and Cinder.

Change-Id: If96ad0bedf469934c8e4c7fcbe8c880514ae9489
2020-06-08 16:14:18 -03:00
Stephen Finucane
146b6e6b9e docs: Minor tweaks to DevStack guide
Fix indentation so code blocks don't appear as quotes, properly title
case case project names and format literals as such.

Change-Id: I3db0e83e30469d7217126f18dce813bf00abc0ae
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2020-05-27 15:43:29 +01:00
Andreas Jaeger
138375ea23 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.

Set openstackdocs_pdf_link to link to PDF file. Note that
the link to the published document only works on docs.openstack.org
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.

Disable openstackdocs_auto_name to use 'project' variable as name.

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.

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: Ibf877ecf4ee043017d0ca219595cee859b7092dc
2020-05-21 14:38:36 +02:00
Andreas Jaeger
02b82e5a4c Cleanup py27 support
This repo is now testing only with Python 3, so let's make
a few cleanups:
- Remove python 2.7 stanza from setup.py
- Add requires on python >= 3.6 to setup.cfg so that pypi and pip
  know about the requirement
- Remove obsolete sections from setup.cfg
- Update classifiers
- Use newer openstackdocstheme and Sphinx versions
- Cleanup */source/conf.py to remove now obsolete content.
- Remove Babel from requirements, it's not needed for running.
- Sync docs deps in tox.ini

Change-Id: Ie1fccdc777be978075e4689eda6c62578bd463e4
2020-04-29 19:10:48 +02:00
Douglas Mendizábal
b8266ef402 Use Zuulv3 devstack jobs
This patch updates the gate jobs to stop using legacy
jobs and use the new Zuul v3 jobs instead.

The tempest tests will be re-enabled in a future patch.

Depends-On: I5d2bda5e653ee5d7c17cb7697247802916bdc5f7
Change-Id: Id91f44e8053cf4f40224959021d43736d5525107
2020-04-27 16:41:20 -05:00
Ade Lee
ccb4265de5 Set correct names for Thales and NetHSM
Change-Id: I0f5dd8e9439449c19fca259e5c9f2725766b2795
2020-01-15 12:11:25 -05:00
Ghanshyam Mann
ab6898aa7f [ussuri][goal] Drop python 2.7 support and testing
OpenStack is dropping the py2.7 support in ussuri cycle.

Barbican 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

Depends-On: https://review.opendev.org/#/c/693631/
Change-Id: I77bf25fedb45433c7dbe655b4fd0c24dcf030549
2020-01-10 17:22:04 +00:00
Zuul
f00509e4f4 Merge "docs: Fix typo: barican" 2020-01-10 16:26:54 +00:00
Zuul
d9a7597113 Merge "Update dev environment instructions for F30" 2019-10-25 19:20:55 +00:00
Tim Burke
b49b6c877e docs: Fix typo: barican
Change-Id: Ia1449a778a8c5f3fc573c91b641adb20b7ad6039
2019-10-11 12:27:59 -07:00
Alexandra Settle
3db28fb81a PDF Documentation Build tox target
This patch adds a `pdf-docs` tox target that will build
PDF versions of our docs. As per the Train community goal:

  https://governance.openstack.org/tc/goals/selected/train/pdf-doc-generation.html

Add sphinxcontrib-svg2pdfconverter to doc/requirements.txt
to convert our SVGs.

Also, due to the opposing graphic format, the .gif file
had to be converted (not renamed) to .png so the LaTeX
builder would accept and read the images.

Change-Id: I6384e56222991d39f4fd1bc99e82be6c89fb16a3
Story: 2006072
2019-09-25 08:59:22 +00:00
Douglas Mendizábal
34d55597ae Update dev environment instructions for F30
Change-Id: I6057ccba5c6770a6aeba59d39fde073354fb90a8
2019-09-23 12:37:34 -05:00
Akihiro Motoki
2d2376397d Ensure doc/source/_static to fix docs gate
doc/source/_static directory is required by oslo.policy sample generator.
The recent sphinx complains if _static directory is missing.
This commit adds a placeholder file to ensure doc/source/_static directory.

Change-Id: Ied6cbc80c4b384ed45c927f2aea8e88604f457fe
2019-09-06 10:07:26 +09:00
Zuul
d2a1b28c21 Merge "Replace git.openstack.org URLs with opendev.org URLs" 2019-08-06 10:26:13 +00:00
Zuul
e2c8b1b7f4 Merge "Added section for Utimaco HSM in documentation." 2019-08-06 09:01:33 +00:00
Andreas Jaeger
6e193a308e 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.

Fix api-guide building: Use docs requirements.

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

Change-Id: I16af26b25e36ab1281f109cd5765db1ead9f3df6
2019-08-05 17:58:16 +02:00
zhulingjie
2b99217219 Replace git.openstack.org URLs with opendev.org URLs
Change-Id: If528c06d9d5ff84d9d7df8ce946a46012d148417
2019-05-23 12:50:09 +08:00
Douglas Mendizábal
3c2a99604a Update Back End Documentation
Change-Id: I9c00245adf19e380ef31cc9da9aa66af3f697785
2019-05-15 21:37:16 -05:00
Andreas Jaeger
80fc5511b8 Block bandit 1.6.0
Bandit 1.6.0 broke the -x command, block this release so that
pep8 tests pass again.

Sync with global requirements file to pass tests:
* update sphinx
* update jsonschema

Change-Id: If78421403ae188713820feb2071a8a889d9ccd7b
2019-05-13 15:37:57 +02:00
Le Hou
28405cb046 Update to opendev
Change-Id: I0d079752c19cba21be6f02caa1aed9b917999495
2019-04-23 15:35:42 +08:00
Alexander Gräb
83affb82b2 Added section for Utimaco HSM in documentation.
This is to address concerns which were made in a previous patch
(see https://review.openstack.org/635736).

Change-Id: I58b934d7d4dc0f5e0928af89b48320799dac9eed
2019-03-08 13:50:28 +01:00
Ade Lee
5fb7bfec55 Documented ATOS and Thales config for PKCS#11 plugin
Change-Id: I7e6a401993393f654c45865487d91b347cd972c0
2019-01-25 17:11:33 -05:00
Zuul
941ca64e5d Merge "Remove -u root as mysql is executed with root user" 2019-01-15 18:35:49 +00:00
whoami-rajat
d3280f18f3 Add barbican-status upgrade check command framework
This adds basic framework for barbican-status upgrade
check commands. For now it has only "check_placeholder"
check implemented.
Real checks can be added to this tool in the future.

Change-Id: I40bfcc0c8755e814c1b63fdf323c32fda967968e
Story: 2003657
Task: 26120
2019-01-15 06:16:53 +00:00
Zuul
e2498acf4e Merge "Clean up some config docs formatting" 2018-12-01 02:11:32 +00:00
zhangdebo
62b91dcddb Fix Chinese quotes
Change-Id: Ie5377f0512261e1112264688b4c92abab9650f8e
2018-11-24 16:18:01 +08:00
Tim Burke
a63406d89c Clean up some config docs formatting
Previously, we could get quoted sections that we didn't intend.

Change-Id: I82d687390da13df85910dda0d3fc536c018c596a
2018-11-19 17:51:16 -08:00
zhang.lei
371a9655ec Remove -u root as mysql is executed with root user
As openstack installation guides suggest to run mysql with root shell
user, mysql will not ask for password, so in
controller-install-*.rst "-u root -p" is useless.

Change-Id: I12807c72ee9fdbba6569e9b896bda22888c48a2d
Related-Bug: #1785025
2018-08-14 12:52:03 +00:00
Nguyen Van Trung
727ffb14d3 Add doc8 to pep8 check for project
This patch adds a doc8 check of .rst files to the current pep8 check.
It includes fixes to the .rst files that didn't pass the check.

Change-Id: If9c6fbf51033cd420c605443dbb3049535024697
2018-07-30 01:56:14 +00:00
Zuul
6fd9a48bef Merge "Activate html_static_path config option" 2018-07-27 11:39:42 +00:00
Zuul
3d59432306 Merge "Update http to https and fix link in doc reference" 2018-07-25 16:34:51 +00:00
Zuul
33cbc5addf Merge "Switch to stestr" 2018-07-25 16:34:49 +00:00
Zuul
c0e75333d5 Merge "Update two Barbican services to Docs" 2018-07-25 00:45:00 +00:00
Nguyen Van Duc
0886ebf01a Update http to https and fix link in doc reference
Change-Id: If24cd99c44e3318463e4c6127d1186ec310cc56f
2018-07-24 01:28:34 +00:00
Vu Cong Tuan
1f8a317ace Switch to stestr
According to Openstack summit session [1],
stestr is maintained project to which all Openstack projects should migrate.
Let's switch to stestr as other projects have already moved to it.

[1] https://etherpad.openstack.org/p/YVR-python-pti

Change-Id: Iee69eae0043a401eb355a1fcb957879904882e85
2018-07-17 09:48:31 +07:00
Marc Methot
d32e82e241 As of April 28th 2018, Barbican has been migrated to storyboard.
The documentation should be adjusted.

Change-Id: I99684cf2ea77316d53bbdd7d0285a0618dda5a22
Task: #22851
2018-07-05 14:59:45 -04:00
Nam Nguyen Hoai
755fee7f0c Update two Barbican services to Docs
Currently, there is a lack of service information. "barbican-worker"
and "barbican-keystone-listener" should be updated to "Key Manager
service overview".

Change-Id: I1d11c358fa6693a4d9e996215db6a61e2dc9484d
2018-07-04 06:09:30 +07:00
Dao Cong Tien
62a65ecc7a Activate html_static_path config option
This config option is disbaled causes some static links
cannot be found (error 404). Eg.

The link to sample policy file in:
https://docs.openstack.org/barbican/latest/sample_policy.html

Change-Id: I43b146d9bd7cfc4329b76a44427961aaec456985
2018-07-03 16:59:27 +07:00
Zuul
dfa2d6e153 Merge "Follow the new PTI for document build" 2018-06-11 14:44:33 +00:00
Nguyen Van Trung
baec7f5490 Follow the new PTI for document build
For compliance with the Project Testing Interface as described in:
https://governance.openstack.org/tc/reference/project-testing-interface.html

For more detials information, please refer to:
http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html

Change-Id: I31f34904335fa889c05153bf899067dba7453fbe
2018-06-07 12:33:15 +07:00
Zuul
47b99997c0 Merge "update some documents about the keystone "API v2.0"" 2018-06-04 16:09:59 +00:00