52 Commits

Author SHA1 Message Date
Dongcan Ye
56a98cf6cb Docs: Add fullstack test guide
Change-Id: Ifb5acb563498a9228417bd56b471a5229d3fb83d
2018-02-11 06:51:54 +00:00
shangxiaobj
78ba957ab0 Replace http with https for doc links in kuryr-libnetwork
1) Update doc links according to OpenStack document migration
2) Use https instead of http for docs links

Change-Id: If0b076ecd9b6c82186e8d6e504da3aa9d11a7dd3
2017-08-31 19:49:14 -07:00
Kirill Zaitsev
bf9e3e02c0 Use openstackdocstheme over oslosphinx
This commit is part of general doc-migration effort. It replaces
oslosphinx with openstackdocstheme and marks docs warnings to be treated
as errors.

Kuryr projects do not seem to have any docs in the openstack-manuals, so
there are no docs we need to pull from that repo.
However being the official project kuryr would benefit from unifying
its docs with the rest of openstack projects as well as using
openstackdocstheme, theme intended for official projects
https://docs.openstack.org/openstackdocstheme/latest/

See https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html
and https://etherpad.openstack.org/p/doc-migration-tracking for more
information

Change-Id: Iaba05a9e50e1c1e1bdd821a1222b392038561e63
2017-07-03 14:38:30 +03:00
Jenkins
286eaf4c9a Merge "Allow running kuryr-libnetwork with uwsgi" 2017-05-17 13:18:56 +00:00
Mohammad Banikazemi
cd82675242 Allow running kuryr-libnetwork with uwsgi
scripts/run_kuryr.sh now understands KURYR_USE_UWSGI. If set to "True" (default)
it would attempt to look for uwsgi executable and run kuryr-libnetwork
with it.
Number of spawned threads and processes can be controlled with
KURYR_UWSGI_THREADS and KURYR_UWSGI_PROCESSES env variables.

If uwsgi is not present or KURYR_USE_UWSGI is set to false the script
operates as usual.

Targets bp: deploy-kuryr-libnetwork-api-in-wsgi
Co-Authored-By: Kirill Zaitsev <k.zaitsev@me.com>

Change-Id: I821a78649ad6f07e4709fa343a0e678e4193a068
2017-05-15 09:57:52 +03:00
Liping Mao (limao)
b413675da4 Update Kuryr-libnetwork Docker managed plugin related doc
Change-Id: Ibc8c083dc0eeb58a3d4bf4cc7cecbdadd320b25d
Partially-Implements: BP docker-v2plugin
2017-05-05 14:07:49 +08:00
Liping Mao (limao)
95e22ab2b6 Kuryr-libnetwork container ssl error in multi-thread
When use kuryr-libnetwork container with multi-thread and neutron
service under https, uwsgi will has ssl error.

Change-Id: I897d84742570dcc2d4daba1ea40882814a38679f
Related-Bug: #1675301
2017-03-24 14:26:55 +08:00
Jenkins
f003b8380a Merge "Add docs for IPv6 address pool" 2017-03-15 13:35:07 +00:00
Dongcan Ye
01f904718a Add docs for IPv6 address pool
Add create docker dualstack network command and
limitations for IPv6.

Change-Id: I0714a44bee3a488048a211f7b3523eb6cf05f2b3
Partially-Implements: blueprint ipv6-subnet
2017-03-14 18:03:12 +08:00
Hongbin Lu
2e6f4cd1cb Support creating network with pool uuid
Right now, we can create network with pool name, but it doesn't
work well if there are two subnetpools with the same name. This
commit add support for pool uuid as an alternative.

Implements: blueprint existing-subnetpool
Closes-Bug: #1659434
Change-Id: Ib7c2bac86a1b1647c2da9684bc4317767116d7aa
2017-03-09 17:03:59 +00:00
Jenkins
a636ae59a9 Merge "README: fix nested container rendering" 2017-02-01 15:50:15 +00:00
Jenkins
dffbb4e921 Merge "Add nested-containers limitations" 2017-02-01 15:49:49 +00:00
Janonymous
1e3d164a71 Tls support configurations
Change-Id: If16d60d03629734a3abe0393a967e8458653f3ff
Partially-implements: bp tls-support
2017-01-27 05:22:25 +03:00
Antoni S. Puimedon
e1f1d0e823 README: fix nested container rendering
There was an error in how to render the code section inside the
bulletted list due to a lack of indentation.

Change-Id: I8e2c184fb6da915457803ad4676482da473bf4ac
2017-01-25 18:29:11 +01:00
Irena Berezovsky
0d81e45e18 Add nested-containers limitations
Due to Neutron trunk service implementation there are some functionalities
that does not work. This is added as a limitation in the README to raise kuryr
users awareness.

Change-Id: Ic6ceb781bacba119216a30a9221a68577039253b
2017-01-25 18:22:19 +01:00
mattmceuen
9cdb9a3f30 Add --gateway to README network create examples
The --gateway parameter needs to be passed to docker network create
when using kuryr-libnetwork.  This changes updates the README to
consistently use --gateway in its examples.

Change-Id: I9dd02f5df6d9886fe5e6c1365843bac5ad62e0c7
Closes-Bug: #1653178
2017-01-15 21:56:31 -06:00
Luis Tomas Bolivar
d6c47ded71 Nested-Containers: trunk subports management
Add support to create/remove subports when vlan driver is used.

Partially Implements blueprint containers-in-instances

Change-Id: I26dfa04657c4904bcb46ecdc35ef7d76a1e81b16
2017-01-10 11:33:45 +00:00
bailinzhang
6ff465a713 Fix the file permissions of README.rst
-rwxr-xr-x  README.rst
As shown above,the file have executable attribute
that need be removed.

Change-Id: Ic601c528d562149c03b600bbc147f722cb26ce29
2016-11-29 01:20:37 +00:00
Flavio Percoco
3713b3e4e3 Show team and repo badges on README
This patch adds the team's and repository's badges to the README file.
The motivation behind this is to communicate the project status and
features at first glance.

For more information about this effort, please read this email thread:

http://lists.openstack.org/pipermail/openstack-dev/2016-October/105562.html

To see an example of how this would look like check:

b'https://gist.github.com/9f6b605674070352cbd308441d5f7e2f\n'

Change-Id: I100d8fec5073c6d48fe843b72d429e9ffad6bb95
2016-11-25 13:57:04 +01:00
Dongcan Ye
465ab9b5d6 Fullstack: Using the credentials from openrc config file
Add getting credentials from ENV, this requires us source
openrc file in our DevStack or production environment.
Also removing get_neutron_client_from_creds into fullstack
code, keeping or removing it should be discussed.

Change-Id: I10d62368573976725e793e80150ed45074008970
Closes-Bug: #1528019
2016-11-23 14:24:35 +08:00
Dongcan Ye
881ce7296f [TrivialFix] Fix README
Fix format in README.rst

Change-Id: I48a564f223d101d35f1cef7abd2678c32d5ceb39
2016-09-27 15:42:29 +08:00
Mohammad Banikazemi
2e5f1e1069 - Adding the limitation for Docker 1.12
- Adding config options for using with Keystone version 2.0
- Adding some of the features

Change-Id: I62d52ce9d0be060f057a875da12827c7d2989979
2016-09-19 22:51:23 -04:00
Antoni Segura Puimedon
6f6ff11645
container: Build the container from tree not git
Up until this patch, the Docker container for the Kuryr libnetwork
daemon was part of contrib and was being built by checking out the
latest master from github. That is not very helpful when developers
want to build the container to run their latest changes.

With this change, we move the Docker building to the root of the repo so
that it can use the current state of the repo to build and update the
README.rst to contain the information relative to building and using the
container.

Change-Id: Ie9032d62c73d873a29cabe84c64a19df13fdb749
Signed-off-by: Antoni Segura Puimedon <antonisp@celebdor.com>
2016-09-14 10:23:12 +02:00
Li-zhigang
588681c9cc Fix URL in README.rst
Documentation: http://docs.openstack.org/developer/kuryr
Source: http://git.openstack.org/cgit/openstack/kuryr
Bugs: http://bugs.launchpad.net/kuryr
As shown above,the URL is error.

Change-Id: I1f852348a80ba8016b9e07b901c2552c22670c9e
2016-08-17 14:16:57 +08:00
Jenkins
4a820b0b98 Merge "Update kuryr developer readme" 2016-08-08 08:09:10 +00:00
Ashish Mukharji
183074a1f3 docs: minor changes for grammar and clarity
- grammatical changes for clarity

Change-Id: I975fee3e39fc1904088a9889623bbf98d77c65d0
Signed-off-by: Ashish Mukharji <ashish@Ashishs-MacBook-Air.local>
2016-07-22 17:42:47 +02:00
Ashish Mukharji
ae42fdce0f doc: rst improvements
rst allows double colons at the end of a block for improved
clarity and brevity

Change-Id: I39000043b17e404a12f9949ec766fc096be4179a
Signed-off-by: Ashish Mukharji <ashish@midokura.com>
2016-07-22 17:40:46 +02:00
Janonymous
b79af46914 Update kuryr developer readme
Installation should mention getting the source code step before
using Prerequisites step which uses requirements.txt

Change-Id: I24e6e4462c4ede906caa6a64d8f3fb31b2daeaa4
2016-07-11 09:21:50 +05:30
vikaschoudhary16
fb5e6d9b82 Doc-cleanup: remove redundant documentation
Complete documentation, specs and devrefs, is to be maintained at Kuryr,
the common kuryr lib.

Change-Id: I27a41817ef0def4dd0e9e9929e6019d18f566ac2
Closes-bug: #1599362
2016-07-06 13:28:53 +05:30
vikaschoudhary16
9c94d3ccc5 Drop common code and add kuryr_lib as requirement
1. Drop the common(COE agnostic) code such as binding, exceptions
2. Renamed kuryr-libnetwork/kuryr to kuryr-libnetwork/kuryr_libnetwork
3. change default kuryr port from 2377 to 23750
4. Add Kuryr-lib(Kuryr) to requirements.txt:
      Kuryr-lib(Kuryr) has also been cleaned to remove libnetwork specific
code(which is active in this repo such as libnetwork api handlers and
test cases). This patch is under review, [1]_. Meanwhile kuryr-lib
dependency is being resolved from external repo [2]. Exacltly same
changes, as present in under review kuryr-lib patch [1], are there on
external repo, [2]

[1] https://review.openstack.org/#/c/336784/
[2] https://github.com/vikaschoudhary16/kuryr/tree/drop_libnet_specific_code
Implements blueprint common-code-drop

Change-Id: If0823791463011dc395cd3390a7f4c187c9c2653
2016-07-05 16:02:44 +05:30
vikaschoudhary16
e2cd262087 Update README regarding overlapping cidr limitation
Overlapping cidrs are supported only via passing pool names using
docker options. Same is being updated in README.

Change-Id: Ia59152e1ddc61560b1ce4af807621add337cf979
Closes-bug: #1596183
2016-06-28 04:17:41 +00:00
vikaschoudhary16
43e6ae267c Fix ReadMe for config file generation info
Change-Id: I5f49572aa324bf752766ed98e71ed3ff83e58f0e
Closes-bug: #1590873
2016-06-09 21:50:52 +05:30
Mohammad Banikazemi
6fdd50af0f Trivial doc fixes
Change-Id: I93254c10204b23d2507f0259325c98b56a8d49c7
2016-05-18 18:08:50 -04:00
Fernando Moreno
370488315f Improve documentation
- Added keystone config in kuryr.conf
- Uncommented bindir parameter in kuryr.conf
- Added a quick cli test in the testing section

Change-Id: I5076fb8a2b56262bfce52c232ef7543ea0ea5436
Signed-off-by: Fernando Moreno <fernando@midokura.com>
2016-05-11 10:33:23 +02:00
Antoni Segura Puimedon
7aa20ff639
Add missing files to the install script
In order for Kuryr's libnetwork driver to function, it is essential
that /usr/libexec, the driver specfile and /etc/kuryr get installed.
Up until now, this was manual. This change fixes it.

Change-Id: Ifdb6048a154aa811a0369cbcdb848b19798bc51f
Signed-off-by: Antoni Segura Puimedon <toni@midokura.com>
2016-05-06 19:04:37 +02:00
Antoni Segura Puimedon
24eb1458dd
Shrink logo size
It displays too big on github, so maybe better we shrink it.

Change-Id: I31bc67eaf3780aafd4a7429e58671c90a93a9a0f
Closes-Bug: #1576766
Signed-off-by: Antoni Segura Puimedon <toni@midokura.com>
2016-04-29 10:49:32 -05:00
Jinrui Wang
cf536ef2cb Add notice to remind user to install tox
As tox has been removed from requirements.txt, we should remind user
to install tox.

Change-Id: Id7c5dd1c01ee70a2966eec2bdef5fff18b0c3bb2
2016-04-05 05:38:40 -04:00
Mike Spreitzer
5107602c0d Noted other requirements for generating documentation
Generating the documentation requires the pip packages oslosphinx,
reno, and reno[sphinx] and they are not in requirements.txt.

Change-Id: I52156fc314a10ae5adc44bb88917461ca417df66
2016-03-08 22:43:07 -05:00
Baohua Yang
641b9d1333 Update the Running Kuryr part doc
Change-Id: Ib7875fe2424829d271a01d4b605bad187fd89384
2016-02-29 06:39:32 +00:00
Jenkins
e53917d16f Merge "Fixed typo in README.rst" 2016-02-09 04:04:29 +00:00
Taku Fukushima
672906eef3 Add "sudo" to the instruction for running Kuryr
This patch adds "sudo" to "Running Kuryr" section of README.rst. Some
people get stuck with the errors of pyroute2 and that's because of the
lack of the privilege for manipulating the veth interfaces.

Related-Bug: #1516539

Change-Id: I44f44755a1aec4ec29d0afa4852e989eca28d381
Signed-off-by: Taku Fukushima <f.tac.mac@gmail.com>
2016-01-26 12:56:05 +09:00
Jan Hilberath
3b64abc953 Fixed typo in README.rst
"Sphinix" -> "Sphinx"

Change-Id: I2a3b9e508d8070a429aecb0e4f91160d68844950
Signed-off-by: Jan Hilberath <jan@midokura.com>
2016-01-24 12:49:12 +09:00
Baohua Yang
7a128a4b10 Add Makefile to generate the doc, and add steps into README
Change-Id: I8663dfd43fec0394c4a3b5bb87a4646102b69e2e
2016-01-06 23:57:13 -06:00
Gal Sagie
445c7adf9e Fix Kuryr icon size
Change-Id: Ife216eff91d88c7705b05cbb09e278a078f17a2e
2015-11-23 14:55:07 +02:00
Gal Sagie
147dc927b5 Add Kuryr logo to documents
Change-Id: Ieb958c92980bf3171187acf6625f01c989522cee
2015-11-22 15:33:49 +02:00
Kyle Mestery
99897cc1cc Cleanups to Vagrant documentation and scripts
Fix some spelling errors in the scripts and the Vagrant documentation.
Also, add a note about creating the default subnetpool in the Vagrant
documentation.

Change-Id: I13454328d7b4372d6773661b006466f3419c4fe0
Signed-off-by: Kyle Mestery <mestery@mestery.com>
2015-11-20 13:36:51 -06:00
Aaron Rosen
2ea22a3cf6 Wrap readme to 80 chars
Looking around and figured I'd clean this up.

Change-Id: Icfdd8912c51b4b5aa03115fea5351e5e44a0a11b
2015-09-11 20:28:35 -07:00
Taku Fukushima
4b4cf827e7 Add an instruction for tests
This patch adds an instruction for tests to README.rst.

Change-Id: If07f0d7a111c2080fc7cdb70eb61101e5742c13f
Signed-off-by: Taku Fukushima <f.tac.mac@gmail.com>
2015-07-28 15:50:09 +09:00
Taku Fukushima
8f734e65fd Update README.rst
This patch adds the instructions to install dependencies and run Kuryr
to README.rst.

Change-Id: Ie507c308c78ac4c09f54ddb43343710a808680d6
Signed-off-by: Taku Fukushima <f.tac.mac@gmail.com>
2015-07-27 10:33:15 -04:00
Gal Sagie
57d0787182 Add Kuryr description to README
Change-Id: I21252ea4364f802b71230b97916ebd0f351c8d9b
2015-07-26 19:12:07 +03:00