195 Commits

Author SHA1 Message Date
Jenkins
f533c0bda4 Merge "allow redirects in .htaccess files on the static web servers" 2017-09-11 23:23:44 +00:00
Jenkins
56bdd2b913 Merge "Replace http with https for doc links" 2017-09-01 11:16:24 +00:00
Jenkins
ce24b15aca Merge "Fix to use "." to source script files" 2017-09-01 10:59:23 +00:00
chao liu
acec0460a0 Fix to use "." to source script files
Adhering to coding conventions. Refer to ``Code conventions`` at
https://docs.openstack.org/contributor-guide/ for details.

Change-Id: I2b87922913299aba691d1b1183ce108a74025369
2017-08-28 13:50:52 +00:00
shangxiaobj
b833108d5d Replace http with https for doc links
1) Update doc links according to OpenStack document migration
2) Use https instead of http for docs links

Change-Id: I3564d1e10aeea40b74ef52bf29b3a39c5d9b0bc2
2017-08-27 20:14:36 -07:00
chao liu
43d389968e writing convention: do not use “-y” for package install
refer to:
https://docs.openstack.org/contributor-guide/writing-style/ \
code-conventions.html

Change-Id: I2b59c5ff02d38c2e15e728feadd123aaa6137ff0
2017-08-28 01:33:45 +00:00
rajat29
0eb5f38c26 allow redirects in .htaccess files on the static web servers
As part of allowing projects to establish redirects when they move
documentation pages around, we need to let them use .htaccess files.
We only want to allow Redirect and RedirectMatch directives,
though. This change restricts the directives on docs.o.o and adds them
on the static servers used for drafts published during a build (to
allow testing of the redirects).

For more details see:
 http://lists.openstack.org/pipermail/openstack-dev/2017-July/120240.html

Change-Id: I754c8016ca2a475e74023017530264e7ae331557
2017-08-03 14:41:32 +05:30
Jeremy Liu
b1b6754204 Update internal doc reference according to doc migration result
Change-Id: I248221414c8ad9b3d8f89ca8dc880ebf923995af
2017-07-17 11:43:02 +08:00
Andreas Jaeger
1d1a6f3729 Use openstackdocstheme 1.11 everywhere
Switch to use openstackdocstheme 1.11 for all documents and set it up
following correctly.

Change-Id: If312a985702b1b591d3ca7346c5349905b23a66a
2017-06-30 20:12:52 +02:00
Andreas Jaeger
b86d6b5660 move documentation into the new standard layout
This change moves existing files.
It is not meant to be the final word on how the main page looks or how the
other files are organized, but it gets everything roughly into shape. If
the barbican team wants to make changes, please do those as follow-up patches.

Note this does not touch the api directory, this one needs to be
migrated to the api-ref.

This is part of the docs migration work for Pike.

Change-Id: Ibb9d971806964ac185882272514ee9563089d69d
2017-06-30 20:12:52 +02:00
Jenkins
014cc17be5 Merge "Unification content of the index.rst file" 2017-06-06 16:24:03 +00:00
Nam Nguyen Hoai
76f860abab Fix some syntaxes in the upgrade guide
Change-Id: Idde0b4f0699ff293afcaf8532a6b1ec1cbb0d6d3
2017-06-06 16:33:56 +07:00
Nam Nguyen Hoai
341fb3c4f3 Unification content of the index.rst file
In the index.rst file, sometime, we declare that name_of_file.rst,
sometime is name_of_file.

For example. the content of the barbican/doc/source/api/index.rst
is that:

"""
    ./reference/secrets
    ./reference/secret_types
    ./reference/secret_metadata
    ./reference/store_backends.rst
    ./reference/containers
    ./reference/acls
    ./reference/quotas
    ./reference/consumers
    ./reference/orders
"""
That is confusing, it should be like below:

"""
    ./reference/secrets.rst
    ./reference/secret_types.rst
    ./reference/secret_metadata.rst
    ./reference/store_backends.rst
    ./reference/containers.rst
    ./reference/acls.rst
    ./reference/quotas.rst
    ./reference/consumers.rst
    ./reference/orders.rst
"""

Change-Id: I54ca41bb27f59caaaddab977ef4a3cf7f66bb5f3
Closes-Bug: #1694180
2017-06-03 08:11:52 +07:00
Nam Nguyen Hoai
57e2f8943a Add guideline to upgrade for Operators
This patch set will add a document guideline
to upgrade for Operators.

Change-Id: Id405801b58e3d8c799794b29dbcb8e14cf4f0cc6
2017-06-01 08:43:39 +07:00
Fernando Diaz
3f6c24a4ef Remove Certificate Orders and CAs from Documentation
Removes the documentation and links to domcumentation for
Certificate Orders and CAs.

Change-Id: I4cd3c21ac4f82eeb76d700426374cec898be4125
2017-05-04 05:02:23 +00:00
Jenkins
d3ab3a27e3 Merge "Failed to set up a dev env on ubuntu" 2017-03-09 01:30:15 +00:00
Kiran_totad
04a9072171 Changed the python3.4 to python3.5
Change-Id: Ia4d2fbea713537163ae5232ff29f2857f59352c2
2017-03-07 11:58:55 +05:30
Kiran_totad
d3d114e6ce Failed to set up a dev env on ubuntu
Change-Id: Ie6d561b0e8335ab25f26d140302b336e591df8af
Closes-Bug: #1581404
2017-03-01 10:17:32 +05:30
Jenkins
51953c10ff Merge "Fix Consumer API Reference Docs" 2017-02-02 22:36:11 +00:00
Jenkins
0fe80fc165 Merge "Fix typos" 2017-02-01 13:07:28 +00:00
Fernando Diaz
773feeace4 Fix Consumer API Reference Docs
Resolves some errors in the Consumer API Reference Documentation
including improper requests and missing headers. Also Updates
response codes.

Depends-On: Ib038047dc1b96194ea1b5ff63ae58b5c78d05ffd
Related-Bug: #1660074
Change-Id: I6f1af0b95d3800bf182f4d6bebcdebb8eb60ddd7
2017-02-01 05:42:40 +00:00
Juan Antonio Osorio Robles
9a934e57eb Revert "Add ID property to all entities"
This change breaks several gates, including RDO's package promotion.

This reverts commit f06ba481956d406a1edf644f1c2c3ff55705d0f1.

Change-Id: I0524b7057016daa59ea0a506bdc50a71e9fc8f6a
2017-01-30 21:27:29 +02:00
Jenkins
75a7ebe678 Merge "Add ID property to all entities" 2017-01-27 22:14:07 +00:00
Douglas Mendizábal
f06ba48195 Add ID property to all entities
This patch adds an "id" property to secrets, orders and containers
returned from the API.  The value of the "id" property is the unique
UUID found at the end of the entity reference.

Change-Id: I65bab35807ed2cee6ed5d6aca1c99769678751be
2017-01-26 14:00:01 -06:00
Jenkins
563e164636 Merge "Removes unnecessary utf-8 encoding" 2017-01-24 02:35:26 +00:00
Nam Nguyen Hoai
a936b28c49 Fix typos
There are some wrong words, it should be updated.

Change-Id: Ib57e056ac43c0e1815ee135f402490f2cef0ad10
2017-01-20 13:33:47 +07:00
ji-xuepeng
17f60c0583 Removes unnecessary utf-8 encoding
Change-Id: I3f3ad6e8519bb8b35fb33523cf8f03df42c534a7
2017-01-12 12:41:52 +08:00
Mike Carden
83a6128678 DOC Remove a couple of repeated words
Remove words accidentally duplicated during editing.

Change-Id: Id97d7e7c4189208de26717ea32e5f26ce24d96fe
2017-01-11 14:30:37 +11:00
Kaitlin Farr
ed124cbe2e Fix crypto plugin documentation
Changes references from barbican.plugin.crypto.crypto to
barbican.plugin.crypto.base.

Change-Id: I1461ef876aa670cd856a339d1cf8d29e410f5576
2016-11-15 17:49:26 -05:00
Fernando Diaz
140a8182e2 Deprecate Cetificate Resources
Begins the deprecation process for Barbican CAs API,
and Barbican Certificate Orders Resource. This is
done through logging deprecation schedule on API,
as well as adding a warning to the documentation.

Change-Id: Idbe6307fa45527aa225e61b3b1ac9ca86e7660c5
2016-11-03 18:12:28 +00:00
Jeremy Liu
88ba85a2f1 Remove redundant 'the' in doc
Change-Id: I8ce30328e99028d0f711930e2ef545a0cd7909dc
2016-10-22 22:03:39 +08:00
Jenkins
9a6ee3fb60 Merge "Default to Keystone authentication" 2016-10-20 18:26:01 +00:00
Yushiro FURUKAWA
3410ac9c4b Fix typo
Trivialfix 'metdata' to 'metadata'.

Change-Id: I2d7ff9ada22ea561757477e8bb23579cd5a299ee
2016-09-29 22:11:38 +09:00
Arun Kant
6535e559cd Adding rest API for secret-stores resource (Part 4)
Added tests to provide 100% coverage on API and policy logic.

Change-Id: Icb43049250be1d78bdd3db8fbad0dc0381cccaf7
Partially-Implements: blueprint multiple-secret-backend
2016-09-14 10:18:13 -07:00
Arun Kant
669a995196 Adding API docs for multiple backend support changes.
Updated multiple plugin configuration sample as per recent
discussion.

Change-Id: I7d5c0f088c392ae73dea603198c1845c346b2d39
Partially-Implements: blueprint multiple-secret-backend
2016-09-07 11:24:08 -07:00
zhangyanxian
6f46088a65 Fix some typos in database_migrations.rst
Change-Id: I713605e7df2cb0b11d39f7825f70ec220f66e6a6
2016-08-24 08:14:52 +00:00
jfwood
b84434b845 Make 'url' references uppercase for consistency
There are a few places in our documentation where we use lowercase
'url'. This CR changes those to 'URL' for consistency.

Change-Id: I509fd82f1a44bfbc819866a45aaffafb0192bc36
2016-08-16 16:31:56 -05:00
Douglas Mendizábal
8480f4eb4f Add documentation for date-filters
Change-Id: I82a16e372e7d04ad45818faee619ee04dadfab07
DocImpact
2016-08-03 14:43:48 +00:00
Arun Kant
ce6336f393 User with creator role can delete his/her own secret and container
Modified policy and tests to verify this change.

As per this change, user with 'creator' role can delete a secret or
a container as long as that user has initially created that secret
or container.

There is still a difference between 'admin' role and 'creator' role
behavior around delete operation. With this change, users with 'creator'
role cannot delete any other user's secret/container in same project
while user with 'admin' role can do that.

Updated role docs to reflect this behavior.

Change-Id: I53e5529ed34ac4acc76348ca0431cb3de7934b6d
2016-07-25 13:42:01 -07:00
Johannes Grassler
497db2c776 Default to Keystone authentication
This configures Barbican to use Keystone authentication by
default and updates documentation accordingly.

Change-Id: Ie0a1995b971371d18238138575629eeee1a36392
Closes-Bug: #1595428
2016-07-21 09:51:51 +02:00
John McKenzie
592cf2ec28 Add support for modifying Generic Containers
This adds POST and DELETE support for a 'secrets' sub-resource on the
containers resource. This will allow a user to add or remove secret
references to an existing container. Only generic containers are
supported per the blueprint for this feature.

If a secret reference already exists in the container, an appropriate
error will be returned indicating that the secret already exists in
the container. I chose this approach over silently accepting the
update, as the name for the container secret could change, so a delete
and re-add seems to be the safer option if a user just wants to change
the name, which is not something that I see happening too often.
Additionally, the action is a POST and not a PUT, so it shouldn't
really update an existing resource.

APIImpact
Add support for POST and DELETE on container secrets sub-resources

DocImpact
Implements: blueprint api-containers-add-put

Change-Id: I6dfa6715385f421e4f173cf73c2b75b68da67051
2016-06-28 15:07:00 -05:00
Jenkins
502c1fff07 Merge "[Trivial] Remove executable privilege of doc/source/conf.py" 2016-06-16 09:25:57 +00:00
Cassandra Burnias
3d7600d9d4 Fixed typo in crypto plugin docs
This fixes a simple typo in the docs for the crypto plugin.

Change-Id: Ie50fe23fea189ac782602c8cb46ab72569e2a9ad
2016-06-08 15:30:17 -05:00
Kaitlin Farr
3169ac4e18 Fix doc warnings
When building the docs using `tox -e docs`, several warning messages
would print out. This change fixes the issues causing those warnings.

Change-Id: I57503c75f6c07c020bb3bfa34de6aa8f66983ff7
2016-05-19 15:23:25 -04:00
Paulo Ewerton
8abb2c6a0b Use keystone auth plugin
keystonemiddleware admin settings are deprecated
so we should stop using them in favor of a keystone
auth plugin. This patch updates the config file
to use keystone API v3 by default.

Change-Id: I9d10ac29ab33cbdd845573106960e5f181afdb69
Closes-Bug: 1579801
2016-05-16 14:19:41 +00:00
ZhiQiang Fan
abe30d7072 [Trivial] Remove executable privilege of doc/source/conf.py
It is a configuration file, rather than a script.

Change-Id: Idd40314fa28a755d2380ebc71f52e6199a873eb0
2016-04-29 19:27:08 +08:00
Anh Tran
d6412aa3a9 Removes redundants
This patch removes redundant "to" and "the".

Change-Id: I6c1a9012fc331cc546c5fc39dd3fc1051a1257ff
2016-03-24 14:24:14 +07:00
Priti Desai
953e45e88e Publishing API Guide to OpenStack site
Moving files from doc/source/api/userguide/*.rst
to api-guide/source/*.rst,
also add api-guide/source/conf.py for building api-guide,
add a new tox target named api-guide
Taking a reference from this patch which was used for the
similar migration of Nova api guide:
https://review.openstack.org/#/c/230186

Change-Id: I725e7939f9a88185de6ef32b311159b0924b7183
Partial-Bug: #1540665
Needed-By: I7b7c623e6299c803930e41d72510f1a67d909fa3
2016-03-16 12:44:50 -07:00
Mohit Motiani
4fd969521a Nit: occurrences of barbican in small letter.
Changed occurence of Barbican to barbican beacuse according to
convention, project name should start with small letter.

Reference:
https://governance.openstack.org/reference/service-project-naming.html

Change-Id: I086406619c0e395d45f0afdd74135ad5b64d9802
Closes-Bug: #1553349
2016-03-07 20:12:00 +00:00
Fernando Diaz
b2a557ce7d Fix index for API secrets user-guide
Index has wrong bath for the User-Guide. This patch resolves the
path.

Change-Id: Iddebf9b46cfdf1568a351f3413f2d18cf2f833e2
2016-03-04 18:51:18 +00:00