36 Commits

Author SHA1 Message Date
Mark Goddard
d8641e90c3 docs: Add placeholder page for CI & testing information
Change-Id: Iebcac0827c6f715c6b804223cdcf2cc2e425120b
2021-08-25 17:25:30 +01:00
Michał Nasiadka
278b63a0eb docs: Update Freenode to OFTC
Change-Id: Idaae03612dd7feabd2cdc57e510947328524e98b
2021-05-31 09:51:04 +02:00
Mark Goddard
106644e496 docs: add code reviews to contributor guide
(cherry picked from kolla commit abc4f7c124265f9e7b72d448b2ef18d6d4e84888)

Change-Id: I7e51a76287cd0f5a22d11dc3af9284b556d06eca
2021-02-24 11:32:43 +00:00
Pedro Henrique
f3fbe83708 Add support to OpenID Connect Authentication flow
This pull request adds support for the OpenID Connect authentication
flow in Keystone and enables both ID and access token authentication
flows. The ID token configuration is designed to allow users to
authenticate via Horizon using an identity federation; whereas the
Access token is used to allow users to authenticate in the OpenStack CLI
using a federated user.

Without this PR, if one wants to configure OpenStack to use identity
federation, he/she needs to do a lot of configurations in the keystone,
Horizon, and register quite a good number of different parameters using
the CLI such as mappings, identity providers, federated protocols, and
so on. Therefore, with this PR, we propose a method for operators to
introduce/present the IdP's metadata to Kolla-ansible, and based on the
presented metadata, Kolla-ansible takes care of all of the
configurations to prepare OpenStack to work in a federated environment.

Implements: blueprint add-openid-support
Co-Authored-By: Jason Anderson <jasonanderson@uchicago.edu>
Change-Id: I0203a3470d7f8f2a54d5e126d947f540d93b8210
2021-02-15 16:57:47 -03:00
Piotr Parczewski
5db72659a0 [docs] Unify project's naming convention
There are inconsitencies across the documentation and the source code files
when it comes to project's name (Kolla Ansible vs. Kolla-Ansible). This
commit aims at unifying it so that the naming becomes consistent everywhere.

Change-Id: I903b2e08f5458b1a1abc4af3abefe20b66c23a54
2021-01-27 20:08:41 +01:00
Radosław Piliszek
059c735874 [docs] Add templates and examples of renos
With tips and clarifications.

Change-Id: Ic744e13805c4a158d1156a230f8c57d7a980d55f
2021-01-13 10:19:19 +00:00
likui
a62cce67e6 Update docs for Ubuntu 20.04
* Use 'apt install' command instead of legacy 'apt-get'

Change-Id: Idae8d325bce354fa3b4c5be412965122af8f1413
2020-11-20 08:40:36 +00:00
zhoulinhui
9834b0a37f Add the missing doc/requirements into running-tests.rst
tox command install dependencies from the ``requirements.txt``,
``test-requirements.txt`` and ``doc/requirements.txt`` files

Change-Id: I21ee208d2484615ee3f9d9eca7602275382c920b
2020-09-18 13:22:06 +08:00
zhoulinhui
6c1399d078 Update py37 to py38 for running-tests.rst
It should been done in https://review.opendev.org/#/c/752436/ but missing

Change-Id: Iae22e8d8133afecd7e897f82ca58afd6ea33e1c0
2020-09-18 00:57:13 +08:00
Zuul
fb5a52b83d Merge "Add EL8 packages." 2020-06-04 09:11:05 +00:00
Luke Short
7d39ed9aa9 Add EL8 packages.
Python packages are now prefixed with 'python3' instead of 'python'.
'bridge-utils' is also no longer shipped.

Change-Id: I6e8765e53fd5c3a7f7169671d75e965c22213c61
Signed-off-by: Luke Short <ekultails@gmail.com>
2020-05-29 17:18:00 -04:00
Radosław Piliszek
cc4ece8b8a [Community goal] Update the contributor guide
Change-Id: Ia7b7ad90a546bcf7ad7998449efbaec42bffc1d5
Story: #2007236
Task: #39814
2020-05-20 17:55:57 +02:00
Michal Nasiadka
d8f31e0a5e CI: Add ansible-lint to tox
* Reworked tox pep8 into linters job, that runs:
  - pep8
  - bandit
  - bashate
  - doc8
  - yamllint
  - ansible-lint (validate-all-files.py + ansible-lint)

* Skip E701 - missing galaxy_info in meta and E602 see [1].
* Skip E301 and E503 - followup later in a separate change
* Added ansible-role-jobs to zuul.d/project.yaml which will run
  openstack-tox-linters job in check queue
* Fixed remaining style issue
* Made tox and docs reference the new env for linters
* Dropped pype environment (not supported)

[1]: https://github.com/ansible/ansible-lint/issues/457

Change-Id: I494b4b151804aac8173120e6c6e42bc2fdb00234
2020-05-17 17:02:38 +02:00
Radosław Piliszek
234272eb64 Cleanup py27 support
Removes and/or replaces all mentions of py27.

Cleans up obsolete requirements and their lower-constraints.

Separates test-requirements.

Makes lower-constraints pass outside of CI (MarkupSafe).

Adds FIXMEs about some hacky Mocks that may misbehave.

Change-Id: Ifc090bf3c1db17d8542ee591c91e8225a597bfe2
2020-04-26 12:16:44 +02:00
Radosław Piliszek
ee9a46c2fa Docs: add new rules regarding release notes usage
Adapted from Kolla's https://review.opendev.org/699129

Change-Id: Iebc280e8793f8145bf5ca7d24c875a050e6b0fab
2020-01-04 11:51:07 +01:00
chenxing
31526d4c26 doc: Start using openstackdoctheme's extlink extension
This ensures we have version-specific references to other projects [1].
Note that this doesn't mean the URLs are actually valid - we need to do
more work (linkcheck?) here, but it's an improvement nonetheless.

[1] https://docs.openstack.org/openstackdocstheme/latest/#external-link-helper

Change-Id: I118e4d211617c5df66ff04dc04e308a1d2fc67ad
2019-06-17 23:00:42 +08:00
Mark Goddard
68796d79fa Update contributor guide
... or "what I wish existed when I first became PTL"

Some general improvements to the contributor guide, plus new sections
for PTL duties and release management.

Change-Id: If2f3b7c18de2e6c8d9bac131a16c28c2eeb348f2
2019-06-06 08:59:22 +00:00
ZhongShengping
41f3a817ac Move to opendev
1.Use opendev.org instead of git.openstack.org.
2.Use review.opendev.org instead of review.openstack.org.

You can see the discussion below:
http://lists.openstack.org/pipermail/openstack-discuss/2019-March/003603.html

Change-Id: Ice4509204df788a1a44a06fb89fb44cfe6b54b94
2019-04-23 13:28:39 +08:00
Doug Szumski
205df6949c Add missing steps to Vagrant instructions
Add a couple of missing steps to complete a Vagrant deployment. In
the case of the multi-node deployment we could go one step further
and ensure that the supplied inventory matches the default set of
nodes created by Vagrant.

Change-Id: Iee878e26989e92e4de06c071704a6794011b6e58
2018-11-19 18:23:15 +00:00
chenxing
eaa9815ad2 Remove '.. end' comments
Following by https://review.openstack.org/#/c/605097/
These were used by now-dead tooling. We can remove them.

Change-Id: I0953751044f038a3fdd1acd49b3d2b053ac4bec8
2018-09-28 10:15:37 +08:00
Trinh Nguyen
ce2a50843d Update Ubuntu dependencies of VagrantUp in docs
In Ubuntu 16.04, Vagrant up process requires qemu-utils and qemu-kvm

Change-Id: Idb89f3ace6ada1df2db32579b3f1da289547efa8
2018-07-26 23:27:20 +09:00
confi-surya
dbf754655f Following the new PTI for document build
For compliance with the Project Testing Interface [1]
as described in [2]

[1]
https://governance.openstack.org/tc/reference/project-testing-interface.html
[2]
http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html

doc8 command is dropped from docs tox envs.
So this affect nothing and run in PEP8.

Related-Bug: #1765348

Depends-On: Icc7fe3a8f9716281de88825e9d5b2fd84de3d00a
Change-Id: Idf9a16111479ccc64004eac9508da575822a3df5
2018-05-21 10:51:59 +01:00
ZhijunWei
d069491148 Update the Bugs link for triage
This content has been moved to [0]

[0]: https://docs.openstack.org/project-team-guide/bugs.html

Change-Id: I1a0bfaa452ed4f29939075a5c80c2bfc056fb3e5
2018-04-30 05:26:25 +00:00
Zuul
f576381ba2 Merge "Trivial: Update pypi url to new url" 2018-04-23 08:59:36 +00:00
huang.zhiping
265046b862 Trivial: Update pypi url to new url
Pypi url changed from [1] to [2]

[1] https://pypi.python.org/pypi/<package>
[2] https://pypi.org/project/<package>

Change-Id: I91815d4e70a6ff8b7da50a528355094239226523
2018-04-23 15:16:08 +08:00
Borne Mace
e751a7cc07 Added support for kolla-cli development
Updated the vagrant dev environment to include support
for development and testing of the kolla-cli

Change-Id: I1d8f66cced7f0a9cc37e3b296c5ae10ab989f736
2018-04-19 14:44:01 -07:00
chenxing
e471549e77 Upgrade the rst convention of the Contributor Guide
We upgrade the rst convention by following Documentation Contributor
Guide[1].

[1] https://docs.openstack.org/doc-contrib-guide/

Change-Id: I065ceb2f4d455412efeb502e7073e2cb7bc96996
Partially-Implements: blueprint optimize-the-documentation-format
2018-02-08 11:44:21 +00:00
gaofei
3b828fc923 Fix broken link
Merge commit from[1][2]
[1]https://review.openstack.org/#/c/536657/
[2]https://review.openstack.org/#/c/536657/
Change-Id: I79bd4ca2457222abcc6a58cd3b44be21a11b5a87
2018-01-23 06:03:46 +00:00
Surya Prakash Singh
04fd12b945 Restructured the doc of kolla-ansible
Created the admin directory, remove some files from
user dir and placed into admin and contributor.

For more detail, see the doc migration spec.
http://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html

Change-Id: I84c565d7d14a4d90270a53e14ab93a10f7ffb9b7
Partially-Implements: blueprint ka-queens-doc-restructure
2017-10-05 03:23:23 +00:00
Zuul
a19ab77593 Merge "Update the description and links for vagrant" 2017-09-29 04:30:54 +00:00
Jenkins
30c9642d73 Merge "git package added for better automated dev environment" 2017-09-28 07:55:16 +00:00
Surya Prakash Singh
6abbe426b7 git package added for better automated dev environment
On personal experience when i reach to line no 116 with fresh
centos-7.1 it ask to install git package, same has been taken
care in next section for ubuntu-16.04

Change-Id: I688a6ee70d8211740f7d1149ccdfb17183e3a995
2017-09-28 03:02:18 +00:00
caoyuan
8b54520e8a Update the description and links for vagrant
Change-Id: Id6264fa8af55b9da5f8e0cad705287b0c115c7e7
2017-09-27 22:38:11 +08:00
Eduardo Gonzalez
197a264a3b Fix deploy-guide links
Deploy guides includes quickstart guide.
Includes respect relative paths, but when
quickstart includes vagrant doc, deploy-guide
tries to locate the doc in its doctree (deploy-guide/source).

This causes error 404 and deploy-guide post-gates to fail

Change-Id: I05e49bbcef564ad4f3d80f0649ccf191d9f8b59d
2017-09-25 13:56:30 +02:00
Andreas Jaeger
67cce63acd Fix quickstart links
Checking http://files.openstack.org/docs-404s/2017-09-08.txt the link
/kolla-ansible/latest/quickstart.html gives a 404 and is most wanted.

The link now is /kolla-ansible/latest/user/quickstart.html - let's
update in tree docs for this.

Fix other broken links as well - with using intra-links instead of
external links - this will make it easier to notice breakage when files
are moved.

Change-Id: I62655afd9f270fa83c07d86aa91346af6337ca32
2017-09-08 18:28:48 +02:00
chenxing
cbd67ebdb1 Rearrange existing documentation to fit the new standard layout
For more detail, see the doc migration spec.
http://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html

Co-Authored-By: Eduardo Gonzalez <dabarren@gmail.com>
Change-Id: I3a7c0ed204ee1e9060b5325f20622afe9a5e3040
2017-09-06 17:43:56 +02:00