Commit Graph

29 Commits

Author SHA1 Message Date
Roman Dobosz 80b5ecd41b Change inline hyperlinks to link-target pairs.
Inline, named hyperlinks seems to be fine, but often they just provides
noise to the paragrafs. In this patch we propose to use link-target
style for hyperlinks, where named link(s) is (are) placed in paragraph
while its target is at the bottom of the document.

Change-Id: Ia4f4c66f51ea193dc201b3dba5be2788f20765e0
2019-11-13 12:50:05 +01:00
Roman Dobosz feff260509 Fix directives formatting.
According to restructuredtext guidelines, directives should have
following formatting:

.. directive_name:: param
   :option:

   body

So it starts with the leading two dots and the space. Next directive
name follows with two colons, and finally optional parameter. Than, line
below it is either some options delimited with colons, or an empty line.
After which body of the directive follows. It should be positioned just
at the same column as directive name, so exactly 3 spaces. Most of the
directives are formatted wrong, including:

- note
- image
- todo
- toctree
- warning
- figure

This patch fixes that.

Change-Id: Ic970f72aeb93bcda82f02e57b70370ab79d6855d
2019-11-13 11:59:37 +01:00
Roman Dobosz c3c270c752 Fix text blocks formatting
There are the cases, where text blocks in restructuredtext files are
exceeding text 79 column, or are formatted in weeird way. In this patch
it is fixed. Also couple of typos were tided up.

Change-Id: I78c20cbb45c74e817d60582439acc7b01b577a83
2019-11-13 11:39:10 +01:00
Roman Dobosz e32d796ac7 Fix inconsistency in headlines format.
There are several restructuredtext files, which don't follow guide for
document contribution. Also made a rule for having additional line
between section body and folowing section headline.

Change-Id: I2dfe9aea36299e3986acb16b1805a4dc0cd952d2
2019-11-13 11:39:10 +01:00
Michał Dulko 6b58a1b58e Replace git.openstack.org with opendev.org in URLs
Change-Id: I1909cf75595fd9da7dfb1481478756711e9bb06c
2019-06-26 17:57:01 +02:00
melissaml a37d999f50 Update links in README
Change the outdated links to the latest links in README

Change-Id: Ib597177adf4868d6bf06c353b5ff2b0c4d930834
2018-08-19 03:47:48 +08:00
sunqingliang6 8f859f1a85 add a link to release notes in README file
Change-Id: I12586d588c0429585f17614dbe37c627c55d106b
2018-06-20 21:20:53 +08:00
liangcui bf76034162 Update URLs in documents according to document migration
Change-Id: I732a025ffc009343cd1161816eccfdc805998f84
2017-07-21 14:47:10 +08:00
Jenkins 8317fa2a64 Merge "Update installation documentation" 2017-06-16 18:42:53 +00:00
Kirill Zaitsev f50e2140f9 Update installation documentation
This commit moves installation/configuration documentation from README
file to installation section of the actual docs (which has been rather
short thus far). This commit splits a single README into multiple
installation sub-docs. It also expands the manual on installation and
configuration of kuryr-k8s-controller and kuryr-cni.

Change-Id: I88862f28d0bbbd8bf5259209c4fa3c41130479d1
2017-06-13 12:51:39 +03:00
chenlx 6ecc908129 Use https links for documentation
Use https instead of http to ensure the safety.

Change-Id: I42c5cc28828eceae10bb814036ae697e33803a4d
2017-06-12 23:05:25 +08:00
Gary Loughnane 04b17e4a06 Add MACVLAN based interfaces for nested containers
Currently nested containers can only be run by using trunk support and
vlan based interfaces. This patch introduces the additional option of
MACVLAN slave interfaces for pods running in VMs.

This patch includes both a new VIF driver on the controller side and the
binding driver for the CNI plugin.

Implements: blueprint macvlan-pod-in-vm
Depends-On: Ib71204d2d14d3d4f15beada701094e37d89d7801
Co-Authored-By: Marco Chiappero <marco.chiappero@intel.com>
Change-Id: I03c536bb0057bba0a5eb4d1c135baa8ab625e400
2017-06-12 13:14:12 +01:00
Jenkins a6da8f1215 Merge "get nested drivers opts out of neutron defaults" 2017-05-25 17:05:09 +00:00
Jenkins c8a8ead217 Merge "Improve nested k8s devstack install mechanism" 2017-05-25 12:36:53 +00:00
Irena Berezovsky 602acfe58e
get nested drivers opts out of neutron defaults
Partially Implements: blueprint driver-handler-opt-loading
Change-Id: Ie4b8d672e0ee1de06a057869236a234c64e0fdd5
2017-05-24 16:49:32 +02:00
Kirill Zaitsev 37e8b65083 Improve nested k8s devstack install mechanism
Current documentation suggest that to test nested use-case in devstack
one should comment out `configure_neutron_defaults` function for the
nested devstack. It also references an outdated line in the plugin.sh
file.
This commit introduces KURYR_CONFIGURE_NEUTRON_DEFAULTS setting (True by
default). If set to False `configure_neutron_defaults` would be skipped.
Also updates documentation and pod-in-vm.overcloud sample file.

Change-Id: I02dad9abe842b5c1c20bb7d3eaa0584320f9553a
2017-05-24 12:37:32 +00:00
Antoni Segura Puimedon 35006be8a5
nested_doc: Fix lack of mention of service_subnet
Now that services are merged, it is necessary to have it documented in
the nested guide, otherwise it can lead to configuration mistakes.

Closes-Bug: #1677155
Change-Id: I0fb32bfa7fbe12ae468a745b60fcdad3d56999f6
Signed-off-by: Antoni Segura Puimedon <antonisp@celebdor.com>
2017-05-20 00:12:36 +02:00
Daniel Mellado 32ac9307aa Remove extra colons in documentation
This commit removes some trivial extra colons in the documentation in
order to make it consistent.

Change-Id: If4a39ad116c0dc9ba8340acba804de02190fdf40
2017-05-05 15:21:33 +00:00
Antoni Segura Puimedon 7faabe1d6a doc: Add reminder to have https in api_root
api_root defaults to http://localhost:8080. In the section about https
configuration we give directions to set the client side ssl certificate
and key, but do not mention api_root, which could lead forgetful people
to mistakes if they don't have the url properly set with https and the
corresponding encrypted port.

Change-Id: I261984ebaf7a91875030b68234594ccffc482c3e
Related-Bug: #1670346
2017-03-26 08:56:26 +03:00
Jenkins 0ce8251cce Merge "Add support for HTTPS client" 2017-03-15 09:14:24 +00:00
vikaschoudhary16 cd70ae3527 Add support for HTTPS client
Add support to use cert and key files for watching a HTTPS
enabled K8S api server.

Change-Id: I0978531caa2c35031041450f86db9e90ce5efbb0
Closes-bug: #1670346
2017-03-15 13:43:16 +05:30
Ilya Chukhnakov bff9229ab8 Add project description to README.rst
Change-Id: Ib45cb8d99014f018cb2e8f24b229e22b5c5ba551
2017-03-14 22:14:45 +03:00
Irena Berezovsky 0714bf03de Add Kuryr development policy link to README file.
Change-Id: I1dcfefebccc389aa5effb2c30d7c34fe7cea6d8a
2017-03-09 14:16:26 +02:00
vikaschoudhary16 d054b69663
Update ReadMe for nested-pods setup resource requirements
Update minimum resources required for the vm, to try out instructions
mentioned in ReadMe for trying out nested pods.

Change-Id: Id4370a4dd4e0cecf4a3c6fab98f483c92cd48822
2017-01-24 20:06:53 +01:00
vikaschoudhary16 1422c6dde6 Few fixes in steps for running pods-in-vm
Binding section parameters are missing in steps. Also localrc
files are being improved by including MULTI_HOST variable.

Change-Id: I857cab7e6d5d526811cbccfd7ecf77f3f720bcc0
Partially-Implements: blueprint binding-drivers-porting
2017-01-19 17:43:04 +05:30
vikaschoudhary16 dc65eb1cbd Add support for nested pods with Vlan trunk port
Enable support for pods running in Nova vms.

I will be pushing a patch with devstack plugin changes.

Reference: https://review.openstack.org/#/c/411116/1/doc/source/devref/howto_binding_drivers.rst
Change-Id: Ib2aed7a0d1fa705f17a62d0fa4e272f19212e39e
Partially-Implements: blueprint binding-drivers-porting
2017-01-18 16:57:32 +05:30
Flavio Percoco 55711ba06e 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/6639236bd4249148f2c205bee6c1dba6\n'

Change-Id: I718694a562545944bc4fd25558e4ba6b64815c5a
2016-11-25 13:59:24 +01:00
Antoni Segura Puimedon ca64e1d5f1 move config and opt generation to new kuryr-lib
The config generation was from back when we did not have keystone v3
support, which moved around how it all is generated. This patch puts
kuryr-kubernetes in line with the rest of Kuryr.

Change-Id: I877fa57308aa4c2128bb5d12e801e7e566aef108
Closes-bug: #1626014
Signed-off-by: Antoni Segura Puimedon <antonisp@celebdor.com>
2016-09-26 13:11:47 +00:00
Gal Sagie 04a95048a4 cookiecutter commit for kuryr-kubernetes
Change-Id: Ie6bb10929397918420481a1063cc1187c0951981
2016-05-22 08:54:07 +03:00