Commit Graph

82 Commits

Author SHA1 Message Date
niuke e659f67b99 remove unicode from code
Change-Id: I03ee94bad87fcf3d3f09849caaa652d2d912f503
2022-07-28 10:46:36 +08:00
Maysa Macedo 8f78668092 Add doc/requirements
Specify doc requirements needs to be moved out from
test-requirements.txt to in doc/requirements.txt
to avoid problems with the pip resolver as announced by
the release team [1].

[1] http://lists.openstack.org/pipermail/openstack-discuss/2021-January/019611.html

Change-Id: Iac9a3421c23370f19f57d6aa84c2862ccfce2a94
2021-01-05 23:03:40 -03:00
Andrew Bonney c34f977cfd docs: add CAP_NET_ADMIN to service AmbientCapabilities
This adds CAP_NET_ADMIN to the list of capabilities available
to the service. This is most relevant when the service runs as a
non-root user.

Related-Bug: #1852105
Change-Id: Ie50c092b723a4e5e8fc501370547711b06f77f1c
2020-12-03 14:12:18 +00:00
Andreas Jaeger e544677d39 Switch to newer openstackdocstheme and reno versions
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.

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: If74b848e1f63a0e116737553fec8ab76d63457f5
2020-05-30 18:41:53 +02:00
Zuul 4c445c2198 Merge "Fix pygments style" 2020-05-26 15:23:25 +00:00
gugug 7524152766 Fix pygments style
New theme of docs respects pygments_style.

more info: http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html


Change-Id: I26b15daf38616c29ac4b2cf0f68be6eb975577cb
2020-05-21 01:18:39 +00:00
gujin 910f2e72db Replace git.openstack.org URLs with opendev.org URLs
Thorough replacement of git.openstack.org URLs with their opendev.org counterparts.

Change-Id: Ia04c82127761ee818a37efe6cf9137987f8262f8
2020-05-17 04:38:56 +00:00
Hongbin Lu d9523c7afe Update docs and scripts for using python3
Python2 is deprecated so we need to switch to python3

Change-Id: Id9158df88f0b6ed0c071994bf0aa240063ac6761
2020-02-17 16:15:11 +00:00
Zuul 5264dee964 Merge "Update install guide for master branch" 2019-05-08 10:30:27 +00:00
Hongbin Lu c528e9be2f Replace port 35357 with port 5000
Starting from Keystone v3, the port 35357 is not used.
See: https://review.opendev.org/#/c/541857/

Change-Id: I4fee6ebcca6cbb1c610fa19c4294ef5a45b50709
2019-04-29 22:17:03 +00:00
Hongbin Lu 01b20b1af1 Update install guide for master branch
Change-Id: I7ec366c59eda13c0483e3cae185c263e40694bac
2019-04-27 16:13:51 +00:00
Hongbin Lu 01b9fd362b install-guide: download source from stable branch
In the stable/rocky version of installation guide, we should
instruct to git clone the stable/rocky branch instead of master
branch.

Change-Id: Ideaf2142e6311d967bae5a0ad2abe6b48e36b5d1
2018-08-22 02:29:07 +00:00
SijieYang 42b0c306a0 modify the kuryr workflow document
In the document, it shows that when user input commands like "sudo docker run --net=foo -itd --name=container1 busybox", '/IpamDriver.RequestAddress' will get a POST call which the 'options' is empty, just like this:
{
    "Address": "",
    "PoolID": "941f790073c3a2c70099ea527ee3a6205e037e84749f2c6e8a5287d9c62fd376",
    "Options": {},
}
but I have checked the workflow, and I found it's not true. The Options
will be non-empty, and it will be like "com.docker.network.endpoint.macaddress": "08:22:e0:a8:7d:db".
Fixes: Bug 1774977

Change-Id: Ia4632fb376471893de71b57b49ca0241cf0f60c2
2018-06-04 19:42:41 +08:00
Vu Cong Tuan 33cec28d8a Replace deprecated "auth_uri" by "www_authenticate_uri"
According to [1], "auth_uri" has been deprecated.
This patch replace it by using "www_authenticate_uri" instead.

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

Change-Id: I7bdfee1cf1e875ef702cc4761d723e420bc00ff9
2018-05-10 16:16:58 +07:00
melissaml 7f9720c7c9 Fix the incorrect reference links
TrivialFix
[1] is the installation guide for OpenStack components, obviously,
we need [1] in the docs.

[1] https://docs.openstack.org/latest/install/

Change-Id: I80ff6f0027c206f1c42ec41392337c5d267d4d87
2018-02-26 16:00:04 +08:00
Dongcan Ye 56a98cf6cb Docs: Add fullstack test guide
Change-Id: Ifb5acb563498a9228417bd56b471a5229d3fb83d
2018-02-11 06:51:54 +00:00
Hongbin Lu 3c3bb020c8 Introduce sriov port driver
* Introduce a new config 'enabled_port_drivers'. This config allows
  operators to specify multiple port drivers to enable. This enables
  Kuryr to dynamically choose from a list of port drivers (Veth or
  SRIOV).
* Introduce a new SRIOV port driver for performing SRIOV port binding
* Choose port driver according to the type of the port. If the neutron
  port has SRIOV vnic type, choose the SRIOV port driver. Otherwise,
  choose the normal port driver (i.e. veth).
* To use this feature, users are supposed to pre-create a SRIOV port
  and have the binding:profile populated. Furthermore, users should
  pass the SRIOV port to Kuryr (i.e. using --mac-address <port_mac>
  and/or --ip <port_ip> on 'docker run') so that Kuryr will choose
  the right driver.

Implements: blueprint sriov-support
Change-Id: I0d6552ce4a2c50edb164aff3de802e6239671c2c
2018-01-03 07:51:05 +00:00
Hongbin Lu d0cec045ca Add installation guide for kuryr-libnetwork
This patch proposes an installation guide that covers step-by-step
deployment of kuryr-libnetwork for new users of OpenStack with
sufficient Linux experience.

The instruction is to install kuryr-libnetwork from source since
there is no distro package for kuryr-libnetwork for now. This guide
covers installation in Ubunut as the first stpe. The support of
other OS is future work.

TODO: Configure the CI to publish this guide to:
https://docs.openstack.org/pike/install/

Change-Id: Id4f234068600564fa18e73aba08f6e43893456ee
2017-10-11 23:08:48 +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
Darla Ahlert 9ffede157b Move docs from kuryr to kuryr-libnetwork
This is one part of the process of organizing the Kuryr docs
across Kuryr, Kuryr-Libnetwork, and Kuryr-Kubernetes. This
commit in particular moves some libnetwork documentation from
Kuryr devref to Kuryr-Libnetwork devref.

Change-Id: If0e23ffe10f798d2f9f5b37e1b996bd069715721
2017-02-15 12:32:28 -06:00
Janonymous 088bddc9e1 Links do not point to any document
For now we could safely remove these options,
once we have complete documentation it could be added easily.

Change-Id: I15f19c1cee2e2a65190d1780b41bdf406634253e
Closes-bug: #1625015
2016-09-19 12:32:25 +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 16bfca4ce0 Rename spec directory to newton
Directory name for nested-vm and k8s integeration spec should be renamed
to newton.

Change-Id: Ieeda754bee171b83563432069ddc67d13ac6ba72
Closes-bug: #1595441
2016-06-23 14:15:53 +05:30
Jenkins c5f5ff2aea Merge "Fix .rst format in kuryr_k8s_integration.rst" 2016-06-23 07:03:02 +00:00
Jenkins b07bbbf31d Merge "Add the description of the Endpoints" 2016-06-20 15:12:00 +00:00
vikaschoudhary16 0db8c87a70 Fix .rst format in kuryr_k8s_integration.rst
Mainly links has been fixed.

Change-Id: Id07a5b324a818337e9fee2a949bc24e962bf319a
Closes-bug: #1591556
2016-06-16 16:08:00 +05:30
Jenkins 95925f3207 Merge "Eliminate unecessary ", or" in watcher design devref" 2016-06-15 14:43:51 +00:00
Jenkins 7848d89667 Merge "Fix the style of Raven devref" 2016-06-15 14:11:35 +00:00
Jenkins aa8232512b Merge "Fix typos in the watcher desing devref" 2016-06-15 14:01:57 +00:00
Jenkins 27a7ad686e Merge "Fix style issues in existing-neutron-network spec" 2016-06-15 06:07:58 +00:00
Taku Fukushima d36aad51f6
Fix typos in the watcher desing devref
This patch fixes typos in doc/source/devref/k8s_api_watcher_design.rst.

Change-Id: Ie1c670f84b0980f22e455a2ee2016513299448c5
Signed-off-by: Taku Fukushima <f.tac.mac@gmail.com>
2016-06-15 13:29:56 +09:00
vikaschoudhary16 73c7cde610 Fix style issues in existing-neutron-network spec
1. Heading levels are fixed
2. Wherever lines had scope to include more words and ensuring length
is < 79

Change-Id: I5a78f88fff43b7fb1a7ce04b81172f4105b983e1
2016-06-14 15:02:57 +05:30
Jenkins bf21ca6d03 Merge "Update index.rst for watcher devref" 2016-06-14 09:30:43 +00:00
Taku Fukushima c316f2f5d5
Add the description of the Endpoints
This patch adds the description of the Endpoints and how it is
translated. The example of each response in each state is added in
Appendix A as well.

Change-Id: Ibfeb11d9d0079bc2e943b3ff918b660d12adaa84
Signed-off-by: Taku Fukushima <f.tac.mac@gmail.com>
2016-06-13 15:37:37 +09:00
Jenkins 5e09448e60 Merge "Move the description of the pool member creation" 2016-06-13 06:17:57 +00:00
vikaschoudhary16 bc5429cbc6 Update index.rst for watcher devref
Change-Id: I6e0ce2c38831040f7705fce030c634f377be3f5a
Closes-bug: #1591529
2016-06-11 21:48:41 +05:30
Taku Fukushima bdcd788119
Move the description of the pool member creation
This patch moves the description of the pool member creation to the
section for the kube-proxy emulation using the LBaaS.

Change-Id: I7e93f31d02cbb518f3910008c1e8513f37dda302
Signed-off-by: Taku Fukushima <f.tac.mac@gmail.com>
2016-06-10 13:00:23 +09:00
Taku Fukushima 83fb434750
Eliminate unecessary ", or" in watcher design devref
This patch eliminates the unnecessary ", or" in the watcher design
documentation.

Change-Id: I87f6dda56c74be64338193e1843f6174a4440d23
Signed-off-by: Taku Fukushima <f.tac.mac@gmail.com>
2016-06-10 12:51:03 +09:00
Taku Fukushima a7cabac3c3
Fix the link to K8s integration doc
This patch fixes the broken link to the K8s integration documentation.

Change-Id: I36b55cc0f073848bda4e4fd9f23a68a391055b4b
Signed-off-by: Taku Fukushima <f.tac.mac@gmail.com>
2016-06-10 12:47:16 +09:00
Taku Fukushima 80d2ca8f11
Fix the style of Raven devref
This patch fixes the following broken style of Raven devref.

* The broken link for "Kubernetes API"
* The broken code-block for the ADDED event of the Pods

Change-Id: Iffa4c4c027aa64893704e7fca3ddaaa16b005653
Signed-off-by: Taku Fukushima <f.tac.mac@gmail.com>
Closes-Bug: #1583972
2016-05-20 17:41:57 +09:00
Jenkins 7fc0afd4aa Merge "Add devref of Raven" 2016-05-17 09:34:27 +00: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
Taku Fukushima 0b0af3d3e6
Add devref of Raven
This patch adds the devref of Raven, a K8s API watcher component. The
devref contains the abstract of Raven, the design of it, the useful
information for developers.

Change-Id: I8f0e801f81f101a51d62f4b4cc854176e67e75dc
Signed-off-by: Taku Fukushima <f.tac.mac@gmail.com>
Related: blueprint kuryr-k8s-integration
2016-04-21 17:55:54 +09:00
Jenkins 6b07c5d7d0 Merge "Fix wrong example in existing-neutron-network.rst" 2016-04-13 17:41:00 +00:00
Irena Berezovsky 53bde0ae4f Fix warning for docs generation
Change-Id: I5f535f3cc65e5bb6d8dcbaf3f7f5b2155a1a5654
2016-04-06 10:28:20 +03:00
Liping Mao 7b5cce42df Fix wrong example in existing-neutron-network.rst
Change-Id: I9861b457770515831d23cc1506f56834256d9e45
2016-04-05 23:29:52 +08:00
Jenkins 5d687a4d66 Merge "Fix typos in Kuryr files" 2016-04-05 06:10:28 +00:00
Liping Mao 923a8af435 Fix some link problem in existing-neutron-network.rst
Change-Id: I5a7a719cd4a33f1458af3c87c70bcb39ce0c022a
2016-03-31 23:20:21 +08:00
Nguyen Hung Phuong 7dba65042f Fix typos in Kuryr files
Change-Id: I0419567b5becf58bf3cc9ee69da7e708310c8f32
2016-03-31 09:15:48 +07:00