Commit Graph

36 Commits

Author SHA1 Message Date
Taketani Ryo 5ec55ebe2b doc: Update the installtion guide for RHEL8/CentOS8 and RHEL9/CentOS9
The openstack Ussuri and Victoria versions no longer support the
RHEL7/CentOS7. Update the installtion guide for RHEL8/CentOS8 and RHEL9/CentOS9.

Change-Id: I6c9924c96c1f879b913b39f66878a8f9235ea18f
2023-07-31 04:36:14 +00:00
Han Guangyu 644deedda5 Remove the note of training-labs
Training-labs had been officially retired as no maintainer.
The information of training-labs has been deleting in the openstack
documentatioan. It is not appropriate to continue the presentation in
note form here.

[1] http://lists.openstack.org/pipermail/openstack-discuss/2021-October/025586.html
[2] e78d74f105

Change-Id: I0ac3d05389041ac58fe2347171541ffaaf151fdf
2022-04-22 15:15:21 +08:00
Vishakha Agarwal 6b37a0abbb Fix doc for package mod_wsgi on Centos8/RHEL8
In the keystone installation for rdo [1], installation of
package mod_wsgi is required. But in Centos8/RHEL8 the
package name is updated to python3-mod_wsgi [2].

This patch updates the keystone doc about the same.

[1]https://docs.openstack.org/keystone/queens/install/keystone-install-rdo.html#install-and-configure-components
[2]https://docs.openstack.org/trove/latest/install/apache-mod-wsgi.html

Change-Id: Ic7aac07ab52275cc3b47481d8278a404909fc39f
Closes-Bug: #1886036
2020-07-10 19:24:21 +05:30
Zuul 1eaeed6282 Merge "Specify keystone is OS user for fernet and credential setup" 2019-09-18 18:54:05 +00:00
chenxing 7fc7ef2a07 Specify keystone is OS user for fernet and credential setup
Change-Id: I40124c809d8b14a6c50edc0f758104ab09656250
Closes-Bug: #1838554
2019-09-17 13:59:07 -05:00
Andreas Jaeger f10f95b455 Docs: Make robust with using real links
Our tools noticed that keystone links to
https://docs.openstack.org/keystone/latest/admin/identity-domain-specific-config.html
which does not exist anymore.

The page was removed but the link to it was not changed. Replace this
and similar links with internal links that will work even if files are
moved - and can be verified, thus sphinx will error in case of broken
targets.

These changes include a few other fixes for broken keystone links, e.g.
to renamed anchors.

For the include files in admin/configuration.rst and
admin/federation/configure_federation.rst: Rename them to *inc.
The files were
published twice (as separate files and on this page) and thus
referencing failed. Renaming avoids this.

Also, put doctree outside of html tree so that it does not get
published.

Change-Id: I3d07637b0046cc88a66bcb51a0a4fe7c146c1549
2019-08-09 20:15:14 +02:00
Vishakha Agarwal e9ee189b43 Fix keystone document
Change-Id: Ic4a1ac1279acd229ca2d1f104bfff1a3c6f81dd2
Closes-Bug: #1811771
2019-07-09 14:21:33 +05:30
Zuul 4bbee7b417 Merge "Add clarification for context in install guides" 2019-06-08 07:00:28 +00:00
Gage Hugo bceab5871f Add clarification for context in install guides
This change adds a couple clarifying statements in the three distro
install guides for finalizing an installation:

- Adds a line stating that a user may need to create the ServerName
option in the apache config.

- Clarifies that the environmental variables are the default ones
created when a user runs "keystone-manage bootstrap"

Change-Id: If656433304337c56adcd3a898609b30890c9151b
Closes-Bug: #1817780
2019-05-20 13:34:03 -05:00
Frank Kloeker 0f2b36b2ad [docs] remove deprecated ubuntu package from installation
keystone package depends already on apache2 and wsgi package:

keystone
  Depends: adduser
 |Depends: apache2
  Depends: <httpd>
    tntnet
    aolserver4-core
    aolserver4-daemon
    apache2
    ebhttpd
    lighttpd
    micro-httpd
    mini-httpd
    nginx-core
    nginx-extras
    nginx-full
    nginx-light
    webfs
    yaws
  Depends: libapache2-mod-wsgi-py3
  Depends: python3-keystone
  Depends: ssl-cert
[...]

Change-Id: I1332df34dd6ee59537d35d93d5c35c2fe96561b2
Related-Bug: #1825111
2019-05-02 22:30:03 +02:00
chenxing fd5da18bf6 Fix the incorrect release name of project guide
backport: rocky

Change-Id: I592ca4962794dc34cb549c65f911c795cdf7f749
Closes-Bug: #1819299
2019-03-14 16:18:05 +08:00
Colleen Murphy 4e39e2abe5 Move SSL recommendation to installation guide
As part of the docs consolidation effort, move the SSL recommendation to
the installation guides for each distro. This also corrects the wording:
"running in a web server" is not necessarily secure on its own, the web
server must be configured to use SSL.

Change-Id: If0b547680cbbea4c7f29d82de3f4fe96bd14b4ec
2018-12-10 15:55:13 +01:00
zhang.lei e765a98dd8 Add the missing packages when install keystone
Change-Id: I14fa7786e7f677684e0a0d5029e1d9610f1b35f9
backport: rocky
Closes-Bug: #1803438
2018-11-16 10:24:11 +00:00
chenxing 0df5bb0d0c Update RDO install guide for v3
This is a supplement for https://review.openstack.org/556023

Change-Id: I20f698a0d820f4e99cea110f157f6ba53423bce5
Closes-Bug: #1790148
2018-09-03 16:59:13 +08:00
Tovin Seven 1a5877f2ad 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: I3a389a2e03c09363494bd6a919804152391a17b8
2018-04-20 16:55:41 +07:00
Lance Bragstad 38d25b7b5f Update the RDO installation guide to use port 5000
This makes the RDO guide consistent with the Ubuntu and SLES guides.

Change-Id: Ic935e5335378246b3363f7fd96e958388aa98b50
2018-04-19 19:58:34 +00:00
Zuul e473cab853 Merge "Add prerequisite package note to Keystone install guide" 2018-04-18 17:18:25 +00:00
Russell Tweed f01edae95c Add prerequisite package note to Keystone install guide
Added prerequisite package note and associated link to the main Install Guide
to the Keystone install guide. This is to ensure commands further down the
Keystone guide don't fail unexpectedly.

Change-Id: I189854fbc7f1e05945ab0002c08ee84f7bfad196
Closes-Bug: 1754413
Closes-Bug: 1754417
2018-04-18 14:38:16 +01:00
jessegler a5edf02521 Corrects spelling of MacOS
Change-Id: I396b919b01f93cd459bd10d937991fa37c53b479
Closes-Bug: 1762633
2018-04-12 10:38:46 -05:00
Zuul dc3de34027 Merge "Update install guides" 2018-04-04 18:34:25 +00:00
Harry Rybacki 4d313b72dd Update install guides
- Ensure myproject and myuser are used throughout the guide
consistently
- Add note that connection's host in keystone.conf must be resolveable

Change-Id: Icaaf6c1b7583ed75b7a6204d7fb1f3506e4e8937
2018-04-04 11:43:32 -04:00
Gage Hugo 69f0e553e0 Fix mispelling of accommodate in install docs
This change fixes the 3 occurrences of "accommodate" being misspelled
in the keystone install documentation.

Change-Id: I2eb50fd1aedb8e7cb7530d640aaa8f183134945c
2018-04-04 10:15:13 -05:00
Colleen Murphy 27762c8220 Update RDO install guide for v3
Bring the RDO install guide into alignment with the Ubuntu and SUSE
guides by removing references to the admin port 35357 that was used for
the keystone v2 API.

Change-Id: Ic2c5452dae0c142ce3311f6b5e6d9590d618fc22
2018-03-24 13:01:17 +01:00
Colleen Murphy 1b01ebce56 Add note to keystone-manage bootstrap doc
A lot of people are very surprised that we no longer reference port
35357 in our Ubuntu (and SUSE) install guides. Add a note to clarify
that this is not a bug and we do really mean it.

This does not change the RDO install guide because our guide still
instructs users to use port 35357 because the RDO package still includes
an Apache vhost file that uses 35357.

Change-Id: I334ba888190705a345d50cebe577b832753f202c
Related-bug: #1755026
Related-bug: #1755511
Related-bug: #1756178
2018-03-16 15:21:40 +01:00
Russell Tweed c625aefbd7 Use different labels for user and project names
Modify the Install Guide to use different labels for user, role, and project
names.

Change-Id: I14303ae708e47a8782d4ccc2a8c2ee076bc071b8
Closes-Bug: 1746302
2018-03-08 17:22:44 +00:00
Colleen Murphy 4c99563b14 Update OBS install docs for v2 removal
With the removal of the v2 API, there is no reason to keep listening on
multiple ports. Update the OBS install guide to only mention the one
port. The openSUSE openstack-keystone package does not provide a default
vhost config file so we can update this independently of any package
changes in the distro. This also removes a few incorrect notes, one
claiming that the distro package installed and started the nonexistent
eventlet service and one claiming that port 5000 only allowed non-admin
access.

Change-Id: Ic06af94335598e0aadac20874d177e531069548a
2018-02-08 15:46:41 +01:00
Lance Bragstad 6e5c7e821f Replace port 35357 with 5000 for ubuntu guide
Now that the v2.0 API has been removed, we don't have a reason to
include deployment instructions for two separate applications on
different ports. This change updates the guide to be consistent with
recent changes to the ubuntu packages:

  https://git.launchpad.net/~ubuntu-server-dev/ubuntu/+source/keystone/commit/?id=915d787af42096b0fad715e49759cd357e47787e

Change-Id: I4f7f70fa561c77a80b1c88e42a685844ab981afc
2018-02-07 20:05:31 +00:00
Hongbin Lu ad1b677c91 Update the release name in install tutorial
It looks the document will land on latest release page
(https://docs.openstack.org/keystone/latest), but it declares
for documenting the OpenStack Ocata release, which seems outdated.

Change-Id: I88ecd028eb31b9eaf68ddf743e949de8302736ac
2017-10-09 15:54:13 +00:00
Lance Bragstad 5194a36961 Remove admin_token_auth steps from install guide
The installation guide previously listed this as a step but
it is no longer needed since `admin_token_auth` is no longer in the
paste file by default

Change-Id: If36bafbecd657c3acd769f11636a1d844be0ac66
Closes-Bug: 1716797
2017-10-03 21:37:43 +00:00
Gage Hugo 04515333f4 Copy specific distro pages for install guide
This change breaks the get-started-identity, keystone-users,
and keystone-openrc pages into multiple copies for each distribution
release in the keystone install guides. Before this change, sphinx
would not render the links correctly and these pages would be skipped
in both the RDO and Ubuntu guides.

To avoid unneccessary duplication of the same text, the files were
moved into common/ and are simply included into the newly created
files for each release.

Change-Id: I7b478504f1e68034ea993c0214705045da86bb6e
Closes-Bug: #1712335
2017-08-29 16:27:52 -05:00
zhiguo.li df03cb25d3 Add the step to create a domain
Two reasons for adding this step:
1. The title of this chapter named “Create a domain, projects, users,
   and roles”,but there is no step to introduce how to create a
   domain.
2. Explain to users where the domain 'default' comes from because the
   default domain is used in later steps.

Change-Id: I5b627ce15f94f18fd538866a32b84e540090bfff
Closes-Bug: 1707130
2017-08-16 12:21:26 +00:00
Samriddhi Jain 82785553dd Updated URLs in docs
With the docs migration and re-arrangement, some docs
have been shifted to new places, however the referenced
links are still old. Some of them give 404 error or
just point to the home page. This patch fixes those URLs.

Change-Id: Ie6b18ab3d4aa346dac8436dd426277fee4f07fcd
2017-08-09 23:46:33 +05:30
zhiguo.li b9c0252a4c Add the step to install apache2 libapache2-mod-wsgi
The guide uses the Apache HTTP server with mod_wsgi to serve
identity service, but it did not introduce the step to install
Apache2 and libapache2-mod-wsgi package in this guide. The identity
service will not be started without these two packages.
This patch modify the step 1 in part "Install and configure components"
for installing two packages metioned above.

Change-Id: I8ca55e605f806bdc48f753ab893040d9a76aa93d
Closes-Bug: 1707176
2017-07-28 19:28:58 +08:00
wingwj 0a90e39cad [install] Clarify the paths of the rc files
Add explicit statement about the rc files' paths
in the installation guide.

Change-Id: Ib652a231ce0c1760630119aa34aa30106d26a20d
Closes-Bug: #1696264
2017-07-12 13:55:59 +08:00
Samriddhi Jain bcae07ebdc Removed unnecessary line breaks from install-guides
Installation guides imported from openstack-manuals have some extra
line breaks. Improved the guides by removing those extra breaks.

Change-Id: Ie0b3489f19188588622a342dd8163d46b557eb23
2017-06-26 22:28:52 +05:30
Samriddhi Jain c69c283bf8 Added keystone installation guides
Currently some keystone installation guide docs are part of
general OpenStack-manuals. Migrating those docs to keystone
documentation so that they can be reviewed effectively by
keystone developers too.

Added installation guides for Ubuntu, openSUSE and
Red Hat Enterprise. The installation guides for Debian will
be added once they are complete in openstack-manuals.

Also changed the toctree structure in install-guides to
include directives so that all sections appear on one page
rather than just links.

Partial-Bug #1694460

Change-Id: I03aecfd1544b559a8fbd1ab11c5474145cff9ff9
2017-06-26 20:58:32 +05:30