Commit Graph

44 Commits

Author SHA1 Message Date
wangqiangbj 9c6f3ff5b7 wrong spelling of 'openstack'
Change-Id: Id400ddffdffe9c534eaa40522038f94a5ed22f92
2019-01-10 17:55:46 +08:00
melissaml d1e7f7e180 Update auth_uri option to www_authenticate_uri
Option auth_uri from group keystone_authtoken is deprecated[1].
Use option www_authenticate_uri from group keystone_authtoken.

[1]https://review.openstack.org/#/c/508522/

Change-Id: Icbc6b3dd809e1f302d3cac9731f4845bc4df9f62
2018-04-18 21:21:12 +08:00
JinLi 0bbfe4f360 Change state_path to use its default value
State_path is defined in gluon/conf/config.py, its default value is $gluon_home/gluon.
In the [default] section of the /etc/proton/proton.conf file, its value overrided to
/opt/proton/ which can cause confusion. This patch changes it back to use default value
for state_path defined in gluon/conf/config.py.

Change-Id: I6af2d7e04e51b0476430975c10cc01fca24c9d9d
2017-11-13 18:46:45 -08:00
Bin Hu 0e99426b9e Updated Gluon Documentation for Pike Release
Updated documentation includes:
- doc/source/devref
  * Update on Gluon Authentication and Authorization
  * Version Management in Gluon API Specification and updated examples
  * Updated examples for Proton Version Management
  * Updated repo structure
- doc/source/installation
  * Updated installation guide for etcd and gluon
- doc/source/usage.rst
  * Updated user guide
- releasenotes/source
  * Updated release notes

Change-Id: I836690ccb5c538031e624f5f547b5f2c594ca4ad
Signed-off-by: Bin Hu <bh526r@att.com>
2017-08-29 13:46:19 -07:00
Jenkins ee99e05e3c Merge "Replace http with https for doc links in gluon" 2017-08-29 03:50:26 +00:00
shangxiaobj 4acc278260 Replace http with https for doc links in gluon
1) Update doc links according to OpenStack document migration
2) Use https instead of http for docs links

Change-Id: I3d01190d4010d77676173125196fb521b8cf45c7
2017-08-28 19:38:59 -07:00
JinLi f6201e9533 Modify proton.cof and move files around
Change [keystone_authentication] to [keystone_authtoken] in proton.conf
doc/samples/proton.conf.sample is for documentation purpose, move to doc/samples
etc/proton/proton.conf is for installation to copy to /etc/proton, move to etc/proton

Change-Id: I68058c731accd5d883317f26adec2db310b74ba1
2017-08-28 17:13:10 -07:00
Jenkins 5b46ab1021 Merge "Policies in yaml" 2017-08-26 01:17:10 +00:00
JinLi ecd29999cb Policies in yaml
Implement functions allowing to define object_level policies in
model's yaml file

Change-Id: I4a4b70edf95c56d8dba7ee669d5ccc8bd387c4d8
2017-08-25 16:09:57 -07:00
Omar Tleimat 2fe5276a56 Resolve warnings in Sphinx documentation
Currently several warnings are being thrown when running
tox -e docs, this is an attempt to fix those warnings

Change-Id: I26f3e1d83f2bfc7c5d5cd2a9393b24c992ff1122
2017-08-16 09:36:34 -07:00
Jenkins 224ebeab8f Merge "Set environment variables for protonclient" 2017-07-26 22:39:06 +00:00
JinLi 081c86f494 Set environment variables for protonclient
protonclient requires user credentials to be set up as environment
variable when keystone is enable for authentication. Add an openrc
file to help setting up this variables.

Change-Id: Idea1112a61b030d869371642575147cf6aa46d18
2017-07-26 12:41:35 -07:00
Jenkins 12c6c26736 Merge "Update formatting in Contrail docs" 2017-07-26 18:32:18 +00:00
Hangdong Zhang b42d94e851 Update the documentation link for doc migration
Change-Id: Ia6fc477b73ba8c4ceca47ddf38bad6c5bfe30330
2017-07-24 15:31:14 +08:00
Kamil Renczewski 5dc0497be7 Update formatting in Contrail docs
Change-Id: If8fd3bd867f9cb1313e3e16914f6fc4571289059
2017-07-12 16:34:53 +02:00
Jenkins 0d9ad1373c Merge "Update documentation for Contrail installation" 2017-07-07 13:35:34 +00:00
Kamil Renczewski 03211a2f05 Update documentation for Contrail installation
Change-Id: I9b959d1bf468a1d0fd7ce06e4e55f1e903c30fea
2017-07-05 17:48:41 +02:00
JinLi d435203e6c Fix incorrect commands adding Gluon service to Keystone
The commands in appendix of gluon-auth.rst are not right and
cause errors when running in terminal. The changes reference
ocata doc:
https://docs.openstack.org/ocata/install-guide-obs/neutron-controller-install.html

Change-Id: If7a703add8d378dc9184f50dcc6dea56e69b3876
Closes-Bug: #1698245
2017-06-27 19:05:39 -07:00
Tin Lam 5fff618917 Fix doc gate failure
This patch set fixes the blocking documentation gate failure for Gluon.

Change-Id: Ic1e1b2ea8c65ba9d29940d1e9034857bfc78d0c6
2017-05-31 03:42:37 -05:00
Jin Li 7843037629 Proton Version Management
Add Proton versioning specifications into doc folder.

Change-Id: Iac04b61184601f9c8a96d44a370dbbac48bd73b3
2017-04-26 19:31:13 +00:00
Georg Kunz 68b3188a4e Refined installation instructions
Change-Id: Ibdfd0dfaf1290226be2a30682b6efd0d86dcd900
Signed-off-by: Georg Kunz <georg.kunz@ericsson.com>
2017-04-04 00:23:13 +02:00
Bin Hu ec3fcb10d9 Update Gluon Installation Instruction
Because we already have stable/ocata branch, the installation
instruction needs update so that users will only clone from
stable/ocata branch. Thus the option of cloning from master
branch is removed.

Change-Id: I8307929ad4b0cc55e243a9df083fc6e1cb3acb42
Signed-off-by: Bin Hu <bh526r@att.com>
2017-03-01 12:48:49 -08:00
Bin Hu e95afc3f3f Gluon Documentation Update
This is a set of documentation for Gluon in Ocata Release, including
- README.rst for overview of Gluon project, and related resources
- In doc/source: updated
  * index.rst for overall documentation
  * contributing.rst with license header information
  * readme.rst       with license header information
  * installation.rst that covers Gluon installation procedure
  * usage.rst        that is Gluon's User Guide
- In doc/source/installation: added for details of installation procedure
  * install_etcd.rst
  * install_gluon.rst
  * install_contrail.rst
- In doc/source/devref: updated Developers' Guide, including
  * index.rst             with current developer documentation
  * high_level_design.rst with updated high level design of Gluon Ocata
  * repo_structure.rst    with current repository structure

Change-Id: I1aa04d3a85bbda6c5a8114115c34042e43a4a0c9
Signed-off-by: Bin Hu <bh526r@att.com>
2017-02-15 07:58:18 -08:00
Jenkins bfb0f6a42d Merge "Gluon Access Control Blueprint - updates" 2017-02-08 18:21:26 +00:00
Kamal Hussain 3c007e31d6 Gluon Access Control Blueprint - updates
Contains updates for the policy.json and proton.conf files

Change-Id: I7472c238c09f5cdaab161a5cbf07df12e44f78f4
Implements: blueprint gluon-auth
2017-02-07 15:55:50 -06:00
Kamal Hussain 3e374a9864 Sample policy.json and proton.conf files
Contains sample files of policy.json and
proton.conf.

Change-Id: I95e0f49cf6d7f56c02b7b6eca49579d59ef54503
Implements: blueprint gluon-auth
2017-02-07 15:10:42 -06:00
Jenkins 4756f935a9 Merge "Remove execute permission bits from API spec doc" 2017-01-24 18:53:16 +00:00
Thomas Hambleton 1ef4f87b28 Update code to comply with Gluon API Spec
Many changes to support new Gluon API Spec.

Summary of changes:
- gluon-api-tool: New command line tool to validate an API Model.
- Restructured models directory
  - Removed proton directory
  - Created a directory for the base objects file
  - Created directory for net-l3vpn and change filename to api.yaml
  - Created directory for a test API
- Updated manager code to automatically create default interface
  object when a port object is created.
- Updated shim layer code to track the interface object and to
  handle service binding to interface instead of port
- Added new API types and validation logic
- Updated API and Database generator code to process the new
  model constructs
- Updated the test cases to complete with the new model format.
- Reworked code to support parent/child API relationships.  The
  SubObjectController now works for one level.

Change-Id: I995b46076e9fded11e4eda789dacd41a1a3b43c7
Implements: blueprint gluon-api-spec
2017-01-22 10:39:27 -06:00
Paul Carver f763f99836 Remove execute permission bits from API spec doc
RST files don't need execute permission. This commit simply removes
the execute permission bits from gluon_api_spec.rst.

Change-Id: If65954410f59535f93c3980f4c27f833d932191f
2017-01-20 09:59:15 -05:00
Thomas Hambleton 30aca34f28 Gluon API Specification
This document contains a detailed description of the
YAML file syntax for defining an API using the
Gluon Framework.  This document describes existing
constructs and introduces some additional constructs
that will need to be implemented (if approved).

Change-Id: I8f5c7f3148d04e12ba96a509b09b71eac21cabcd
Implements: bluepring gluon-api-spec
2017-01-05 12:05:07 -06:00
Jenkins 328e7ec489 Merge "[WIP]Test Case Proposal" 2016-12-21 18:23:18 +00:00
JinLi bab6ba885d [WIP]Test Case Proposal
add test case proposal for testing Gluon database

Change-Id: Ia1b03c639b0313faec024c7617a6890e5bd48c82
Implements: blueprint gluon-ml2-plugin
2016-12-21 14:19:11 +00:00
Jenkins c4b2cfbdec Merge "First draft of Gluon access control blueprint" 2016-12-15 16:15:59 +00:00
Kamal Hussain d3da2200c6 First draft of Gluon access control blueprint
This is the first draft on implementing authentication and authorization for
Gluon subsystem. The document explains the identity objects that need to be
created and suggests a policy.json file for Gluon.

Change-Id: Id7a9972b379987a3eb7bd9856d2c0c9af8ac74ee
Implements: blueprint gluon-auth
2016-12-13 13:42:09 -06:00
Darla Ahlert 0e0cc14188 Add/Update documentation for Gluon Developers
This commit takes documentation previously created and splits it
into multiple files. This will eventually become a one stop shop
for developers needing documentation to contribute to Gluon.

Change-Id: I32287913c2d7bbc42a4f8685c2e71d3a18d4e807
2016-12-08 13:38:42 -06:00
Thomas Hambleton ff669cac79 Port and Service Binding Model for Gluon
This document describes the generic port and service-binding model
available in Gluon to define new networking service APIs.

Moreover, this document shall support developers of new APIs
by providing a guideline for new APIs.  In addition to the generic
model, a slightly adapted version of the L3VPN model is included as
an example.  This commit is a combination of:

https://review.openstack.org/392250 and
https://review.openstack.org/395738

Co-Authored-By: Georg.Kunz@ericsson.com
Co-Authored-By: Thomas.Hambleton@nokia.com

Change-Id: I69f2b530088d4dd7bc21be502210db1740f507d3
Implements: blueprint port-service-binding-model
2016-11-23 14:50:52 +00:00
Manjeet Singh Bhatia 5bd2e840da trivial fix
I was reading the doc and found it,

Change-Id: I5dac0f19d6ef87ec99404c3809d57b7e675e6115
2016-10-18 00:11:35 +00:00
Jenkins fae399511b Merge "Gluon Plugin Wrapper Design" 2016-09-28 16:58:11 +00:00
Thomas Hambleton 3bdf24ae96 Gluon Plugin Wrapper Design
This document describes a way to integrate Gluon with Neutron
by creating a subclass of the ML2 wrapper and overriding the
port-related methods.

Partially Implements: blueprint gluon-ml2-plugin

Change-Id: Ib64c84792ca5d0023afa3d1cebb5d26de0b13314
2016-09-28 15:04:04 +00:00
Nikolas Hermanns 109fb6f4c0 Database Migration Strategy
Change-Id: Ibc2f1691d7002ab5bd6eb20ed51ec63a6f424155
2016-09-14 10:41:23 +02:00
Bin Hu 3234a7aefa Task list
Change-Id: I71b03c5487b3fb13e1b9b5992accebc34f108072
Signed-off-by: Bin Hu <bh526r@att.com>
2016-09-05 11:28:32 -07:00
Jeff Collins e65ee14d30 First draft of High Level Design document.
Change-Id: I72aea8241ec3f2df3e497655ed3f1afc1633cf4f
2016-08-03 15:57:27 -05:00
Hambleton, Thomas W (Thomas) 87cca5e820 Document proposed repo structure
Implements: blueprint repo-structure
Change-Id: If52f6f328e39491e9757ae5bd75d31fd7636f5c4

Implements: blueprint repo-structure

Change-Id: I17d74a427a5b478f803564191c3a12702407eeab
2016-07-27 20:37:59 +00:00
Bin Hu 4fa03fa960 Initial repo from cookiecutter
Change-Id: I4c08babb4b1de8d47728c3562d1129521dc62c83
Signed-off-by: Bin Hu <bh526r@att.com>
2016-06-29 14:26:40 -07:00