This also adds the requirements.txt to the docs tox env,
to fix the failing openstack-tox-docs CI job.
Change-Id: Id920d274100078ad922f8686d29c0b9a8612ac7d
This patch updates the installation doc for the devstack plugin. It
also removes the Vagrant option as it has not been maintained in quite
some time.
Change-Id: I97fc2fac0cb29b1059b668bbe817a2778a8a4a70
Users with the "creator" role on a project can now delete secrets owned
by the project even if the user is different than the user that
originally created the secret. Previous to this fix a user with the
"creator" role was only allowed to delete a secret owned by the project
if they were also the same user that originally created, which was
inconsistent with the way that deletes are handled by other OpenStack
projects that integrate with Barbican.
This change does not affect the policy for delting private secrets
(i.e. secrets with the "project-access" flag set to "false").
Story: 2009791
Task: 44324
Change-Id: Ie3e3adc1ee02d770de050f5cfa8110774bb1f661
As per the community goal of migrating the policy file
the format from JSON to YAML[1], we need to do two things:
1. Change the default value of '[oslo_policy] policy_file''
config option from 'policy.json' to 'policy.yaml' with
upgrade checks.
2. Deprecate the JSON formatted policy file on the project side
via warning in doc and releasenotes.
Also replace policy.json to policy.yaml ref from doc and tests.
[1]https://governance.openstack.org/tc/goals/selected/wallaby/migrate-policy-format-from-json-to-yaml.html
Change-Id: Idaa65dac1c97324d671b9a07a2f3d51bb128e8c2
Accidentally wrong lables were copy pasted into the doc. In the meanwhile
labels in sample commands should be the same as used in the sample
configuration block above the generation commands.
Change-Id: I3ddbd086815917cd0c124a88b31333fd366a574c
Luna Network HSM configuration was not full which may raise unnecessary
questions during integration. Also worth mentioning, when store_crypto
has effect on the barbican behavior.
Change-Id: I33032226d0dd891b9c33c4705fd8627c66bd76d9
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
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
This patch standardizes the CONTRIBUTING.rst file and adds the
required doc/source/contributor/contributing.rst
Task: 38514
Change-Id: I8a5d202f903e89e19106ccdda11fc30522892e7f
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>
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>
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
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
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
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
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
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
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
